Unified Huly Import Format Examples

dev/import-tool/README.md

@@ -0,0 +1,28 @@
+### Unified Huly Import Format
+
+Please check out the example under [example](./example/) folder.
+
+1. First level folders represents spaces in Huly. Space details are located in README.md inside the folder. Folders without README.md will be ignored.
+2. Huly document will be created for every MD file inside the space folder.
+3. Name of the MD file will be taken as an identifer for the created document.
+4. Subdocuments are located in the corresponding folder with postfix *"-subdocs"*.  
+(For example: *HULY-1* has subissues: *HULY-2, HULY-3, HULY-4, HULY-5*)
+5. Each MD file contains a header with document details in YAML format and the document content in markdown format. The content should be separated from the header with one divider line.
+
+#### Header Format:
+1. Attribute **class** is required. Allowed values:
+    * *document.class.Document* - for Wiki Documents
+    * *tracker.class.Issue* - for Issues
+2. Issue **status** should match with coresponding task type, defined in root README.md.  
+Allowed **status** values for issues of Classic Project (default predefined project type in Huly):
+    * *Backlog*
+    * *Todo*
+    * *In Progress*
+    * *Done*
+    * *Canceled*
+3. Allowed issue **priority** values:
+    * *Low*
+    * *Medium*
+    * *High*
+    * *Urgent*
+

dev/import-tool/example/Marketing Docs/Hello Word.md

@@ -0,0 +1,4 @@
+---
+class: document.class.Document
+---
+Hello, world!

dev/import-tool/example/Marketing Docs/Hello World-subdocs/Introduction.md

@@ -0,0 +1,38 @@
+---
+class: document.class.Document
+---
+
+# Introduction
+
+Penguins are fascinating flightless birds that have captured the hearts of many. Here are some interesting facts about these adorable creatures!
+
+### Did you know?
+
+- Emperor penguins can dive up to 1,800 feet deep in the ocean.
+- The smallest penguin species is the Little Blue Penguin, standing at just 16 inches tall.
+- Penguins have a special gland that filters salt out of the seawater they drink.
+
+### Penguin Habitats
+
+Contrary to popular belief, not all penguins live in icy environments. Some species live in temperate and even tropical climates!
+
+<aside>
+Fun Fact: The Galapagos Penguin is the only penguin species that ventures north of the equator in the wild.
+
+</aside>
+
+### Conservation Status
+
+Many penguin species face threats due to climate change and human activities. It's important to support conservation efforts to protect these unique birds.
+
+- [ ]  Learn more about penguin conservation efforts
+- [ ]  Consider donating to a penguin protection organization
+
+### Penguin Communication
+
+Penguins are quite vocal and use a variety of calls to communicate. They can recognize their mate's and chicks' voices among hundreds or thousands of birds.
+
+> Penguins don't just waddle on land and swim in water; they have a unique way of getting around on ice - they toboggan!
+>
+
+Here is another interesting document: [Random Page: The Wonders of Deep Sea Creatures](./Random%20Page:%20The%20Wonders%20of%20Deep%20Sea%20Creatures.md)

dev/import-tool/example/Marketing Docs/Hello World-subdocs/Random Page: The Wonders of Deep Sea Creatures.md

@@ -0,0 +1,54 @@
+---
+class: document.class.Document
+---
+
+# Random Page: The Wonders of Deep Sea Creatures
+
+# Random Page: The Wonders of Deep Sea Creatures
+
+Welcome to an exploration of the fascinating world beneath the waves! In this page, we'll dive into the mysterious realm of deep sea creatures and discover some of the most extraordinary life forms on our planet.
+
+## 1. The Anglerfish
+
+Known for its bioluminescent lure, the anglerfish is a master of deception in the dark depths.
+
+- Females can grow up to 3.3 feet (1 meter) long
+- Males are much smaller and fuse to the female's body
+
+## 2. Giant Isopod
+
+These enormous crustaceans are the cockroaches of the deep, scavenging the ocean floor.
+
+- Can grow up to 16 inches (40 cm) in length
+- Have remained virtually unchanged for 160 million years
+
+## 3. Vampire Squid
+
+Despite its name, this cephalopod is gentle and prefers to eat marine snow.
+
+- Can turn itself inside out to avoid predators
+- Has light-producing organs called photophores
+
+<aside>
+Did you know? The deep sea begins at about 200 meters below the ocean surface and extends to the deepest known points, like the Challenger Deep in the Mariana Trench.
+
+</aside>
+
+## Adaptations to Deep Sea Life
+
+These creatures have evolved unique features to survive in the extreme conditions of the deep sea:
+
+1. Bioluminescence for communication and hunting
+2. Large eyes to capture any available light
+3. Pressure-resistant bodies
+4. Slow metabolisms to conserve energy
+
+## Conservation Concerns
+
+Even though these creatures live far from human habitation, they face threats from:
+
+- Deep-sea trawling
+- Ocean pollution, especially microplastics
+- Climate change affecting ocean currents and temperatures
+
+As we continue to explore the deep sea, who knows what other incredible creatures we might discover? The ocean depths remain one of the last great frontiers on Earth, full of wonder and mystery.

dev/import-tool/example/Marketing Docs/README.md

@@ -0,0 +1,5 @@
+---
+class: document.class.TeamSpace
+members: [Andrey Platov]
+---
+This is my first teamspace in Huly! 🎉

dev/import-tool/example/My Project/HULY-1-subdocs/HULY-2.md

@@ -0,0 +1,48 @@
+---
+class: tracker.class.Issue
+title: Create your first project 📌
+assignee: Joe Shmoe
+status: Todo
+priority: Medium
+estimation: 1
+remainingTime: 1
+component: Core
+milestone: Iteration 198
+comments:
+  - author: John Doe
+    createdOn: 2022-02-05t10:30:00.10-05:00Z
+    text: |
+      Hello, world!
+  - author: Joe Shmoe
+    createdOn: 2022-02-05t10:35:00.10-05:00Z
+    text: |
+      Hello, **world!**
+---
+**Projects** contain all the tasks your team will be working on, and they can be organized however you’d like. 
+
+For example, a software engineering team may choose to create projects called “Frontend”, “Backend”, “UX/UI” and “Testing”. A small business may choose to create projects like “Inventory”, “Marketing,” and “Design”. 
+
+---
+
+### Task 2 - Create your first project
+
+Let’s create your first project in Huly!
+
+Make sure the Tracker sidebar is open on the left side - if you don’t see it, click the two horizontal lines  `=` to reveal it.
+
+There are two ways to create a project:
+
+* Hover over **YOUR PROJECTS** and click the `+` icon that appears, *or*
+* Click the dropdown menu next to the `+ New issue` button and select `Create project`. 
+
+A **title** and **default assignee** are required. You can also add a **description**, choose a custom **identifier** and select an **icon** for your project. 
+
+Next, click `Create`!
+
+<img src="../files/onboarding-create-project.gif" width="1440"/>
+
+---
+
+🎉 Congratulations! You’ve completed Task 2 ✅ 
+
+### Next: Task 3 - Create your first issue ➡️  [HULY-3](HULY-3.md)

dev/import-tool/example/My Project/HULY-1-subdocs/HULY-3.md

@@ -0,0 +1,48 @@
+---
+class: tracker.class.Issue
+title: Create your first issue 📝
+assignee: John Doe
+status: Todo
+priority: Medium
+estimation: 6
+remainingTime: 6
+component: Core
+milestone: Iteration 198
+comments:
+  - author: John Doe
+    createdOn: 2022-02-05t10:30:00.10-05:00Z
+    text: |
+      Hello, world!
+  - author: Joe Shmoe
+    createdOn: 2022-02-05t10:35:00.10-05:00Z
+    text: |
+      Hello, **world!**
+---
+An **issue** represents a specific task that needs to be completed. Projects can be broken down into issues and sub-issues.
+
+### Task 3 - Create your first issue
+
+Let’s create your first issue in Huly!
+
+Click the blue `+ New Issue` button at the stop of the side panel (or simply press `C` from any view!). This will open a dialog where you can enter some initial settings for your issue.
+
+> **Tip:** By default, the issue will be associated with the project you’re currently viewing. You can change this to the project you just created by selecting it from the dropdown in the top left corner.
+
+Next, enter some information about your issue:
+
+* Provide a **title** and **description**.
+* Choose some settings, such as **priority**, **labels**, **estimation** and **due date**.
+* The **assignee** will be the default assignee you selected for your project.
+* ❗ Ensure that the **status** is set to “Todo” — *this is important for the next step!*
+
+When you’re ready, click `Create issue`!
+
+<img src="../files/onboarding-create-issue.gif" width="640" height="400"/>
+
+---
+
+🎉 Congratulations! You’ve completed Task 3 ✅
+
+In the next step, you’ll learn how Huly has *automatically* created an Action Item for this issue, which you’ll schedule in your personal Planner. Click the button below to continue!
+
+### Next: Task 4 - Schedule your first Action Item ➡️  [HULY-4](HULY-4.md)

dev/import-tool/example/My Project/HULY-1-subdocs/HULY-4.md

@@ -0,0 +1,59 @@
+---
+class: tracker.class.Issue
+title: Schedule your first Action Item 📆
+assignee: John Doe
+status: Todo
+priority: Medium
+estimation: 6
+remainingTime: 6
+component: Core
+milestone: Iteration 198
+comments:
+  - author: John Doe
+    createdOn: 2022-02-05t10:30:00.10-05:00Z
+    text: |
+      Hello, world!
+  - author: Joe Shmoe
+    createdOn: 2022-02-05t10:35:00.10-05:00Z
+    text: |
+      Hello, **world!**
+---
+An **Action Item** is a task to be completed by a specific team member. 
+
+> *But wait … didn’t we just create an **issue** assigned to a team member?* What’s the difference? 
+
+At a glance:
+
+* **Issue** - work that needs to be completed 
+* **Action Item** - an individual’s responsibility to complete that work
+
+When an issue is created with the status of “Todo” and assigned to a team member, that team member receives a corresponding Action Item in their personal Planner.
+
+Let’s see how the issue status is *automatically updated* based on an individual team member’s progress towards their Action Item. Let’s go!
+
+---
+
+### Task 4 - Schedule your first Action Item
+
+Remember that issue you just created in the previous step? Because you set the issue status to “Todo” and assigned it to yourself, you’ve received a corresponding Action Item for that issue.
+
+Head over to your Planner by clicking the calendar icon in the left sidebar. Here, you’ll see an Action Item for the issue you just created!
+
+There are 2 ways to schedule an Action Item:
+
+* Click and drag the Action Item to your calendar on the right, *or*
+* Click on the Action Item ****to open it in the right side panel. Click `Add Slot` to create a time slot representing when you plan to do the work. From there, you can adjust the day and time and add more slots if needed.
+
+Notice that when you schedule an Action Item, it moves from “Unplanned” to “Scheduled” on your list.
+
+Now, navigate back to the Tracker by clicking the checkbox icon in the left side panel. Notice that the status of your issue *automatically updated* to “In Progress”! That’s because you scheduled your Action Item, indicating your commitment to completing the work.
+
+<img src="../files/onboarding-create-todo.gif" width="640" height="400"/>
+
+If you’d like, go ahead back to your Planner and check off your Action Item by clicking the round checkbox that appears when you hover over it. You’ll see that the issue status automatically updates to “Done”.
+
+---
+
+🎉 Congratulations! You’ve completed Task 4 ✅  
+
+### Next: Task 5 - Explore all Huly has to offer ➡️ [HULY-5](HULY-5.md)

dev/import-tool/example/My Project/HULY-1-subdocs/HULY-5.md

@@ -0,0 +1,45 @@
+---
+class: tracker.class.Issue
+title: Explore all Huly has to offer 🚀
+assignee: John Doe
+status: Todo
+priority: Medium
+estimation: 6
+remainingTime: 6
+component: Core
+milestone: Iteration 198
+comments:
+  - author: John Doe
+    createdOn: 2022-02-05t10:30:00.10-05:00Z
+    text: |
+      Hello, world!
+  - author: Joe Shmoe
+    createdOn: 2022-02-05t10:35:00.10-05:00Z
+    text: |
+      Hello, **world!**
+---
+Now that you know how to create projects, issues and Action Items, you can get started setting up your workspace. However, there’s so much more to the Huly platform than just task tracking! Dive deeper into the world of Huly, where harnessing the power of collaborative project management is just the beginning. Discover the ease and efficiency of managing your projects with us!
+
+### Additional Features
+
+* ➡️ Navigate Huly using these 3 intuitive methods: 
+  * **Command line** (`Cmd`/`Ctrl` + `K`) - Quickly search for items or execute commands.
+  * **Keyboard shortcuts** - Access a comprehensive list by clicking `Help & Support` in the lower left corner of the application.
+  * **Mouse navigation** - Right-click on issues to open contextual menus and access commonly-used actions.
+* 👀 **Issue Peek:** Hover over issues in your Tracker and press the space bar to see a preview of the **issue’s** details. To scroll through issue previews, press `J`/`K` or move the mouse.
+* **↔️ Integrate with GitHub, Google Calendar, Gmail and more!** 
+
+---
+
+### Need some more support?
+
+* [**Huly Docs**](https://docs.huly.io/) - Our resource for step-by-step tutorials! Learn how to customize the Huly platform to your team’s needs through detailed instructions.
+* [**Slack**](https://hulycommunity.slack.com/join/shared_invite/zt-29kl7zmwz-2b3RRVTiWhhtAwzHjBm3Wg#/shared-invite/email) - Join our community on Slack to share feedback and feature suggestions!
+* [**YouTube**](https://www.youtube.com/@huly_io) - Dive deeper into Huly’s features by watching our demo videos, tutorials and other video content.
+* Reach out through **[LinkedIn](https://www.linkedin.com/company/hulylabs/)** and [**Twitter**](https://twitter.com/huly_io) - we’d love to see what you’re building with Huly!
+
+---
+
+🎉 Congratulations! You’ve completed all of the tasks! ✅ 
+
+We can’t wait to see what you create! 🚀

dev/import-tool/example/My Project/HULY-1.md

@@ -0,0 +1,37 @@
+---
+class: tracker.class.Issue
+title: Welcome to Huly! 🌟
+assignee: John Doe
+status: Todo
+priority: Medium
+estimation: 6
+remainingTime: 6
+component: Core
+milestone: Iteration 198
+comments:
+  - author: John Doe
+    createdOn: 2022-02-05t10:30:00.10-05:00Z
+    text: |
+      Hello, world!
+  - author: Joe Shmoe
+    createdOn: 2022-02-05t10:35:00.10-05:00Z
+    text: |
+      Hello, **world!**
+---
+### **Welcome to Huly, your all-in-one project management platform!** 
+
+Embark on an exciting journey to master our next-generation project management tool. Packed with features like collaborative editing, team scheduling, video conferencing and more, the Huly platform is totally customizable to your team’s unique needs.
+
+Let’s get started by setting up your team workspace! You’ll complete **5 tasks** to learn about the essential features of the Huly platform:
+
+1. Welcome to Huly! 🌟 (you are here!)
+2. Create your first **project** 📌
+3. Create your first **issue** 📝
+4. Schedule your first **Action Item** 📆
+5. Explore all Huly has to offer 🚀
+
+Once you're familiar with Huly, feel free to delete these starter tasks or share them with your team!
+
+🎉Congratulations! You’ve completed Task 1 just by getting started ✅ Click below to proceed to Task 2!
+
+### Next: Task 2 - Create your first project ➡️ [HULY-2](HULY-2.md)