Skip to content

Commit e872f14

Browse files
danciaclaradanciaclara
authored
Quickstart guide and tutorials (#349)
* Quickstart and tutorials * refined the tutorials * minor fix * Updated content in each page * refined all pages and added tutorials overview page * fixed broken links
1 parent 7d2a648 commit e872f14

File tree

11 files changed

+1343
-54
lines changed

11 files changed

+1343
-54
lines changed

‎docs/introduction/quickstart.mdx‎

Lines changed: 116 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,124 @@
11
---
2-
title: Quickstart
3-
description: Follow our interactive walkthrough to set up your Plane workspace, create projects, manage work items, and track progress with cycles. Get your team productive quickly.
2+
title: Quickstart guide
3+
description: Get a functional workspace with team members working on their first project.
44
---
55

6-
# Quickstart guide
6+
# Set up Plane for your team
77

8-
This interactive walkthrough will help you get up and running with Plane in no time. You’ll learn how to set up your workspace, create projects, add and manage work items, organize work into cycles, and track progress—all through easy-to-follow steps.
8+
This walkthrough will help you get up and running with Plane in no time. You’ll learn how to set up your workspace, create projects, add and manage work items, and organize work into cycles, all through easy-to-follow steps.
99

10-
## Set up your Workspace
10+
What you'll accomplish:
1111

12+
- Branded workspace ready for your team
13+
- Team members invited and working
14+
- First project with real work items
15+
- Sprint planning with cycles
16+
17+
## Before you begin
18+
- [Create a Plane account](/#get-plane)
19+
20+
## Set up your Workspace
1221
When you sign up for the first time on Plane, we'll prompt you to create a new Workspace. In this guide, you'll see how to customize the Workspace and invite your team members. Your workspace is the central hub where all your projects and team collaboration will happen, so let’s make it feel like home.
1322

14-
<div style={{ position: "relative", paddingBottom: "calc(56.67989417989418% + 41px)", height: "0", width: "100%" }}>
15-
<iframe
16-
src="https://demo.arcade.software/dbAr7rGeeZux5wELkt8l?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
17-
frameborder="0"
18-
loading="lazy"
19-
webkitallowfullscreen
20-
mozallowfullscreen
21-
allowfullscreen
22-
style={{ position: "absolute", top: "0", left: "0", width: "100%", height: "100%", colorScheme: "light" }}
23-
title="Set up your workspace"
24-
></iframe>
25-
</div>
26-
27-
## Create Projects and Work items
28-
29-
Now that your workspace is ready, it’s time to create your first project. Projects keep all related tasks and work items organized in one place, making it easy to focus on specific goals. In this step, you’ll set up a project and add work items with basic properties to get your team started on their tasks.
30-
31-
<div style={{ position: "relative", paddingBottom: "calc(56.67989417989418% + 41px)", height: "0", width: "100%" }}>
32-
<iframe
33-
src="https://demo.arcade.software/tZYxYSxhhZqPV7dMoCFG?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
34-
frameborder="0"
35-
loading="lazy"
36-
webkitallowfullscreen
37-
mozallowfullscreen
38-
allowfullscreen
39-
style={{ position: "absolute", top: "0", left: "0", width: "100%", height: "100%", colorScheme: "light" }}
40-
title="Set up your workspace"
41-
></iframe>
42-
</div>
43-
44-
## Create and track Cycles
45-
46-
In this final step, you’ll learn how to organize your work into cycles—time-bound periods for managing tasks like sprints. Cycles help you track progress, prioritize tasks, and stay on top of deadlines. Here, you’ll create cycles, add work items, and learn how to track your team’s work over time.
47-
48-
<div style={{ position: "relative", paddingBottom: "calc(56.67989417989418% + 41px)", height: "0", width: "100%" }}>
49-
<iframe
50-
src="https://demo.arcade.software/KwDnMqpyMLPgWH3s0tv8?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
51-
frameborder="0"
52-
loading="lazy"
53-
webkitallowfullscreen
54-
mozallowfullscreen
55-
allowfullscreen
56-
style={{ position: "absolute", top: "0", left: "0", width: "100%", height: "100%", colorScheme: "light" }}
57-
title="Set up your workspace"
58-
></iframe>
59-
</div>
23+
### Customize workspace details
24+
25+
![Workspace settings](https://media.docs.plane.so/quickstart/workspace-settings.webp#center)
26+
27+
1. Click on the workspace logo at the top left.
28+
2. Select **Settings**.
29+
2. In the **General** tab under **Administration**:
30+
- Upload your company logo.
31+
- Update workspace name if you need to change it.
32+
33+
### Invite your team
34+
Get your team members into the workspace so they can start collaborating.
35+
36+
![Invite team members](https://media.docs.plane.so/quickstart/invite-team-members.webp#center)
37+
38+
1. Under Workspace Settings, click **Members** tab on the left pane.
39+
2. Click the **Add member** button.
40+
3. In the **Invite people to collaborate** dialog:
41+
- Type the email address in the provided box.
42+
- Select the role you want them to have.
43+
- Admin: Full workspace control and settings access.
44+
- Member (Default): Can create projects, issues, and collaborate fully.
45+
- Guest: Limited access to specific projects they're invited to.
46+
- Use the **+ Add more** link to invite multiple people at once.
47+
4. Click **Send invitation**.
48+
49+
Team members will receive email invitations and can access the workspace.
50+
51+
## Create your project
52+
53+
Now that your workspace is ready, it’s time to create your first project. Projects keep all related tasks and work items organized in one place, making it easy to focus on specific goals. Let's set up a project and add work items with basic properties to get your team started on their tasks.
54+
55+
![Create project](https://media.docs.plane.so/quickstart/create-project.webp#center)
56+
57+
1. Look for **Projects** tab under the **Workspace** section on your sidebar.
58+
2. Click the **Add Project** button.
59+
4. In the project creation form:
60+
1. Enter the name and write a brief description explaining what this project aims to accomplish.
61+
2. Select `Planning` in the **State** dropdown.
62+
3. By default, the project access is **Public** This means that all Workspace Admins and Members can see and join this project. Change this to **Private** if you want members to join only through invite.
63+
4. Select start and end dates if you want to and set a priority level.
64+
5. Assign a project Lead and add the Members you want to part of this project.
65+
5. Click **Create project** to finish the basic setup.
66+
6. You’ll see a modal with all the features enabled for this project. Leave the defaults as they are and click **Open project**.
67+
68+
Your team can see the project and access it from their workspace.
69+
70+
## Create your work items
71+
72+
Add tasks so your team can start working immediately.
73+
![Create work item](https://media.docs.plane.so/quickstart/create-work-item.webp#center)
74+
75+
1. Navigate to the **Work items** page under your new project.
76+
2. Click **Add work item**.
77+
3. Enter title and brief description about the work item.
78+
*Example:*
79+
- **Title**
80+
*Design new homepage layout*
81+
- **Description**
82+
*Create a fresh layout for the homepage focusing on improved navigation, modern visuals, and clear call-to-actions.*
83+
3. Set work item properties:
84+
- **Assignee**: `You`
85+
- **Priority**: `Medium`
86+
- **Start date**: Today
87+
- **Due date**: One week from today
88+
6. Click **Save** to create the work item.
89+
7. You'll see a new row added in the List layout.
90+
8. Add a few more work items in the same manner.
91+
92+
Team members see their assigned work and can start immediately.
93+
94+
## Plan your first Cycle
95+
96+
In this final step, you’ll learn how to organize your work into cycles (time-bound periods) for managing tasks like sprints. Cycles help you track progress, prioritize tasks, and stay on top of deadlines.
97+
98+
![Create cycles](https://media.docs.plane.so/quickstart/create-cycles.webp#center)
99+
100+
1. Click **Cycles** in your project sidebar.
101+
2. Click the **Add cycle** button on the top right.
102+
3. In the Create cycle modal:
103+
- Name your cycle: `Sprint 1`.
104+
- Set date range: 2 weeks (today through next Friday)
105+
- Click **Create cycle**.
106+
4. Click on your newly created cycle name to open it.
107+
5. Click **Add existing work item**
108+
6. Select the issues you created earlier.
109+
7. Click **Add to cycle**.
110+
8. Return to the main Cycles page to view your active cycle with progress indicators.
111+
112+
Your active cycle shows work items with progress tracking and burndown visualization.
113+
114+
:::tip
115+
Cycles work best when they're 1-2 weeks long and contain achievable goals for your team.
116+
:::
117+
118+
🎉 Congratulations!
119+
You've set up a complete workspace in under 20 minutes. Your team is ready to start collaborating effectively.
120+
121+
122+
**Ready to level up?** Explore these detailed [tutorials](/introduction/tutorials/overview).
123+
124+

‎docs/introduction/tutorials/collaborate-on-work-items.mdx‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
title: Collaborate on work items
3+
description: Learn how to collaborate effectively on work items in Plane using comments, mentions, sub-work items, and activity tracking.
4+
---
5+
6+
# Collaborate on work items
7+
Now that you can create and manage work items, let's learn how to collaborate with your team.
8+
9+
In this tutorial, you'll:
10+
11+
- Use comments and @mentions for effective team communication
12+
- Create sub-work items to break down complex tasks
13+
- Navigate your Inbox for notifications and updates
14+
- Configure email notifications to stay informed
15+
- Track activity and manage collaborative workflows
16+
17+
## Add your first comment
18+
19+
Start conversations that move work forward effectively.
20+
21+
![Add comments](https://media.docs.plane.so/tutorials/add-comments.webp#center)
22+
23+
1. **Open a work item for collaboration**
24+
- Navigate to your project and go to **Work items**,
25+
- Click any work item to open it.
26+
27+
2. **Add a meaningful comment**
28+
- Scroll to the **Activity** section.
29+
- Click in the **Add comment** text area.
30+
- Write a comment that provides value to the team.
31+
32+
*Example:*
33+
```
34+
Started working on this - I've identified the CSS issue and should have a fix ready by tomorrow. The problem is with the media query breakpoint at 375px.
35+
```
36+
37+
3. **Use formatting options**
38+
- Bold important information with **text**.
39+
- Create lists for multiple points.
40+
- Add code snippets or quotes.
41+
42+
4. **Post your comment**
43+
- Click **Comment** to publish.
44+
- Your comment appears in the activity timeline.
45+
- Relevant team members receive notifications.
46+
47+
## Use @mentions
48+
Ensure the right people see important messages and requests.
49+
1. Type @ followed by a team member's name.
50+
2. Select the person from the dropdown that appears.
51+
3. Continue writing your message with context.
52+
53+
## Divide work with sub-work items
54+
55+
Organize large tasks into manageable, assignable pieces.
56+
57+
![Sub-work items](https://media.docs.plane.so/tutorials/create-sub-work-items.webp#center)
58+
59+
1. **Use sub-work items for:**
60+
- Large tasks requiring multiple steps
61+
- Tasks needing different skills or team members
62+
- Work that can be done in parallel
63+
64+
2. **Add a sub-work item**
65+
- In your work item, look for **Add sub-work item** button.
66+
- Click to create a related, smaller task.
67+
- Fill in the sub-item details with specificity.
68+
69+
*Example:*
70+
- **Parent task:** "Implement user authentication system"
71+
- **Sub-work items:**
72+
- "Design login page wireframes" → Designer
73+
- "Set up authentication database tables" → Backend developer
74+
- "Create password reset flow" → Frontend developer
75+
- "Write user registration API endpoints" → Backend developer
76+
77+
3. **Understand sub-item benefits**
78+
- Each sub-item has independent lifecycle and can be worked on separately.
79+
- Team members focus on specific sub-items while staying connected to bigger picture.
80+
- Clear ownership and accountability for different aspects of complex work.
81+
82+
83+
## Track activity and filter updates
84+
85+
Stay informed about work progress without information overload.
86+
87+
1. **Understand the Activity section**
88+
The activity feed shows chronological updates:
89+
- **Work item changes:** State updates, priority changes, assignment changes.
90+
- **Comments:** Team discussions and communications.
91+
92+
2. **Use activity filters**
93+
- Click **Filters** button in the Activity section.
94+
- Control what information you see:
95+
- **Updates:** Show only property changes (state, priority, assignments)
96+
- **Comments:** Display only team discussions and communications
97+
- **Worklogs:** View only time tracking entries
98+
99+
3. **Use activity tracking strategically**
100+
- **Catch up quickly:** See what happened while you were away.
101+
- **Understand decisions:** Read discussions that led to changes.
102+
- **Track progress:** Monitor how work moves through workflow.
103+
- **Maintain context:** Keep team members informed of important developments.
104+
105+
## Explore your notification center
106+
107+
Understand how Plane keeps you informed about team activity.
108+
109+
### Discover the Inbox
110+
111+
![Inbox overview](https://media.docs.plane.so/tutorials/inbox-notifications.webp#center)
112+
113+
1. **Navigate to your Inbox**
114+
- Click **Inbox** in your sidebar.
115+
- This is your notification center for all workspace activity.
116+
117+
2. **Understand Inbox organization**
118+
- **All tab:** Shows all notifications and updates.
119+
- **Mentions tab:** Filters to only @mentions directed at you.
120+
- Notifications include comments, work item changes, and mentions.
121+
122+
## Configure notification preferences
123+
124+
Set up email notifications to stay informed about important updates.
125+
126+
### Access account settings
127+
128+
![Account settings](https://media.docs.plane.so/tutorials/email-notifications.webp#center)
129+
130+
1. **Open your account settings**
131+
- Click your profile avatar (bottom of sidebar).
132+
- Select **Settings** from the dropdown.
133+
- Select **Notifications** in the left pane.
134+
135+
2. **Ensure all notifications are enabled**
136+
- This ensures you receive email updates about all important work item activity.
137+
138+
### Understand notification triggers
139+
140+
**You receive notifications when:**
141+
- Someone @mentions you in comments.
142+
- Work items assigned to you are updated.
143+
- Work items you created have activity.
144+
- Someone comments on work items you're subscribed to.
145+
146+
## What's next?
147+
Your collaboration skills are solid! You're ready to:
148+
149+
- [Create custom views](/introduction/tutorials/organize-and-view-work) to filter and organize work items for different contexts.
150+

0 commit comments

Comments
 (0)