Skip to content

Commit 9205f64

Browse files
committed
Merge branch 'master' of github.com:makeplane/docs into ui-refresh
2 parents 8af7c75 + 2d73869 commit 9205f64

File tree

25 files changed

+3258
-3011
lines changed

25 files changed

+3258
-3011
lines changed

babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/core-concepts/issues/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Keep the conversation flowing on any work item with our built-in commenting syst
157157

158158
Tag teammates for instant notifications. Just use the @ symbol followed by a team member's name, and they'll get an email notification so nothing slips through the cracks. It's perfect for when you need someone's input or want to loop them into the discussion.
159159

160-
Full editing control - Made a typo or want to add more context? No problem. You can edit your comments anytime to keep things clear and accurate. And if you ever need to remove a comment entirely, the delete option is always there.
160+
Full editing control - Made a typo or want to add more context? No problem. You can edit your comments anytime to keep things clear and accurate. And if you ever need to remove a comment entirely, the delete option is always there. You can also copy a direct link to any comment. Just click the three dots on any comment and select **Copy link** to share that specific part of the conversation with others.
161161

162162
The rich text editor gives you all the formatting tools you need - bold text for emphasis, bullet points for clarity, or even code snippets when you're discussing technical details. It's like having a mini word processor right in your work item, making it easy to communicate exactly what you mean.
163163

docs/core-concepts/pages/editor-blocks.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,7 @@ References work items directly in the editor to track details and progress.
7171
## Divider
7272

7373
Adds a horizontal line to separate content sections visually.
74+
75+
## Emoji
76+
77+
Add emojis to your content across all Plane editors. Type `/emoji` to open the picker or use `:` and start typing for suggestions like `:smile:`. Choose from standard Unicode emojis and GitHub's extended collection.

docs/core-concepts/projects/initiatives.mdx

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -53,43 +53,27 @@ Once created, you can view all Initiatives in the **Initiatives** section on the
5353

5454
![View Initiatives](https://media.docs.plane.so/initiatives/view-initiatives.webp#center)
5555

56-
Selecting an Initiative opens its detailed view, which includes:
56+
Selecting an Initiative opens its detailed view.
5757

58-
## Progress overview
58+
![Initiative overview](https://media.docs.plane.so/initiatives/initiative-overview.webp#center)
5959

60-
![Progress overview](https://media.docs.plane.so/initiatives/progress-overview.webp#center)
60+
Initiatives now offer two distinct views to help you track progress and manage scope effectively. Use the dropdown in the top navigation to switch between Overview and Scope views depending on whether you need high-level progress insights or detailed scope management.
6161

62-
A progress bar indicating a visual representation of project progress categorized as:
63-
- Backlog
64-
- Unstarted
65-
- Started
66-
- Completed
67-
- Cancelled
62+
### Initiative overview
63+
The **Overview** gives you a bird's-eye view of your Initiative's progress. You'll see a comprehensive scope breakdown that tracks both projects and epics within your initiative, showing completion percentages and recent updates at a glance.
6864

69-
The percentages and counts for each category are automatically calculated based on the associated projects.
65+
The progress visualization at the bottom provides an instant snapshot of work distribution across different states - from backlog items to completed work. The percentages and counts for each category are automatically calculated based on the associated projects. This makes it easy to understand where your initiative stands and identify any bottlenecks in your workflow.
7066

71-
:::tip
72-
Use Initiatives for a top-down view of progress. For detailed updates, navigate to individual projects.
73-
:::
67+
:::tip
68+
Use Initiatives for a top-down view of progress. For detailed updates, navigate to individual projects.
69+
:::
7470

75-
## Projects list
71+
### Initiative scope
72+
![Initiative scope](https://media.docs.plane.so/initiatives/initiative-scope.webp#center)
7673

77-
![Projects list](https://media.docs.plane.so/initiatives/projects-list.webp#center)
78-
79-
A list of all associated projects, including:
80-
81-
- Project names
82-
- Work item count and status
83-
- Assigned leads
84-
- Start and end dates
85-
:::info
86-
You cannot add or edit project updates directly from the Initiative view.
87-
:::
88-
89-
## Track Epics across projects
90-
91-
![Add Epics](https://media.docs.plane.so/initiatives/add-epics.webp#center)
74+
Use the dropdown in the top navigation to switch to the **Scope** view to see all the building blocks of your initiative. Here you'll find detailed lists of:
9275

76+
**Epics**
9377
With Initiatives, you can bring together Epics from different projects into a single, high-level view. This helps you track progress across multiple workstreams in one place, giving you a clear picture of how everything is moving forward.
9478

9579
Here’s how it helps:
@@ -102,6 +86,15 @@ After you create an Initiative and add Epics from any project. From there, you c
10286

10387
This is perfect for cross-functional teams working on company-wide objectives, product launches, or any effort that spans multiple projects.
10488

89+
90+
**Projects**
91+
Connected projects showing completion rates and key details like execution status, leads, and timelines.
92+
93+
Each item shows its current progress, making it simple to drill down into specific areas that need attention or are ready for the next phase.
94+
95+
Use the **Add scope** button in the top-right corner to expand your initiative by connecting additional epics and projects. This makes it easy to grow your initiative as new work streams emerge or when you need to link existing work to your strategic goals.
96+
97+
10598
## Initiative updates
10699

107100
![Initiative updates](https://media.docs.plane.so/initiatives/initiative-updates.webp#center)

docs/devices/mobile.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,9 @@ You will notice that the bottom navigation bar now shows different buttons:
176176
<br />
177177

178178
## Push notifications
179+
:::info
180+
Push notifications are currently available only for Plane Cloud users.
181+
:::
179182

180183
The Plane mobile app supports push notifications to keep you updated on important activities. To start receiving notifications, make sure to turn them on in the app settings. Once turned on, you'll be notified about relevant updates, ensuring you never miss an important change or task.
181184

docs/integrations/github.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ GitHub integration with Plane allows seamless synchronization between your GitHu
1919

2020
## Set up GitHub integration
2121

22-
:::danger[Self-hosted Plane instance]
22+
:::danger[Self-hosted Plane instance (Commercial Edition)]
2323
If you're running a self-hosted instance of Plane, you'll need to set up a few extra configurations to get GitHub integration working. Check out the [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github) first before diving into the steps on this page.
2424
:::
2525

docs/integrations/gitlab.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This guide walks you through the steps to connect your GitLab account, link GitL
2121

2222
## Set up GitLab integration
2323

24-
:::danger[Self-hosted Plane instance]
24+
:::danger[Self-hosted Plane instance (Commercial Edition)]
2525
If you're running a self-hosted instance of Plane, you'll need to set up a few extra configurations to get GitLab integration working. Check out the [setup guide](https://developers.plane.so/self-hosting/govern/integrations/gitlab) first before diving into the steps on this page.
2626
:::
2727

docs/integrations/slack.mdx

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This guide will walk you through how to set up and connect your Slack account to
1717

1818
## Set up Slack integration
1919

20-
:::danger[Self-hosted instances]
20+
:::danger[Self-hosted instances (Commercial Edition)]
2121
If you're running a self-hosted instance of Plane, you'll need to set up a few extra configurations to get Slack integration working. Check out the [setup guide](https://developers.plane.so/self-hosting/govern/integrations/slack) first before diving into the steps on this page.
2222
:::
2323

@@ -118,6 +118,26 @@ That’s it. Now the thread and the work item are connected. Comments in the thr
118118

119119
This is perfect for situations where someone logs an issue in Plane but the conversation about it happens in Slack. Just link them up and avoid duplication.
120120

121+
### Add Plane to private Slack channels
122+
When you use Plane in public Slack channels, it automatically adds the Plane bot to those channels. However, for private channels, you must manually add the bot before you can create or link work items.
123+
124+
Here's how to add Plane to your private channels:
125+
126+
1. Navigate to your private channel.
127+
2. Open the channel settings.
128+
3. Go to the **Integrations** tab.
129+
4. Click **Add apps** in the **Apps** section.
130+
5. Search for `Plane` in the app directory. You'll see the Plane app with the `/plane` slash command
131+
6. Click *Add* next to the Plane app.
132+
133+
This will add the Plane bot to your private channel, and Slack will show you a confirmation message.
134+
135+
:::note
136+
Only channel members with the right permissions can add apps to private channels. If you don't see the option to add apps, ask a channel admin or the channel creator to add Plane for you.
137+
:::
138+
139+
Once you add Plane to your private channel, you can use all the same features you'd use in public channels - creating work items, linking existing ones, and getting rich link previews. The bot just needs that initial invitation to join your private conversation.
140+
121141
### Connect project to Slack channel
122142

123143
Stay on top of project updates without switching tabs. You can now link each Plane project to a default Slack channel to receive notifications whenever new work items are created.

docs/templates/project-templates.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@ Templates are perfect for teams who:
3333
- Add a description explaining when and how to use this template.
3434
- Upload a cover image that represents the template.
3535
- Configure project properties like visibility, lead, and dates.
36-
- Set up optional features like **States**, **Labels**, and **Work Item Types**.
36+
- Set up optional features like **States**, **Labels**, and **Work item types**.
3737
![Configure project template](https://media.docs.plane.so/templates/configure-project-template.webp#center)
3838
- Enable or disable **Epics** based on project needs.
39+
- You can optionally define initial work items that will automatically create when teams start new projects, helping them get up and running faster with pre-structured tasks.
3940
6. Click **Create project template** to save.
4041

4142
## Use project templates

docs/templates/work-item-templates.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Templates are perfect for teams who:
3333
- Add a description explaining when and how to use this template.
3434
- Fill in any default fields you want pre-populated (title format, description,..)
3535
- Configure properties like Labels, Assignees, and Modules.
36+
- You can optionally define sub-work items that will automatically create along with the main work item, helping structure complex tasks from the start.
3637
6. Click **Create work item template** to save.
3738

3839
## Use work item templates

0 commit comments

Comments
 (0)