Skip to content

Commit 8e86179

Browse files
danciaclaradanciaclara
authored
Private collections (#451)
* Private collections * formatting fixes * Updated moving pages between collections
1 parent fd8477f commit 8e86179

4 files changed

Lines changed: 211 additions & 48 deletions

File tree

‎docs/.vitepress/config.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -507,6 +507,7 @@ export default defineConfig({
507507
],
508508
},
509509
{ text: "Wiki", link: "/core-concepts/pages/wiki" },
510+
{ text: "Collections", link: "/pages/collections" },
510511
{ text: "Nested Pages", link: "/core-concepts/pages/nested-pages" },
511512
{ text: "Page Templates", link: "/templates/page-templates" },
512513
],

‎docs/core-concepts/pages/wiki.md‎

Lines changed: 2 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -31,46 +31,9 @@ The Wiki sidebar organizes content into sections:
3131

3232
## Collections <Badge type="info" text="Pro" />
3333

34-
Collections are folders for your Wiki pages. They give you a way to group related pages together.
34+
Collections are how your wiki stays organized. Every page in your wiki belongs to a collection, and collections appear as a flat list in your sidebar, expand one to see the pages inside it.
3535

36-
:::tip
37-
With Collections, all existing Wiki pages are automatically grouped into a default collection called **General**. From there, you can create new collections and reorganize pages however you like.
38-
:::
39-
40-
### Create a collection
41-
42-
1. Click the **+** icon next to the **Collections** heading in the Wiki sidebar.
43-
2. In the **Create a collection** modal, give the collection a title.
44-
3. Optionally choose an icon to help visually distinguish it.
45-
4. Click **Create collection**.
46-
47-
The new collection appears in the sidebar and is ready for pages.
48-
49-
### Move pages between collections
50-
51-
Drag and drop any page from one collection to another in the sidebar. The page moves immediately.
52-
53-
You can also move pages into or out of nested positions within a collection by dragging them to the desired level.
54-
55-
### Browse a collection
56-
57-
Click a collection name in the sidebar to see its contents in the main area. The collection view shows each page's name, owner, nested page count, and last activity date.
58-
59-
From here you can:
60-
61-
- **Add a page** directly into the collection using the **Add page** button in the top right.
62-
- **Copy a link** to any page via the **…** menu on that row.
63-
- **Filter pages** by Favorites, Created date (1 week, 2 weeks, 1 month, or a custom range), or Created by (any workspace member).
64-
- **Search** within the collection using the search icon.
65-
66-
### Delete a collection
67-
68-
1. Open the collection you want to delete.
69-
2. Click the ellipsis icon next to the collection on the sidebar to select **Delete**.
70-
3. In the **Delete collection** dialog, choose what happens to the pages inside:
71-
- **Transfer pages and delete collection** — moves all pages to another collection you select. Pages and their permissions are preserved. Note that moved pages will inherit the permissions of the destination collection.
72-
- **Delete collection with pages** — permanently deletes the collection and all its pages. This action can't be undone.
73-
4. Click **Delete collection**.
36+
[Learn how to create and manage collections](/pages/collections)
7437

7538
## Create and manage Wiki pages
7639

‎docs/pages/collections.md‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
---
2+
title: Organize your Plane Wiki
3+
description: Organize your Plane wiki with Collections. Create public or Invite Only collections and control access with View, Comment, and Edit roles.
4+
---
5+
6+
# Collections <Badge type="info" text="Pro" />
7+
8+
Collections are how Plane organizes your wiki pages. Think of them as folders for your workspace's knowledge. Every wiki page in your workspace lives inside a collection, and you can control exactly who gets to see each one.
9+
10+
In your wiki sidebar, collections appear as a flat list. When you expand a collection, you see the pages inside it, and each page can have its own nested pages beneath it. The collections themselves don't nest inside each other, just the pages do.
11+
12+
## The General collection
13+
14+
Every workspace starts with one collection called **General**. Plane creates it automatically, and it works as the default landing spot for any new wiki page you create without explicitly placing it somewhere else. You can add pages to it and move pages out of it, but you can't rename it or delete it.
15+
16+
## Public collections vs. Private collections
17+
18+
Plane gives you two kinds of collections, and the difference comes down to who can see what's inside.
19+
20+
### Public collections
21+
22+
Public collections are visible to everyone in your workspace with a Member or Admin role. Anyone with those roles can read pages in a public collection, and create one.
23+
24+
### Private collections <Badge type="tip" text="Business" />
25+
26+
Private collections are visible only to the people you explicitly invite. If you haven't invited someone, the collection doesn't show up in their sidebar at all. This makes Private collections the right choice for anything sensitive like internal proposals, confidential decisions, HR documents, or anything that shouldn't be visible workspace-wide.
27+
28+
For a full breakdown of what each role can do across all collection actions, see the [permissions matrix](/roles-and-permissions/permissions-matrix#wiki-collections).
29+
30+
## Create a collection
31+
32+
**Create a public collection**
33+
34+
1. In your wiki sidebar, click the **+** next to **Collections**.
35+
2. Enter a name.
36+
3. Leave the visibility as **Public**.
37+
4. Click **Create collection**.
38+
39+
**Create a private collection**
40+
41+
1. In your wiki sidebar, click the **+** next to **Collections**.
42+
2. Enter a name.
43+
3. Select **Private** as the visibility.
44+
4. Click **Create collection**.
45+
46+
The collection appears in your sidebar immediately. Since no one else can see it yet, your next step is to invite the people who need access.
47+
48+
:::warning
49+
You can't change a collection's visibility after you create it. If you need to switch, say, from private to public, create the new collection first, move your pages to it, then delete the old one. If you delete private collection before moving its pages, they'll be archived automatically.
50+
:::
51+
52+
## Create a new page inside a collection
53+
54+
You can create a new page directly from a collection without going through the main wiki page creation flow.
55+
56+
1. Open the collection.
57+
2. Click the **+** menu inside the collection view.
58+
3. Select **Create new page**.
59+
60+
Plane creates the page and adds it to that collection immediately. It works just like creating any other wiki page, the only difference is it lands in the collection you're already in, rather than the General collection.
61+
62+
## Add an existing page to a collection
63+
64+
If a page already exists and you want to move it into a collection, you add it from inside the collection.
65+
66+
1. Open the collection.
67+
2. Click the **+** button inside the collection, then select **Add existing page**.
68+
3. Search for the page by name, or browse the list.
69+
4. Select one or more pages and confirm.
70+
71+
A few things to keep in mind:
72+
73+
- A page can only belong to one collection at a time. Adding it to a new collection removes it from its current one.
74+
- **For private collections**, only root-level pages can be added. You can't independently add a child page, it inherits its parent's collection. If you want a child page in a private collection, move its parent there and the children follow automatically.
75+
- The search shows only eligible pages. Pages that don't appear are either already in this collection, or aren't eligible (for example, a child page when adding to a private collection).
76+
77+
## Edit a collection
78+
79+
You can rename a collection or change its icon at any time, the visibility setting is the only thing you can't change after creation. This does not apply to the General collection, which can't be renamed.
80+
81+
1. Open the collection's options menu (the **···** next to its name in the sidebar).
82+
2. Select **Edit**.
83+
3. Update the name, or click the icon to pick a new emoji or icon.
84+
4. Save.
85+
86+
## Manage access in a private collection
87+
88+
Once you create a private collection, you manage who can access it through the collection's share settings.
89+
90+
**Invite a member**
91+
92+
1. Open the private collection.
93+
2. Click the **Share** button (or open the collection's options menu and select **Share**).
94+
3. Search for a workspace member by name or email.
95+
4. Choose their access level:
96+
- **View** — they can read pages but not edit or comment
97+
- **Comment** — they can read and leave comments
98+
- **Edit** — they can read, comment, and edit pages
99+
5. Click **Save**.
100+
101+
The member can now see and access the collection according to the level you set.
102+
103+
**Change a member's access level**
104+
105+
1. Open the collection's **Share** settings.
106+
2. Find the member in the list.
107+
3. Click their current access level and select a new one.
108+
109+
**Remove a member**
110+
111+
1. Open the collection's **Share** settings.
112+
2. Find the member in the list.
113+
3. Click the remove option next to their name.
114+
115+
They immediately lose access to the collection and all pages inside it.
116+
117+
:::info
118+
**Workspace owners and admins always have full access** to every private collection in the workspace, regardless of whether they're in the members list.
119+
:::
120+
121+
## Search and filter pages within a collection
122+
123+
When a collection has many pages, you can search and filter to find what you need.
124+
125+
- **Search** - type in the search box inside the collection view to filter pages by name in real time.
126+
- **Filter** - use the filter menu to narrow pages by creator, date created, or your favorited pages.
127+
128+
These controls apply only to the current collection view, they don't affect other collections or the sidebar.
129+
130+
## Move pages between collections
131+
132+
Drag the page to its destination collection in the wiki sidebar. Depending on the visibility change involved, Plane shows a confirmation dialog before completing the move.
133+
134+
The page moves immediately. Nested pages follow their parent. If you move a parent page, all its children move with it.
135+
136+
- **Moving a page into a private collection** automatically makes that page private. Only people with access to the collection will be able to see it.
137+
- **Moving a page out of a private collection** into a public one makes it visible to the whole workspace again.
138+
- **Removing a page from a private collection without moving it elsewhere** keeps the page private. It doesn't automatically become public. You'll need to update the page's own access setting manually if you want to make it public again.
139+
140+
## Reorder collections and pages
141+
142+
**Reorder collections in the sidebar**
143+
144+
Drag a collection up or down in the sidebar list to change its position.
145+
146+
**Reorder pages within a collection**
147+
148+
Inside a collection, drag pages up or down to change the order they appear in. This affects how pages show up in the collection view and in the sidebar when the collection is expanded.
149+
150+
## Delete a collection
151+
152+
1. Open the collection's options menu.
153+
2. Select **Delete**.
154+
3. Confirm the deletion.
155+
156+
**What happens to the pages**
157+
158+
For **public collections**, Plane gives you a choice when you delete.
159+
160+
- **Delete collection only** - the collection is removed and the pages return to the General collection.
161+
- **Delete collection and archive pages** - the collection is removed and all its pages are archived. Archived pages aren't permanently deleted; you can find and restore them from your workspace archive.
162+
163+
For **private collections**, pages are always archived when you delete the collection, there's no option to keep them unarchived.
164+
165+
:::info
166+
You can't delete the **General** collection.
167+
:::
168+
169+
## See also
170+
171+
- [Wiki](/core-concepts/pages/wiki)
172+
- [Collections permissions matrix](/roles-and-permissions/permissions-matrix#wiki-collections)

‎docs/roles-and-permissions/permissions-matrix.md‎

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -178,19 +178,46 @@ This covers workspace-admin operations over teamspaces. For actions taken by tea
178178
| Update page icon / logo | ✓ | ✓ | ✓ | — |
179179
| Export page | ✓ | ✓ | ✓ | — |
180180
| Favourite a page | ✓ | ✓ | ✓ | — |
181-
| Comment on a page | ✓ | ✓ | — | — |
181+
| Comment on a page | ✓ | ✓ | ✓ | — |
182182
| Restore from version | ✓ | ✓ | ✓ | — |
183183

184184
> Commenting on workspace pages requires Owner or Admin.
185185
186-
#### Wiki Collections
187-
188-
| Permission | Owner | Admin | Member | Guest |
189-
| ------------------- | :---: | :---: | :----: | :---: |
190-
| View collections | ✓ | ✓ | ✓ | — |
191-
| Create a collection | ✓ | ✓ | ✓ | — |
192-
| Edit collection | ✓ | ✓ | Own | — |
193-
| Delete collection | ✓ | ✓ | Own | — |
186+
### Wiki Collections
187+
188+
| Permission | Owner | Admin | Member | Guest |
189+
| ------------------------------------------ | :---: | :---: | :----------------: | :---: |
190+
| **Collections** | | | | |
191+
| View public collections | ✓ | ✓ | ✓ | — |
192+
| View private collections | ✓ | ✓ | If invited¹ | — |
193+
| Create a public collection | ✓ | ✓ | ✓ | — |
194+
| Create a private collection | ✓ | ✓ | — | — |
195+
| Edit a collection (rename, icon) | ✓ | ✓ | Own | — |
196+
| Delete a collection | ✓ | ✓ | Own | — |
197+
| **Pages in a public collection** | | | | |
198+
| View pages | ✓ | ✓ | ✓ | — |
199+
| Create a new page | ✓ | ✓ | ✓ | — |
200+
| Add existing pages | ✓ | ✓ | ✓ | — |
201+
| Remove pages | ✓ | ✓ | ✓ | — |
202+
| Reorder pages | ✓ | ✓ | ✓ | — |
203+
| Move a page to another collection | ✓ | ✓ | ✓ | — |
204+
| **Pages in a private collection** | | | | |
205+
| View pages | ✓ | ✓ | If invited¹ | — |
206+
| Create a new page | ✓ | ✓ | Own or Edit² | — |
207+
| Add existing pages | ✓ | ✓ | Own or Edit³ | — |
208+
| Remove pages | ✓ | ✓ | Edit + page owner⁴ | — |
209+
| Reorder pages | ✓ | ✓ | Edit² | — |
210+
| Move a page out | ✓ | ✓ | Edit + page owner⁴ | — |
211+
| **Private collection - member management** | | | | |
212+
| View member list | ✓ | ✓ | If invited¹ | — |
213+
| Invite members | ✓ | ✓ | Own | — |
214+
| Change a member's access level | ✓ | ✓ | Own | — |
215+
| Remove a member | ✓ | ✓ | Own | — |
216+
217+
¹ Any membership level (View, Comment, or Edit) grants access.
218+
² Must be collection owner, or have Edit-level membership.
219+
³ Must be collection owner, or have Edit-level membership **and** own the root page being added.
220+
⁴ Must have Edit-level membership **and** own the root page.
194221

195222
### Workspace Views
196223

0 commit comments

Comments
 (0)