forked from github/plane
docs: github integration (#346)
This commit is contained in:
parent
ec4332ea6b
commit
07295ac314
@ -203,6 +203,7 @@ export const navigation = [
|
|||||||
{ title: 'Issues', href: '/issues' },
|
{ title: 'Issues', href: '/issues' },
|
||||||
{ title: 'Cycles', href: '/cycles' },
|
{ title: 'Cycles', href: '/cycles' },
|
||||||
{ title: 'Modules', href: '/modules' },
|
{ title: 'Modules', href: '/modules' },
|
||||||
|
{ title: 'Integrations', href: '/integrations' },
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
]
|
]
|
||||||
|
65
apps/docs/src/pages/integrations.mdx
Normal file
65
apps/docs/src/pages/integrations.mdx
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
import { Note } from '@/components/mdx'
|
||||||
|
|
||||||
|
export const description = 'Integrations'
|
||||||
|
|
||||||
|
export const sections = [{ title: 'GitHub', id: 'github' }]
|
||||||
|
|
||||||
|
# Integrations (Dev Release)
|
||||||
|
|
||||||
|
Plane's integrations make it easy for users to connect their Workspace and
|
||||||
|
projects to popular third-party tools. This enables seamless management of
|
||||||
|
issues and notifications, all from within the Plane platform.
|
||||||
|
|
||||||
|
Rather than
|
||||||
|
having to switch back and forth between different tools and interfaces, users
|
||||||
|
can access and manage their third-party tools directly from within the Plane
|
||||||
|
platform. This streamlines workflows and improves efficiency by providing a
|
||||||
|
centralized hub for all project-related activities.
|
||||||
|
|
||||||
|
## GitHub Sync
|
||||||
|
|
||||||
|
GitHub Sync allows users to connect any GitHub repository to a Plane project,
|
||||||
|
enabling cross-synchronization of issues between Plane and GitHub in both
|
||||||
|
directions.
|
||||||
|
|
||||||
|
By connecting a GitHub repository to a Plane project, users can easily track
|
||||||
|
issues and changes in both platforms. This allows for a more streamlined
|
||||||
|
workflow, as users can manage their GitHub issues and pull requests from
|
||||||
|
within the Plane platform.
|
||||||
|
|
||||||
|
The bi-directional synchronization means that changes made in either platform
|
||||||
|
will be reflected in the other. For example, if a user creates a new issue in
|
||||||
|
Plane, it will automatically be synced with the corresponding repository in
|
||||||
|
GitHub. Similarly, if a user closes an issue in GitHub, it will be reflected
|
||||||
|
in Plane as well.
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
Plane is still in development stage, in case if there are any hiccups in
|
||||||
|
Integrations, do report us on our [Discord]() or [Github]().
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
## Plane + GitHub Sync Attribute Overivew
|
||||||
|
|
||||||
|
![Connect workspace](https://ik.imagekit.io/rdws4iz4v/Plane_Arch__1_.png?ik-sdk-version=javascript-1.4.3&updatedAt=1677529077471)
|
||||||
|
|
||||||
|
## Configuring GitHub Integration
|
||||||
|
|
||||||
|
**Step One: Add GitHub Integration to your workspace**
|
||||||
|
|
||||||
|
![Connect workspace](https://ik.imagekit.io/rdws4iz4v/ezgif-2-c71e43f5de.gif?ik-sdk-version=javascript-1.4.3&updatedAt=1677526036094)
|
||||||
|
|
||||||
|
**Step Two: Connect GitHub repository with project**
|
||||||
|
|
||||||
|
![Connect repo to project](https://ik.imagekit.io/rdws4iz4v/ezgif-2-cea843f5f8.gif?ik-sdk-version=javascript-1.4.3&updatedAt=1677526558466)
|
||||||
|
|
||||||
|
**Step Three: Create new or use existing issue on Plane**
|
||||||
|
|
||||||
|
![Issue on Plane](https://ik.imagekit.io/rdws4iz4v/ezgif-5-71aa60e87f.gif?ik-sdk-version=javascript-1.4.3&updatedAt=1677527704371)
|
||||||
|
|
||||||
|
**Step Four: Add GitHub label to Plane issue (Plane to GitHub)**
|
||||||
|
|
||||||
|
![GitHub label on Plane issue](https://ik.imagekit.io/rdws4iz4v/ezgif-5-58a5ac3b67.gif?ik-sdk-version=javascript-1.4.3&updatedAt=1677527944556)
|
||||||
|
|
||||||
|
**Step Five: Add Plane label to GitHub issue (GitHub to Plane)**
|
||||||
|
|
||||||
|
![Plane label on GitHub issue](https://ik.imagekit.io/rdws4iz4v/ezgif-5-ccce270df6.gif?ik-sdk-version=javascript-1.4.3&updatedAt=1677528064644)
|
Loading…
Reference in New Issue
Block a user