Skip to content

Commit 6979f34

Browse files
sriramveeraghantasriramveeraghanta
committed
fix: formatting for all pages
1 parent bdf8de4 commit 6979f34

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+2385
-2239
lines changed

‎docs/dev-tools/build-plane-app/create-oauth-application.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ keywords: plane oauth application, create plane app, client id secret, plane app
66

77
# Create an OAuth Application
88

9-
1. Navigate to **Workspace Settings** → **Integrations**. `https://app.plane.so/<workspace>/settings/integrations/`
9+
1. Navigate to **Workspace Settings** → **Integrations**.
10+
11+
```text
12+
https://app.plane.so/<workspace>/settings/integrations/
13+
```
1014
2. Click **Build your own**.
1115
3. Fill in the required details:
1216

‎docs/dev-tools/build-plane-app/examples.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,4 +242,4 @@ if __name__ == "__main__":
242242

243243
## Publish to Marketplace
244244

245-
Apps can be listed on the [Plane Marketplace](https://plane.so/marketplace/integrations). Contact [support@plane.so](mailto:support@plane.so) to list your app.
245+
Apps can be listed on the [Plane Marketplace](https://plane.so/marketplace/integrations). Contact [support@plane.so](mailto:support@plane.so) to list your app.

‎docs/dev-tools/build-plane-app/oauth-scopes.md‎

Lines changed: 90 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -10,125 +10,125 @@ This document lists all OAuth scopes available when building a Plane app. Reques
1010

1111
## Project scopes
1212

13-
| Scope | Description |
14-
|-------|-------------|
15-
| `projects:read` | Read projects |
16-
| `projects:write` | Create and update projects |
17-
| `projects.features:read` | Read project features |
18-
| `projects.features:write` | Create and update project features |
19-
| `projects.members:read` | Read project members |
20-
| `projects.members:write` | Manage project members |
21-
| `projects.states:read` | Read project states |
22-
| `projects.states:write` | Create and update project states |
23-
| `projects.labels:read` | Read project labels |
24-
| `projects.labels:write` | Create and update project labels |
25-
| `projects.intakes:read` | Read project intakes |
26-
| `projects.intakes:write` | Create and update project intakes |
27-
| `projects.epics:read` | Read project epics |
28-
| `projects.epics:write` | Create and update project epics |
29-
| `projects.cycles:read` | Read project cycles |
30-
| `projects.cycles:write` | Create and update project cycles |
31-
| `projects.pages:read` | Read project pages |
32-
| `projects.pages:write` | Create and update project pages |
33-
| `projects.modules:read` | Read project modules |
34-
| `projects.modules:write` | Create and update project modules |
35-
| `projects.work_items:read` | Read project work items |
36-
| `projects.work_items:write` | Create and update project work items |
37-
| `projects.work_items.comments:read` | Read work item comments |
38-
| `projects.work_items.comments:write` | Create and update work item comments |
39-
| `projects.work_items.attachments:read` | Read work item attachments |
40-
| `projects.work_items.attachments:write` | Create and update work item attachments |
41-
| `projects.work_items.links:read` | Read work item links |
42-
| `projects.work_items.links:write` | Create and update work item links |
43-
| `projects.work_items.relations:read` | Read work item relations |
44-
| `projects.work_items.relations:write` | Create and update work item relations |
45-
| `projects.work_items.activities:read` | Read work item activities |
46-
| `projects.work_items.activities:write` | Create and update work item activities |
47-
| `projects.work_items.worklogs:read` | Read work item worklogs |
48-
| `projects.work_items.worklogs:write` | Create and update work item worklogs |
49-
| `projects.work_item_types:read` | Read work item types |
50-
| `projects.work_item_types:write` | Create and update work item types |
51-
| `projects.work_item_properties:read` | Read work item properties |
52-
| `projects.work_item_properties:write` | Create and update work item properties |
53-
| `projects.work_item_property_options:read` | Read work item property options |
13+
| Scope | Description |
14+
| ------------------------------------------- | -------------------------------------------- |
15+
| `projects:read` | Read projects |
16+
| `projects:write` | Create and update projects |
17+
| `projects.features:read` | Read project features |
18+
| `projects.features:write` | Create and update project features |
19+
| `projects.members:read` | Read project members |
20+
| `projects.members:write` | Manage project members |
21+
| `projects.states:read` | Read project states |
22+
| `projects.states:write` | Create and update project states |
23+
| `projects.labels:read` | Read project labels |
24+
| `projects.labels:write` | Create and update project labels |
25+
| `projects.intakes:read` | Read project intakes |
26+
| `projects.intakes:write` | Create and update project intakes |
27+
| `projects.epics:read` | Read project epics |
28+
| `projects.epics:write` | Create and update project epics |
29+
| `projects.cycles:read` | Read project cycles |
30+
| `projects.cycles:write` | Create and update project cycles |
31+
| `projects.pages:read` | Read project pages |
32+
| `projects.pages:write` | Create and update project pages |
33+
| `projects.modules:read` | Read project modules |
34+
| `projects.modules:write` | Create and update project modules |
35+
| `projects.work_items:read` | Read project work items |
36+
| `projects.work_items:write` | Create and update project work items |
37+
| `projects.work_items.comments:read` | Read work item comments |
38+
| `projects.work_items.comments:write` | Create and update work item comments |
39+
| `projects.work_items.attachments:read` | Read work item attachments |
40+
| `projects.work_items.attachments:write` | Create and update work item attachments |
41+
| `projects.work_items.links:read` | Read work item links |
42+
| `projects.work_items.links:write` | Create and update work item links |
43+
| `projects.work_items.relations:read` | Read work item relations |
44+
| `projects.work_items.relations:write` | Create and update work item relations |
45+
| `projects.work_items.activities:read` | Read work item activities |
46+
| `projects.work_items.activities:write` | Create and update work item activities |
47+
| `projects.work_items.worklogs:read` | Read work item worklogs |
48+
| `projects.work_items.worklogs:write` | Create and update work item worklogs |
49+
| `projects.work_item_types:read` | Read work item types |
50+
| `projects.work_item_types:write` | Create and update work item types |
51+
| `projects.work_item_properties:read` | Read work item properties |
52+
| `projects.work_item_properties:write` | Create and update work item properties |
53+
| `projects.work_item_property_options:read` | Read work item property options |
5454
| `projects.work_item_property_options:write` | Create and update work item property options |
55-
| `projects.work_item_property_values:read` | Read work item property values |
56-
| `projects.work_item_property_values:write` | Create and update work item property values |
57-
| `projects.milestones:read` | Read project milestones |
58-
| `projects.milestones:write` | Create and update project milestones |
55+
| `projects.work_item_property_values:read` | Read work item property values |
56+
| `projects.work_item_property_values:write` | Create and update work item property values |
57+
| `projects.milestones:read` | Read project milestones |
58+
| `projects.milestones:write` | Create and update project milestones |
5959

6060
## Wiki scopes
6161

62-
| Scope | Description |
63-
|-------|-------------|
64-
| `wiki.pages:read` | Read wiki pages |
62+
| Scope | Description |
63+
| ------------------ | ---------------------------- |
64+
| `wiki.pages:read` | Read wiki pages |
6565
| `wiki.pages:write` | Create and update wiki pages |
6666

6767
## Customer scopes
6868

69-
| Scope | Description |
70-
|-------|-------------|
71-
| `customers:read` | Read customers |
72-
| `customers:write` | Create and update customers |
73-
| `customers.requests:read` | Read customer requests |
74-
| `customers.requests:write` | Create and update customer requests |
75-
| `customers.properties:read` | Read customer properties |
76-
| `customers.properties:write` | Create and update customer properties |
77-
| `customers.property_values:read` | Read customer property values |
69+
| Scope | Description |
70+
| --------------------------------- | ------------------------------------------ |
71+
| `customers:read` | Read customers |
72+
| `customers:write` | Create and update customers |
73+
| `customers.requests:read` | Read customer requests |
74+
| `customers.requests:write` | Create and update customer requests |
75+
| `customers.properties:read` | Read customer properties |
76+
| `customers.properties:write` | Create and update customer properties |
77+
| `customers.property_values:read` | Read customer property values |
7878
| `customers.property_values:write` | Create and update customer property values |
79-
| `customers.work_items:read` | Read customer work items |
80-
| `customers.work_items:write` | Create and update customer work items |
79+
| `customers.work_items:read` | Read customer work items |
80+
| `customers.work_items:write` | Create and update customer work items |
8181

8282
## Initiatives scopes
8383

84-
| Scope | Description |
85-
|-------|-------------|
86-
| `initiatives:read` | Read initiatives |
87-
| `initiatives:write` | Create and update initiatives |
88-
| `initiatives.projects:read` | Read initiative projects |
84+
| Scope | Description |
85+
| ---------------------------- | ------------------------------------- |
86+
| `initiatives:read` | Read initiatives |
87+
| `initiatives:write` | Create and update initiatives |
88+
| `initiatives.projects:read` | Read initiative projects |
8989
| `initiatives.projects:write` | Create and update initiative projects |
90-
| `initiatives.epics:read` | Read initiative epics |
91-
| `initiatives.epics:write` | Create and update initiative epics |
92-
| `initiatives.labels:read` | Read initiative labels |
93-
| `initiatives.labels:write` | Create and update initiative labels |
90+
| `initiatives.epics:read` | Read initiative epics |
91+
| `initiatives.epics:write` | Create and update initiative epics |
92+
| `initiatives.labels:read` | Read initiative labels |
93+
| `initiatives.labels:write` | Create and update initiative labels |
9494

9595
## Workspace scopes
9696

97-
| Scope | Description |
98-
|-------|-------------|
99-
| `workspaces.members:read` | Read workspace members |
100-
| `workspaces.features:read` | Read workspace features |
97+
| Scope | Description |
98+
| --------------------------- | ------------------------------------ |
99+
| `workspaces.members:read` | Read workspace members |
100+
| `workspaces.features:read` | Read workspace features |
101101
| `workspaces.features:write` | Create and update workspace features |
102102

103103
## Stickies scopes
104104

105-
| Scope | Description |
106-
|-------|-------------|
107-
| `stickies:read` | Read stickies |
105+
| Scope | Description |
106+
| ---------------- | -------------------------- |
107+
| `stickies:read` | Read stickies |
108108
| `stickies:write` | Create and update stickies |
109109

110110
## Teamspaces scopes
111111

112-
| Scope | Description |
113-
|-------|-------------|
114-
| `teamspaces:read` | Read teamspaces |
115-
| `teamspaces:write` | Create and update teamspaces |
116-
| `teamspaces.projects:read` | Read teamspace projects |
112+
| Scope | Description |
113+
| --------------------------- | ------------------------------------ |
114+
| `teamspaces:read` | Read teamspaces |
115+
| `teamspaces:write` | Create and update teamspaces |
116+
| `teamspaces.projects:read` | Read teamspace projects |
117117
| `teamspaces.projects:write` | Create and update teamspace projects |
118-
| `teamspaces.members:read` | Read teamspace members |
119-
| `teamspaces.members:write` | Create and update teamspace members |
118+
| `teamspaces.members:read` | Read teamspace members |
119+
| `teamspaces.members:write` | Create and update teamspace members |
120120

121121
## Profile scopes
122122

123-
| Scope | Description |
124-
|-------|-------------|
123+
| Scope | Description |
124+
| -------------- | ----------------- |
125125
| `profile:read` | Read user profile |
126126

127127
## Agent Run scopes
128128

129-
| Scope | Description |
130-
|-------|-------------|
131-
| `agent_runs:read` | Read agent runs |
132-
| `agent_runs:write` | Create and update agent runs |
133-
| `agent_runs.activities:read` | Read agent run activities |
134-
| `agent_runs.activities:write` | Create and update agent run activities |
129+
| Scope | Description |
130+
| ----------------------------- | -------------------------------------- |
131+
| `agent_runs:read` | Read agent runs |
132+
| `agent_runs:write` | Create and update agent runs |
133+
| `agent_runs.activities:read` | Read agent run activities |
134+
| `agent_runs.activities:write` | Create and update agent run activities |

‎docs/dev-tools/build-plane-app/overview.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Follow these steps to build your first Plane app:
5252
### 1. Create an OAuth application
5353

5454
Register your app in Plane to get credentials:
55+
5556
- Navigate to **Workspace Settings** → **Integrations**
5657
- Configure your app's URLs and permissions
5758
- Store your **Client ID** and **Client Secret** securely
@@ -61,6 +62,7 @@ Register your app in Plane to get credentials:
6162
### 2. Choose your authentication flow
6263

6364
Decide between Bot Token or User Token based on your use case:
65+
6466
- **Bot Token** - For agents, webhooks, and automation
6567
- **User Token** - For user-specific actions and permissions
6668

@@ -69,6 +71,7 @@ Decide between Bot Token or User Token based on your use case:
6971
### 3. Implement OAuth
7072

7173
Set up the OAuth flow to obtain access tokens:
74+
7275
- Redirect users to Plane's consent screen
7376
- Handle the callback with authorization code
7477
- Exchange code for access tokens
@@ -79,6 +82,7 @@ Set up the OAuth flow to obtain access tokens:
7982
### 4. Handle webhooks
8083

8184
Set up webhook handlers to receive real-time events:
85+
8286
- Verify webhook signatures for security
8387
- Process events like work item updates, comments, and more
8488
- Respond to events with automated actions
@@ -102,6 +106,7 @@ Free ngrok URLs change on restart. Update your app settings when the URL changes
102106
### Official SDKs
103107

104108
Speed up development with official SDKs for Node.js and Python:
109+
105110
- OAuth helpers for token management
106111
- Typed API clients for all endpoints
107112
- Built-in error handling and retries
@@ -111,6 +116,7 @@ Speed up development with official SDKs for Node.js and Python:
111116
### Complete examples
112117

113118
See full working implementations:
119+
114120
- TypeScript (Express) example
115121
- Python (Flask) example
116122
- OAuth flow, webhooks, and API integration

‎docs/self-hosting/editions-and-versions.md‎

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ description: Compare Plane Community, Pro, Business, and Enterprise editions. Un
44
keywords: plane editions, plane community edition, plane pro, plane enterprise, plane business, self-hosting comparison, plane pricing tiers
55
---
66

7-
87
# Understanding Plane's editions
98

109
Plane comes in four editions by how its deployed. Our Cloud is our only hosted edition as of 2025. Additionally, we offer three unique self-hosted editions tailored to meet two sets of unique needs—the open-source Community Edition, the recommended Commercial Edition, and the Airgapped Edition.
@@ -43,21 +42,20 @@ Built for organizations with strict security and compliance requirements, the Ai
4342

4443
The Airgapped Edition offers:
4544

46-
- **Complete isolation**
47-
Operates entirely within your network perimeter with no external dependencies or outbound connections.
48-
49-
- **Full feature parity**
50-
Includes all features available in the standard Commercial Edition, including advanced work management, security controls, and governance tools
45+
- **Complete isolation**
46+
Operates entirely within your network perimeter with no external dependencies or outbound connections.
5147

52-
- **Version updates**
53-
Updates from your own docker registry.
48+
- **Full feature parity**
49+
Includes all features available in the standard Commercial Edition, including advanced work management, security controls, and governance tools
5450

55-
- **Self-contained architecture**
56-
All services, dependencies, and resources are bundled for deployment in restricted networks
51+
- **Version updates**
52+
Updates from your own docker registry.
5753

58-
- **Compliance-ready**
59-
Designed to meet requirements for environments that prohibit external network communication
54+
- **Self-contained architecture**
55+
All services, dependencies, and resources are bundled for deployment in restricted networks
6056

57+
- **Compliance-ready**
58+
Designed to meet requirements for environments that prohibit external network communication
6159

6260
## Why we separate editions
6361

@@ -83,7 +81,6 @@ Each of our editions is built on a distinct codebase. Versions with each differ
8381

8482
For both the Commercial, Airgapped, and Community Editions, version updates are in your control. Regular updates ensure you’re benefiting from the latest features and improvements. See [Update Plane](/self-hosting/manage/upgrade-plane) for how to upgrade your versions.
8583

86-
8784
## Changelog
8885

89-
We maintain a detailed changelog for all editions. [Check it out](https://plane.so/changelog) and bookmark it to stay informed about the latest features, bug fixes, and improvements by edition.
86+
We maintain a detailed changelog for all editions. [Check it out](https://plane.so/changelog) and bookmark it to stay informed about the latest features, bug fixes, and improvements by edition.

0 commit comments

Comments
 (0)