forked from makeplane/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ce404e4
commit 608177d
Showing
204 changed files
with
3,083 additions
and
1,098 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contribution Guide for Plane Docs | ||
|
||
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. | ||
|
||
### 1. Create a New Issue (if it doesn't exist) | ||
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. | ||
|
||
### 2. Create a New Branch from Master | ||
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. | ||
|
||
```bash | ||
git checkout master | ||
git pull origin master | ||
git checkout -b <branch-name> | ||
``` | ||
|
||
### 3. Make Changes in the Appropriate Page | ||
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. | ||
|
||
### 4. Raise a Pull Request (PR) | ||
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. | ||
|
||
### 5. Leave a Clear Commit Message | ||
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. | ||
|
||
```bash | ||
git add . | ||
git commit -m "Fixes #<issue-number>: Description of the fix or enhancement" | ||
``` | ||
|
||
### 6. Link the Issue to the Pull Request | ||
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. | ||
|
||
### 7. Sign the Contributor License Agreement (CLA) | ||
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. | ||
|
||
### 8. Assign a Reviewer from Our Team | ||
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. | ||
|
||
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Plane Documentation | ||
|
||
Welcome to the documentation repository for Plane! This repository hosts comprehensive documentation for Plane, accessible at [docs.plane.so](https://docs.plane.so). | ||
|
||
## Overview | ||
|
||
The Plane documentation provides detailed information on the following topics: | ||
|
||
- Setting up and managing a self-hosted instance of Plane. | ||
- Understanding the different components of Plane. | ||
- Establishing connections between Plane and other applications. | ||
|
||
## Raising Issues | ||
|
||
If you encounter any issues with our documentation or have suggestions for improvements, we encourage you to follow these steps: | ||
|
||
1. **Check Existing Issues**: Before raising a new issue, please verify if a similar issue already exists. | ||
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. | ||
|
||
## Contributing | ||
|
||
Are you interested in contributing to our documentation? We welcome contributions from the community! You can contribute by: | ||
|
||
- Fixing bugs in the existing documentation. | ||
- Adding new guides or tutorials. | ||
|
||
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. | ||
|
||
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: Add cycle issue | ||
description: Adds an issue in a cycle | ||
api: POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | ||
--- | ||
|
||
### Path parameters | ||
|
||
<ParamField path="slug" type="string" required></ParamField> | ||
|
||
<ParamField path="project_id" type="string" required></ParamField> | ||
|
||
<ParamField path="cycle_id" type="string" required></ParamField> | ||
|
||
### Body | ||
|
||
<ParamField body="issues" type="list" required> | ||
It expects a list of issue ids | ||
</ParamField> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: Delete cycle issue | ||
description: Deletes an issue in a cycle | ||
api: DELETE /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id} | ||
--- | ||
|
||
### Path parameters | ||
|
||
<ParamField path="slug" type="string" required></ParamField> | ||
|
||
<ParamField path="project_id" type="string" required></ParamField> | ||
|
||
<ParamField path="cycle_id" type="string" required></ParamField> | ||
|
||
<ParamField path="issue_id" type="string" required></ParamField> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Get cycle issues | ||
description: Gets all the issues in a cycle | ||
api: GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | ||
--- | ||
|
||
### Path parameters | ||
|
||
<ParamField path="slug" type="string" required></ParamField> | ||
|
||
<ParamField path="project_id" type="string" required></ParamField> | ||
|
||
<ParamField path="cycle_id" type="string" required></ParamField> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: Add cycle | ||
description: Adds a cycle in a project | ||
api: POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | ||
--- | ||
|
||
### Path parameters | ||
|
||
<ParamField path="slug" type="string" required></ParamField> | ||
|
||
<ParamField path="project_id" type="string" required></ParamField> | ||
|
||
### Body | ||
|
||
<ParamField body="name" type="string" required></ParamField> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Delete cycle | ||
description: Deletes a cycle | ||
api: DELETE /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id} | ||
--- | ||
|
||
### Path parameters | ||
|
||
<ParamField path="slug" type="string" required></ParamField> | ||
|
||
<ParamField path="project_id" type="string" required></ParamField> | ||
|
||
<ParamField path="cycle_id" type="string" required></ParamField> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Get cycle details | ||
description: Gets the details of a cycle | ||
api: GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id} | ||
--- | ||
|
||
### Path parameters | ||
|
||
<ParamField path="slug" type="string" required></ParamField> | ||
|
||
<ParamField path="project_id" type="string" required></ParamField> | ||
|
||
<ParamField path="cycle_id" type="string" required></ParamField> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
title: Get cycles | ||
description: Gets all the cycles in a project | ||
api: GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | ||
--- | ||
|
||
### Path parameters | ||
|
||
<ParamField path="slug" type="string" required></ParamField> | ||
|
||
<ParamField path="project_id" type="string" required></ParamField> |
Oops, something went wrong.