Skip to content

Commit 608177d

Browse files
fix: v2 migration fixes
1 parent ce404e4 commit 608177d

File tree

204 files changed

+3083
-1098
lines changed

Some content is hidden

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

204 files changed

+3083
-1098
lines changed

.env.example

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

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contribution Guide for Plane Docs
2+
3+
Thank you for considering contributing to Plane docs! Your contributions help improve the quality and accessibility of our documentation for all users. Please follow the guidelines outlined below to ensure a smooth contribution process.
4+
5+
### 1. Create a New Issue (if it doesn't exist)
6+
If you encounter a problem or wish to suggest an improvement in the documentation that hasn't been addressed yet, please create a new issue. Be sure to check existing issues to avoid duplication. Include a clear description of the problem or enhancement you're suggesting.
7+
8+
### 2. Create a New Branch from Master
9+
Before making any changes, create a new branch from the `master` branch. This branch will contain your proposed changes and keep the `master` branch clean for stable releases.
10+
11+
```bash
12+
git checkout master
13+
git pull origin master
14+
git checkout -b <branch-name>
15+
```
16+
17+
### 3. Make Changes in the Appropriate Page
18+
Navigate to the relevant documentation page in the repository and make your changes. Ensure that your changes align with our style guide and maintain consistency across the documentation.
19+
20+
### 4. Raise a Pull Request (PR)
21+
Once your changes are ready, raise a pull request (PR) to merge your branch into the `master` branch. Please provide a descriptive title and detailed description of your changes.
22+
23+
### 5. Leave a Clear Commit Message
24+
When committing your changes, leave a clear and concise message that links to the corresponding issue (if applicable) and explains the fix or enhancement you've made.
25+
26+
```bash
27+
git add .
28+
git commit -m "Fixes #<issue-number>: Description of the fix or enhancement"
29+
```
30+
31+
### 6. Link the Issue to the Pull Request
32+
In your pull request description, be sure to reference the related issue using GitHub's syntax (`#<issue-number>`). This links the PR to the issue and helps maintain context.
33+
34+
### 7. Sign the Contributor License Agreement (CLA)
35+
Before we can merge your contribution, you must sign our contributor license agreement (CLA). This agreement ensures that your contributions comply with our licensing terms.
36+
37+
### 8. Assign a Reviewer from Our Team
38+
Once your PR is submitted, a member of our team will be assigned to review your changes. They will provide feedback and may request revisions if necessary. Please respond promptly to any review comments to expedite the merging process.
39+
40+
Thank you for contributing to our documentation! We appreciate your efforts in making our product documentation more comprehensive and user-friendly. If you have any questions or need assistance, feel free to reach out to our team. Happy contributing!

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Plane Documentation
2+
3+
Welcome to the documentation repository for Plane! This repository hosts comprehensive documentation for Plane, accessible at [docs.plane.so](https://docs.plane.so).
4+
5+
## Overview
6+
7+
The Plane documentation provides detailed information on the following topics:
8+
9+
- Setting up and managing a self-hosted instance of Plane.
10+
- Understanding the different components of Plane.
11+
- Establishing connections between Plane and other applications.
12+
13+
## Raising Issues
14+
15+
If you encounter any issues with our documentation or have suggestions for improvements, we encourage you to follow these steps:
16+
17+
1. **Check Existing Issues**: Before raising a new issue, please verify if a similar issue already exists.
18+
2. **Raise an Issue**: If you don't find an existing issue that matches your concern, feel free to create a new one. Provide as much detail as possible to clearly explain the problem or enhancement you're proposing.
19+
20+
## Contributing
21+
22+
Are you interested in contributing to our documentation? We welcome contributions from the community! You can contribute by:
23+
24+
- Fixing bugs in the existing documentation.
25+
- Adding new guides or tutorials.
26+
27+
To get started with contributing, please refer to our [Contribution Guide](/CONTRIBUTING.md). We appreciate contributions related to self-hosting, core product functionality, and integrations with other applications.
28+
29+
Thank you for considering contributing to Plane documentation. Your contributions help improve the overall user experience and make information more accessible to all users. Let's work together to make Plane documentation even better!
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Add cycle issue
3+
description: Adds an issue in a cycle
4+
api: POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="slug" type="string" required></ParamField>
10+
11+
<ParamField path="project_id" type="string" required></ParamField>
12+
13+
<ParamField path="cycle_id" type="string" required></ParamField>
14+
15+
### Body
16+
17+
<ParamField body="issues" type="list" required>
18+
It expects a list of issue ids
19+
</ParamField>
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Delete cycle issue
3+
description: Deletes an issue in a cycle
4+
api: DELETE /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="slug" type="string" required></ParamField>
10+
11+
<ParamField path="project_id" type="string" required></ParamField>
12+
13+
<ParamField path="cycle_id" type="string" required></ParamField>
14+
15+
<ParamField path="issue_id" type="string" required></ParamField>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Get cycle issues
3+
description: Gets all the issues in a cycle
4+
api: GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="slug" type="string" required></ParamField>
10+
11+
<ParamField path="project_id" type="string" required></ParamField>
12+
13+
<ParamField path="cycle_id" type="string" required></ParamField>
Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2-
title: Cycle Issue
2+
title: Overview
33
---
4-
It contains all the list of issues which are inside in a cycle.
4+
5+
It contains all the list of issues which are inside a cycle.
6+
57
```http
68
POST /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
79
GET /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
810
DELETE /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/:issue_id/
911
```
1012

1113
For creating a cycle issue, the payload should be sent in the below format.
14+
1215
```
1316
{
1417
"issues": ["d7a45e13-be2a-4942-aa15-b82c2cf244d0","d23wefadf-dafADfadfadfqeqerqer"]
@@ -19,38 +22,38 @@ For creating a cycle issue, the payload should be sent in the below format.
1922

2023
**Attributes**
2124

22-
* `sub_issues_count`
23-
24-
It tells the count of sub issues of the issue
25-
26-
* `created_at` _timestamp_
27-
28-
The timestamp of the time when the project was created
29-
30-
* `updated_at` _timestamp_
31-
32-
The timestamp of the time when the project was last updated
33-
34-
* `created_by` , `updated_by` _uuid_
35-
36-
These values are auto saved and represent the id of the user that created or updated the module
37-
38-
* `Project` uuid
39-
40-
It contains projects uuid which is automatically saved.
41-
42-
* `Workspace` uuid
43-
44-
It contains workspace uuid which is automatically saved
45-
46-
* `cycle` uuid
47-
48-
Cycle id of which the issue belongs to
49-
50-
* `issue` uuid
51-
52-
Issue id of the issue
53-
25+
- `sub_issues_count`
26+
27+
It tells the count of sub issues of the issue
28+
29+
- `created_at` _timestamp_
30+
31+
The timestamp of the time when the project was created
32+
33+
- `updated_at` _timestamp_
34+
35+
The timestamp of the time when the project was last updated
36+
37+
- `created_by` , `updated_by` _uuid_
38+
39+
These values are auto saved and represent the id of the user that created or updated the module
40+
41+
- `Project` uuid
42+
43+
It contains projects uuid which is automatically saved.
44+
45+
- `Workspace` uuid
46+
47+
It contains workspace uuid which is automatically saved
48+
49+
- `cycle` uuid
50+
51+
Cycle id of which the issue belongs to
52+
53+
- `issue` uuid
54+
55+
Issue id of the issue
56+
5457
<ResponseExample>
5558
```json JSON
5659
[
@@ -67,7 +70,5 @@ For creating a cycle issue, the payload should be sent in the below format.
6770
"issue": "2f9f16f7-604c-43d3-adb1-5466ade808aa"
6871
}
6972
]
70-
7173
```
7274
</ResponseExample>
73-

api-reference/cycle/add-cycle.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Add cycle
3+
description: Adds a cycle in a project
4+
api: POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="slug" type="string" required></ParamField>
10+
11+
<ParamField path="project_id" type="string" required></ParamField>
12+
13+
### Body
14+
15+
<ParamField body="name" type="string" required></ParamField>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Delete cycle
3+
description: Deletes a cycle
4+
api: DELETE /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="slug" type="string" required></ParamField>
10+
11+
<ParamField path="project_id" type="string" required></ParamField>
12+
13+
<ParamField path="cycle_id" type="string" required></ParamField>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Get cycle details
3+
description: Gets the details of a cycle
4+
api: GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="slug" type="string" required></ParamField>
10+
11+
<ParamField path="project_id" type="string" required></ParamField>
12+
13+
<ParamField path="cycle_id" type="string" required></ParamField>

0 commit comments

Comments
 (0)