diff --git a/docs/communication-and-collaboration/comments-and-activity.md b/docs/communication-and-collaboration/comments-and-activity.md index ad82b49..5e149e6 100644 --- a/docs/communication-and-collaboration/comments-and-activity.md +++ b/docs/communication-and-collaboration/comments-and-activity.md @@ -5,40 +5,25 @@ description: Add comments, mention team members, and track activity on work item # Work Item Comments -Use comments to discuss work items, ask questions, provide updates, and collaborate with your team. Every work item includes a comment section and activity log. +Comments are threaded, rich-text messages attached to a work item. They are the primary place for discussion — asking questions, sharing context, reviewing decisions, or signalling blockers — without editing the work item's description or fields. -## Add a comment +Every comment is associated with a specific work item and scoped to a project and workspace. Comments appear in the activity panel of a work item alongside system-generated activity events (field changes, state transitions, assignments), but comments and activity are distinct things: activity is system-written and immutable; comments are user-written and editable. -1. Open a work item. -2. Scroll down to the Activity section. -3. Click in the **Add comment** field. -4. Type your comment using the rich text editor. -5. Click **Comment** to post. - -![Work item activity and comments](https://media.docs.plane.so/issues/issue-activity-comments.webp#hero) - -Your comment appears immediately in the activity feed with a timestamp and your profile picture. +## Add a comment to a work item -## Reply to comments - -Reply directly to specific comments to keep discussions organized and contextual. Threaded comments help you maintain focused conversations within a work item, especially when multiple topics are being discussed. - -### Create a threaded reply +![Work item comments](https://media.docs.plane.so/issues/work-item-comments.webp#hero) -![Reply to comments](https://media.docs.plane.so/issues/reply-to-comments.webp#hero) - -1. Click the ⋯ menu next to any comment to reveal the actions menu. -2. Select **Reply**. -3. Type your response in the reply field. -4. Click **Comment** to post your reply. - -Replies appear nested under the original comment, making it easy to follow the conversation thread. Team members get notified when you reply to their comments. +1. Open a work item. +2. Navigate to the **Activity** or **Comments** section in the detail panel. +3. Click the comment input area. +4. Type your comment. Use **Shift+Enter** to add a line break. +5. Press **Enter** (or **Mod+Enter** if you have changed your shortcut) to submit, or click the **Comment** button. -## Comment features +Your comment appears immediately in the activity feed with a timestamp and your profile picture. ### Rich text formatting -The comment editor supports rich text formatting for clear communication: +The comment editor is a full rich text environment. You can format text (bold, italic, code, lists, headings), embed images, and insert links. Pressing **Shift+Enter** inserts a line break without submitting the comment. **Available formatting:** @@ -51,38 +36,68 @@ The comment editor supports rich text formatting for clear communication: - Code blocks - Share longer code snippets with syntax - Links - Reference external resources -### Mention team members +## Reply to comments -Tag team members in comments to notify them and draw their attention to specific work items. +Comments support one level of threading. Any top-level comment can receive replies. Replies are displayed nested under the parent and show a count of how many replies exist and which members participated. The reply editor behaves identically to the top-level comment editor, including shortcut and mention support. + +Replies inherit the access level of their parent comment and cannot be changed independently. + +### Create a threaded reply + +![Reply to comments](https://media.docs.plane.so/issues/reply-to-comments.webp#hero) + +1. Hover over a comment. +2. Click the **Reply** icon or **Reply** button that appears in the comment toolbar. +3. Type your reply in the reply input that opens below the comment. +4. Click **Add reply** to post your reply. -**To mention someone** +Replies appear nested under the original comment, making it easy to follow the conversation thread. Team members get notified when you reply to their comments. + +## Mention team members + +Tag team members in comments to notify them and draw their attention to specific work items. -1. Type `@` in the comment field. -2. Start typing the person's name. -3. Select their name from the dropdown list. -4. Continue writing your comment. -5. Post the comment. +1. While typing a comment, type `@` followed by the name of the member you want to mention. +2. A suggestion list appears. Use the arrow keys or mouse to select the target. +3. Press **Enter** or click to insert the mention. **What happens** - The mentioned person receives an email notification (if they have notifications enabled) - The work item appears in their Inbox -## Manage comments +## React to a comment -### Edit a comment +1. Hover over the comment. +2. Click the **emoji** icon in the comment toolbar. +3. Select an emoji from the picker. + +Your reaction appears below the comment. Click an existing reaction to add your vote to it or to toggle it off. + +## Copy a link to a specific comment + +Share a direct link to a specific comment for reference in other discussions or documents. + +1. Hover over any comment. +2. Click the three dots (⋯) menu. +3. Select **Copy link**. + +The link copies to your clipboard. When someone clicks the link, they'll be taken directly to that work item with the comment. + +## Edit a comment Update your comments to fix errors or add additional context. 1. Hover over your comment. -2. Click the three dots (⋯) menu. -3. Select **Edit**. -4. Make your changes. -5. Click **Save** (or press Escape to cancel). +2. Click the **Edit** (pencil) icon. +3. Modify the comment text in the editor that opens inline. +4. Submit to save, or press **Escape** to cancel. + +Edited comments show an **edited** label with the edit timestamp. The previous version of the comment is preserved in the work item activity log. You can only edit your own comments. -### Delete a comment +## Delete a comment Remove comments that are no longer relevant or were posted in error. @@ -91,23 +106,13 @@ Remove comments that are no longer relevant or were posted in error. 3. Select **Delete**. 4. Confirm the deletion. -You can only delete your own comments. +You can only delete your own comments. Admins can delete other members' comments. ::: warning -Deleted comments cannot be recovered. +Deletion is permanent. The deletion event is recorded in the work item activity log. ::: -### Copy comment link - -Share a direct link to a specific comment for reference in other discussions or documents. - -1. Hover over any comment. -2. Click the three dots (⋯) menu. -3. Select **Copy link**. - -The link copies to your clipboard. When someone clicks the link, they'll be taken directly to that work item with the comment. - -## Activity log +## Activity tracking The Activity log shows a chronological history of everything that happens on a work item, including comments and system updates. @@ -132,16 +137,16 @@ The Activity log shows a chronological history of everything that happens on a w - Attachments uploaded - Description edits +Every comment action — creation, edit, or deletion — is recorded as a work item activity event. This means the full comment history (including the text of previous versions on edit) is preserved in the activity log. Reaction events are also logged. + +Comment edits display an **edited** indicator with the `edited_at` timestamp. The original text is accessible in the activity log. + ### Filter activity Show only specific types of activity to focus on what matters. 1. Click the **Filters** button in the Activity panel. -2. Select activity types to display: - - **All** - Show everything - - **Comments** - Only comments - - **Activity** - Only system updates (status changes, assignments, etc.) - - **Worklogs** - Only time tracking entries +2. Select **Assignee** to see relevant activity. 3. The activity log updates immediately. ### Sort activity @@ -155,4 +160,17 @@ Change the order in which activities appear. Click the sort icon next to Filters to toggle between sort orders. ---- +## Notification preferences + +Members can configure whether they receive email notifications for new comments on work items they are involved in. This is set per-workspace and can be further overridden at the project level. The preferences cover two triggers: + +- **Comment** — a new comment is posted on a work item you are subscribed to, assigned to, or created +- **Mention** — you are @mentioned in a comment + +## Comment submit shortcut + +By default, pressing **Enter** submits a comment. Pressing **Shift+Enter** always inserts a line break regardless of this setting. + +If you prefer to use Enter freely for line breaks and only submit intentionally, you can switch the shortcut to **Mod+Enter** (Ctrl+Enter on Windows/Linux, ⌘+Enter on macOS) in your profile preferences. This setting is stored on your user profile and applies globally — it affects the comment create form, the comment edit form, and the reply editor, across all projects and workspaces. + +The setting is per-user, not per-workspace. Other members are not affected by your preference. diff --git a/docs/core-concepts/issues/overview.md b/docs/core-concepts/issues/overview.md index ee64d90..8a00455 100644 --- a/docs/core-concepts/issues/overview.md +++ b/docs/core-concepts/issues/overview.md @@ -96,6 +96,9 @@ Break down larger tasks into smaller, manageable components by creating sub-work ![Sub-work items](https://media.docs.plane.so/work-items/sub-work-items.webp#hero) +**Cross-project sub-work items** +A work item in Project A can be a sub-work item of a work item in Project B. The parent picker searches across the entire workspace. + ## Duplicate work items When you need to create similar work items or replicate a work item's structure and properties, Plane lets you duplicate existing work items either within the same project or across different projects. @@ -151,7 +154,7 @@ Plane allows you to upload different file types directly to the work item. Use t JPEG, PNG, GIF, SVG, WebP, TIFF, BMP - **Documents** - PDF, Microsoft Word, Microsoft Excel, Microsoft PowerPoint, Plain Text, Rich Text Format (RTF), OpenDocument Spreadsheet, OpenDocument Text, OpenDocument Presentation, OpenDocument Graphics + PDF, Microsoft Word, Microsoft Excel, Microsoft PowerPoint, Plain Text, Rich Text Format (RTF), Markdown, OpenDocument Spreadsheet, OpenDocument Text, OpenDocument Presentation, OpenDocument Graphics - **Audio** MP3, WAV, OGG, MIDI, AAC, FLAC, M4A diff --git a/docs/core-concepts/pages/overview.md b/docs/core-concepts/pages/overview.md index 22d8a92..0836c1a 100644 --- a/docs/core-concepts/pages/overview.md +++ b/docs/core-concepts/pages/overview.md @@ -177,7 +177,7 @@ The restored content becomes the current version, and a new entry is added to th ![Export Page](https://media.docs.plane.so/pages/export-page.webp#hero) -Pages lets you export your content in various formats, including PDF and Markdown. This feature is a game-changer for project managers and team members who need to share information with stakeholders, clients, or team members who might not be using Plane. +Pages lets you export your content in various formats, including PDF, Word, and Markdown. This feature is a game-changer for project managers and team members who need to share information with stakeholders, clients, or team members who might not be using Plane. When you export to PDF, your documents keep their formatting, making them easy to share and print without any hassle. If you choose to export to Markdown, you can seamlessly integrate your content into other tools or platforms, streamlining your workflow. diff --git a/docs/core-concepts/views.md b/docs/core-concepts/views.md index 9561e29..299e833 100644 --- a/docs/core-concepts/views.md +++ b/docs/core-concepts/views.md @@ -5,82 +5,187 @@ description: Create, save, and share Views in Plane to quickly access filtered w # Views -Views are saved collections of filters that you can apply to work items, allowing you to analyze and manage them efficiently. Instead of reapplying the same filters repeatedly, you can save them with a title for easy access and reuse. +A View in Plane is a saved configuration of filters, layouts, display options, and sorting preferences applied to your work items. Views do not change the underlying data — they are lenses that let you see the same work items through different perspectives without creating duplicates or moving anything. -## View types +Think of a view as a smart bookmark: you define what you care about (priority = urgent, assigned to me, due this week), how you want to see it (Kanban board, grouped by state), and which columns to show — and Plane remembers all of that for every session. -In Plane, you can create two different types of views: +![Views](https://media.docs.plane.so/views/views.webp#hero) + +Views are especially useful when you need to: + +- Focus a recurring standup on a specific slice of work (e.g., all blockers this sprint). +- Give stakeholders a curated window into progress without exposing the full backlog. +- Share a stable URL that always shows the latest issues matching defined criteria. +- Standardize how a team monitors a specific workflow (e.g., QA queue, release checklist). + +## Types of Views + +Plane offers two scopes of views, with fundamentally different coverage. + +- **Project Views** + Project views are created within a specific project and accessible to all members of that project. This feature is enabled by default and can be toggled from [Project Settings](/core-concepts/projects/overview#configure-project-settings). Project views support all layouts. - **Workspace Views** Workspace views are created at the workspace level and available to all workspace members. These include some default system-defined views that cannot be removed. Workspace views are visualized using the spreadsheet layout. ![Workspace Views](https://media.docs.plane.so/views/workspace-views.webp#hero) -- **Project Views** - Project views are created within a specific project and accessible to all members of that project. This feature is enabled by default and can be toggled from [Project Settings](/core-concepts/projects/overview#configure-project-settings). Project views support all layouts. + Workspace views include four built-in, non-deletable default views: **All Issues**, **Assigned to Me**, **Created by Me**, and **Subscribed**. These are always available and always reflect live data. + +- **Teamspace Views** + Teamspace views provide a third scope: views tied to a teamspace rather than a single project or the full workspace. See more about [Teamspace Views](/core-concepts/workspaces/teamspaces#teamspace-views). - ![Project Views](https://media.docs.plane.so/views/project-views.webp#hero) +## Create view -## Create Views +### Create a project view -To create a project View, press `V` anywhere within your project or click the **Add view** button in the project's **Views** section. Apply the desired filters and provide a name to save the view. +![Create view](https://media.docs.plane.so/views/create-view.webp#hero) -![Create view](https://media.docs.plane.so/views/create-view-modal.webp#hero) +1. Open a project and go to **Views** in the left sidebar. +2. Click **Add view**. +3. Enter a **name** for the view. +4. Optionally add a **description** to explain the view's purpose. +5. Select the access level, layout and display options as per your requirements. +6. Set **Filters** to define which issues appear. Use the filter builder to select properties like Assignee, Priority, State, Label, or date ranges. +7. Click **Create View**. -Alternatively, spin off a View from within the project's Work items section after applying the filters and clicking **Save View**. +Alternatively, spin off a View from within the project's Work items section after applying the layout, filters, display options and then clicking **Save View**. -![Create view from existing](https://media.docs.plane.so/views/view-create-from-existing.webp#hero) +![Create view from filters](https://media.docs.plane.so/views/create-view-from-work-items.webp#hero) -For Workspace Views, click the **Add view** button in the **Views** section of your Workspace. +The view is created with your current filter selections and saved to the project's views list. Display filters and properties default to your workspace defaults and can be adjusted after creation from within the view. -Learn more about how to apply filters [here](/core-concepts/issues/visualise_filter). After creating a view, you can share the link to collaborate and investigate with members. +### Create a workspace view -## Private views +1. Click **Views** in the main sidebar (not inside a project — at the workspace level). +2. Click **Add View**. +3. Enter a **name** and optional **description**. +4. Set **filters** — these apply across all projects in the workspace. +5. Click **Create View**. -By default, views are visible to all members. On Pro and above, you can make a view private so only you can see it. Toggle between public and private using the globe and lock icons in the create or edit view modal. +Workspace views appear alongside the four built-in views (All Issues, Assigned to Me, Created by Me, Subscribed). + +Learn more about how to apply filters [here](/core-concepts/issues/visualise_filter). After creating a view, you can share the link to collaborate and investigate with other members. + +## View access levels + +Every view has an access level. + +### Public view + +By default, views are public. They are visible and usable by all members with access to the project. + +### Private view + +They are visible only to the creator; other members cannot see or open it. Only the owner of a private view can change its access level. Project admins cannot override private view access. Toggle between public and private using the globe and lock icons in the create or edit view modal. ![Private view](https://media.docs.plane.so/views/private-view.webp#hero) -## Work with Views +## Edit a view -Saved filters can be accessed from the **Views** section. +1. Open the view. +2. Select your preferred layout: **List**, **Board**, **Calendar**, **Table**, or **Gantt**. +3. Add, remove, or modify filter conditions and display options. +4. Click **Update View** that appears in the filter bar. -![view](https://media.docs.plane.so/views/views-overview.webp#hero) +If you close the view without saving, your unsaved filter changes are discarded and the view reverts to its saved state on next open. -After creating a view, you can: +### Group work items in a view -- Adjust the layout. -- Organize information using grouping or sorting options. -- Apply additional filters to refine results. +1. Open the view. +2. Click **Display** in the top toolbar. +3. Under **Group by**, select a property: State, Priority, Label, Assignee, Cycle, Module, or others. +4. Optionally set **Sub-group by** for a second-level grouping (in the Board layout). +5. Toggle **Show empty groups** if you want to see group headers even when there are no matching issues. +6. Save the view. -Workspace Views are visualized using the spreadsheet layout, while project Views support all layouts. Learn more about layouts and grouping options [here](/core-concepts/issues/layouts). +## Lock view -## Publish Views +A view can be **locked** by its creator to prevent any edits — including filter changes, display changes, and renames. Locked views can still be read by all permitted members; only the creator can unlock them. -Publishing a View allows you to share it more interactively by enabling features like comments, reactions, and voting. Here's how to publish a view: +1. Open the view and click the **Lock** button on the top. +2. Alternatively, go to the Views list. Open the **...** menu → **Lock View**. -1. Click the … icon on the View you want to publish. -2. Select the **Publish** option. -3. In the **Publish views** modal, toggle the settings for allowing comments, reactions, or voting. -4. Once configured, click **Publish**. The view will now be accessible to anyone with the link. +A lock icon appears next to the view name. Members who try to edit the view will see a read-only message. To unlock, open the same menu and select **Unlock View** — only the creator can do this. - ![Publish view](https://media.docs.plane.so/views/publish-view.webp#hero) +Locking is useful when a view represents an agreed-upon team standard and you want to prevent accidental changes. -## Update Views +## Publish View -After creating a view, any modification to its filters will prompt you to update the view. Additionally, you can choose to change the name, description, and filters explicitly from the list of views by selecting the **Edit** option corresponding to the view you wish to update. +Project views can be **published** to generate a public shareable link. -## Delete Views +![Publish view](https://media.docs.plane.so/views/publish-view.webp#hero) -You can remove views by deleting them from the list of views in your workspace or project. Deleting a view has no impact on the associated work items. +1. Open the project view. +2. Open the **...** menu → **Publish**. +3. In the publish modal: + - Toggle on **Publish** to generate the public link. + - Enable or disable **Comments**, **Reactions**, and **Votes** for public visitors. + - Choose which **layouts** are available to public viewers. +4. Copy the generated link and share it. + +A published view: + +- Is accessible to anyone with the link — no Plane account required. +- Shows issues filtered by the view's saved configuration. +- Can optionally allow reactions, comments, or votes from public visitors. +- Can restrict which layouts (List, Board, etc.) are exposed to public viewers. -## Additional features +You can update publish settings or unpublish at any time without changing the original view. To unpublish, return to the same modal and toggle **Publish** off. The link immediately stops working. -- Mark frequently used views as favorites for quick access. Favorited views appear on the sidebar under **Your Favorites** section. -- Use the search bar in the **Views** section to locate specific views quickly. +## Export view -## Export views +When you export a view, Plane captures the view's filters, processes it and notifies you when it is ready to download. -You can export data from any saved view to analyze filtered work items, create custom reports, or share specific subsets of your project data. Exports respect all filters applied to the view. +1. Go to the views list or open a view. +2. Open the **...** menu → **Export**. +3. Select a format: **CSV**, **XLSX**, or **JSON**. +4. Click **Continue**. +5. A toast notification confirms the export has started. Click **View Exports** in the toast, or go to **Workspace Settings → Exports**, to monitor the job and download the file when it is ready. +6. Once the status shows as complete, click **Download** to save the file. + +The exported data reflects the work items that match the view's filters at the moment you trigger the export. Specifically, Plane uses the **currently active filters in your session** — so if you have modified the filters since last saving the view, the export will include those unsaved changes. This means the file you download matches exactly what you see on screen when you click Export. + +For **project views**, the export is scoped to the single project the view belongs to. For **workspace views**, the export spans all projects in the workspace, consistent with how workspace views work in general. + +Export is available on projects views and workspace views. + +### Export formats + +| Format | Description | +| ------ | ------------------------------------------------------------------------------------------------ | +| CSV | Comma-separated values. Opens in any spreadsheet tool. Best for importing into other systems. | +| XLSX | Excel workbook format. Opens directly in Excel or Google Sheets with formatting preserved. | +| JSON | Structured data format. Intended for programmatic use or importing into other tools via scripts. | Learn more about [custom exports](/core-concepts/export#custom-exports). + +## Add view to favorites + +From the views list: + +- Hover over the view and click the **star** icon. + +From inside the view: + +- Click the **star** icon in the view header. + +Favorited views appear in the **Favorites** section of the sidebar for quick access. + +## Duplicate view + +1. Go to the views list (project or workspace level). +2. Right-click or open the **...** menu on the view you want to duplicate. +3. Click **Duplicate** (or **Make a copy**). + +The duplicate is created with the same filters, display filters, and display properties, with "Copy of" prepended to the name. You can rename and modify it independently. + +## Delete a view + +You can remove views by deleting them from the list of views in your workspace or project. Deleting a view has no impact on the associated work items. + +1. Go to the views list. +2. Open the **...** menu on the view → **Delete**. +3. Confirm deletion. + +Deletion is permanent. Issues are not affected — only the saved view configuration is removed. The built-in workspace views (All Issues, Assigned to Me, Created by Me, Subscribed) cannot be deleted. diff --git a/docs/integrations/github.md b/docs/integrations/github.md index 6220f27..0021f05 100644 --- a/docs/integrations/github.md +++ b/docs/integrations/github.md @@ -77,9 +77,7 @@ This step allows you to make comments on issues and pull requests in GitHub thro When this connection is enabled, comments made in Plane will appear in GitHub under your GitHub user account, else comments will be posted as `Plane GitHub App` or your custom GitHub app name. -#### From Workspace settings - -Workspace admins can connect their personal GitHub accounts from Workspace settings. +Workspace admins can connect their personal GitHub accounts from the GitHub configuration page. ![Connect personal account](https://media.docs.plane.so/integrations/github/connect-personal-account.webp#hero) @@ -91,20 +89,18 @@ Workspace admins can connect their personal GitHub accounts from Workspace setti Only one Workspace Admin can connect their GitHub account via Workspace Settings. Others can connect their accounts through [Profile Settings](/integrations/github#from-profile-settings). ::: -#### From Profile settings - -If you don’t have admin access, you can still connect your personal GitHub account through your profile settings. +All other workspace members can connect their personal GitHub accounts from the **Connections** page in +Workspace settings. ![Connect member personal account](https://media.docs.plane.so/integrations/github/connect-personal-account-member.webp#hero) -1. Go to [Profile settings](/core-concepts/account/settings). +1. Go to [Workspace Settings](/core-concepts/workspaces/overview#access-workspace-settings). 2. Select the **Connections** tab in the sidebar. -3. Choose the workspace where you want to connect your GitHub personal account. -4. Click **Connect** in the GitHub section, which will redirect you to GitHub for authentication. +3. Click **Connect** in the GitHub section, which will redirect you to GitHub for authentication. ::: info If your workspace doesn’t have GitHub integration enabled, you won’t be able to connect your personal account. In this case, contact your Workspace Admin. ::: -5. Once connected, your GitHub account will be listed in Plane. +4. Once connected, your GitHub account will be listed in Plane. ## Sync issues diff --git a/docs/integrations/gitlab.md b/docs/integrations/gitlab.md index c0aada3..8abcdaf 100644 --- a/docs/integrations/gitlab.md +++ b/docs/integrations/gitlab.md @@ -101,6 +101,37 @@ After linking a GitLab project, the next step is to associate it with a Plane pr 3. Once configured, you will see the project connection appear in the **Plane Project Connections** section. +### Connect personal GitLab account + +This step allows you to make comments on issues and merge requests in GitLab through your Plane account, using your personal GitLab identity. + +When this connection is enabled, comments made in Plane will appear in GitLab under your GitLab user account, else comments will be posted as `Plane GitLab App` or your custom GitLab app name. + +Workspace admins can connect their personal GitLab accounts from the GitLab configuration page. + +![Connect personal account](https://media.docs.plane.so/integrations/github/connect-personal-account.webp#hero) + +1. In the **Connect personal account** section under **Integrations**, click **Connect**. +2. Review the required permissions GitLab requests and authorize. +3. After granting permissions, you’ll see the status updated to show that your personal account is connected. + +::: info +Only one Workspace Admin can connect their GitLab account via Workspace Settings. Others can connect their accounts through [Profile Settings](/integrations/github#from-profile-settings). +::: + +All other workspace members can connect their personal GitLab accounts from the **Connections** page in +Workspace settings. + +![Connect member personal account](https://media.docs.plane.so/integrations/github/connect-personal-account-member.webp#hero) + +1. Go to [Workspace Settings](/core-concepts/workspaces/overview#access-workspace-settings). +2. Select the **Connections** tab in the sidebar. +3. Click **Connect** in the GitLab section, which will redirect you to GitLab for authentication. + ::: info + If your workspace doesn’t have GitLab integration enabled, you won’t be able to connect your personal account. In this case, contact your Workspace Admin. + ::: +4. Once connected, your GitLab account will be listed in Plane. + ## Sync issues With the GitLab integration set up, you can sync issues between Plane and GitLab at the project level. This ensures GitLab issues and Plane work items stay synchronized within your configured GitLab Projects and Plane projects. diff --git a/docs/roles-and-permissions/permissions-matrix.md b/docs/roles-and-permissions/permissions-matrix.md index e4b91ec..cc194a1 100644 --- a/docs/roles-and-permissions/permissions-matrix.md +++ b/docs/roles-and-permissions/permissions-matrix.md @@ -165,32 +165,32 @@ This covers workspace-admin operations over teamspaces. For actions taken by tea | -------------------------- | :---: | :---: | :----: | :---: | | View a page | ✓ | ✓ | ✓ | — | | Create a page | ✓ | ✓ | ✓ | — | -| Edit page content / title | ✓ | ✓ | ✓ | — | -| Lock / unlock a page | ✓ | ✓ | ✓ | — | -| Make page public / private | ✓ | ✓ | ✓ | — | +| Edit a page | ✓ | ✓ | ✓ | — | +| Lock / unlock a page | ✓ | ✓ | Own | — | +| Make page public / private | ✓ | ✓ | Own | — | | Share a page | ✓ | ✓ | ✓ | — | -| Archive a page | ✓ | ✓ | ✓ | — | -| Restore a page | ✓ | ✓ | ✓ | — | +| Archive a page | ✓ | ✓ | Own | — | +| Restore a page | ✓ | ✓ | Own | — | | Duplicate a page | ✓ | ✓ | ✓ | — | -| Delete a page | ✓ | ✓ | ✓ | — | -| Move a page | ✓ | ✓ | ✓ | — | +| Delete a page | ✓ | ✓ | Own | — | +| Move a page | ✓ | ✓ | Own | — | +| Publish a page | ✓ | ✓ | Own | — | | Update page icon / logo | ✓ | ✓ | ✓ | — | -| Export / download | ✓ | ✓ | ✓ | — | +| Export page | ✓ | ✓ | ✓ | — | | Favourite a page | ✓ | ✓ | ✓ | — | | Comment on a page | ✓ | ✓ | — | — | +| Restore from version | ✓ | ✓ | ✓ | — | > Commenting on workspace pages requires Owner or Admin. #### Wiki Collections -| Permission | Owner | Admin | Member | Guest | -| --------------------- | :---: | :---: | :----: | :---: | -| View collections | ✓ | ✓ | ✓ | — | -| Create a collection | ✓ | ✓ | ✓ | — | -| Edit own collection | ✓ | ✓ | Own | — | -| Edit any collection | ✓ | ✓ | — | — | -| Delete own collection | ✓ | ✓ | Own | — | -| Delete any collection | ✓ | ✓ | — | — | +| Permission | Owner | Admin | Member | Guest | +| ------------------- | :---: | :---: | :----: | :---: | +| View collections | ✓ | ✓ | ✓ | — | +| Create a collection | ✓ | ✓ | ✓ | — | +| Edit collection | ✓ | ✓ | Own | — | +| Delete collection | ✓ | ✓ | Own | — | ### Workspace Views @@ -277,6 +277,19 @@ This covers workspace-admin operations over teamspaces. For actions taken by tea | Apply quick filters (view only) | ✓ | ✓ | ✓ | — | | Favourite a dashboard | ✓ | ✓ | — | — | +| Permission | Owner | Admin | Member | Guest | +| ----------------------------------- | :---: | :---: | :----: | :---: | +| View dashboards | ✓ | ✓ | ✓ | — | +| Create a dashboard | ✓ | ✓ | ✓ | — | +| Edit a dashboard (rename, settings) | ✓ | ✓ | Own | — | +| Delete a dashboard | ✓ | ✓ | Own | — | +| Add a widget | ✓ | ✓ | Own | — | +| Edit a widget | ✓ | ✓ | Own | — | +| Delete a widget | ✓ | ✓ | Own | — | +| Rearrange widgets | ✓ | ✓ | Own | — | +| Apply quick filters (view only) | ✓ | ✓ | ✓ | — | +| Favourite a dashboard | ✓ | ✓ | ✓ | — | + ### Worklogs | Permission | Owner | Admin | Member | Guest |