From 45504db74b3b830eae1825952149486f2cbbf02b Mon Sep 17 00:00:00 2001 From: sriramveeraghanta Date: Fri, 30 Jan 2026 16:41:17 +0530 Subject: [PATCH 1/5] docs: updat md formating using prettier --- .prettierrc | 4 + CONTRIBUTING.md | 28 +- docs/.vitepress/config.mts | 255 +-- docs/.vitepress/theme/components/ApiParam.vue | 17 +- docs/.vitepress/theme/components/Card.vue | 33 +- .../.vitepress/theme/components/CardGroup.vue | 8 +- .../.vitepress/theme/components/CodePanel.vue | 47 +- .../theme/components/ResponsePanel.vue | 50 +- docs/.vitepress/theme/index.ts | 129 +- docs/.vitepress/theme/style.css | 70 +- .../customer/add-customer-property.md | 52 +- .../customer/add-customer-request.md | 26 +- docs/api-reference/customer/add-customer.md | 26 +- .../customer/delete-customer-property.md | 16 +- .../customer/delete-customer-request.md | 11 +- .../api-reference/customer/delete-customer.md | 16 +- .../customer/get-customer-detail.md | 16 +- .../customer/get-customer-property-detail.md | 16 +- .../customer/get-customer-property-value.md | 11 +- .../customer/get-customer-request-detail.md | 11 +- .../customer/link-work-items-to-customer.md | 15 +- .../customer/list-customer-properties.md | 16 +- .../customer/list-customer-property-values.md | 11 +- .../customer/list-customer-requests.md | 16 +- .../customer/list-customer-work-items.md | 11 +- docs/api-reference/customer/list-customers.md | 16 +- docs/api-reference/customer/overview.md | 15 +- .../unlink-work-item-from-customer.md | 11 +- .../customer/update-customer-detail.md | 26 +- .../update-customer-property-detail.md | 52 +- .../update-customer-property-value.md | 15 +- .../update-customer-request-detail.md | 17 +- .../cycle/add-cycle-work-items.md | 15 +- docs/api-reference/cycle/add-cycle.md | 40 +- docs/api-reference/cycle/archive-cycle.md | 11 +- docs/api-reference/cycle/delete-cycle.md | 11 +- docs/api-reference/cycle/get-cycle-detail.md | 11 +- .../cycle/list-archived-cycles.md | 11 +- .../cycle/list-cycle-work-items.md | 11 +- docs/api-reference/cycle/list-cycles.md | 16 +- docs/api-reference/cycle/overview.md | 31 +- .../cycle/remove-cycle-work-item.md | 11 +- .../cycle/transfer-cycle-work-items.md | 15 +- docs/api-reference/cycle/unarchive-cycle.md | 11 +- .../cycle/update-cycle-detail.md | 29 +- docs/api-reference/epics/get-epic-detail.md | 11 +- docs/api-reference/epics/list-epics.md | 16 +- docs/api-reference/epics/overview.md | 69 +- .../inbox-issue/add-inbox-issue.md | 19 +- .../inbox-issue/delete-inbox-issue.md | 19 +- .../inbox-issue/get-inbox-issue-detail.md | 17 +- .../inbox-issue/list-inbox-issues.md | 15 +- docs/api-reference/inbox-issue/overview.md | 28 +- .../inbox-issue/update-inbox-issue-detail.md | 21 +- .../initiative/add-epics-to-initiative.md | 24 +- .../initiative/add-initiative-label.md | 30 +- .../initiative/add-initiative.md | 42 +- .../initiative/add-labels-to-initiative.md | 15 +- .../initiative/add-projects-to-initiative.md | 15 +- .../initiative/delete-initiative-label.md | 16 +- .../initiative/delete-initiative.md | 16 +- .../initiative/get-initiative-detail.md | 16 +- .../initiative/get-initiative-label-detail.md | 16 +- .../initiative/list-initiative-epics.md | 16 +- .../list-initiative-labels-for-initiative.md | 11 +- .../initiative/list-initiative-labels.md | 16 +- .../initiative/list-initiative-projects.md | 11 +- .../initiative/list-initiatives.md | 16 +- docs/api-reference/initiative/overview.md | 25 +- .../remove-epics-from-initiative.md | 16 +- .../remove-labels-from-initiative.md | 11 +- .../remove-projects-from-initiative.md | 11 +- .../initiative/update-initiative-detail.md | 42 +- .../update-initiative-label-detail.md | 30 +- .../intake-issue/add-intake-issue.md | 15 +- .../intake-issue/delete-intake-issue.md | 11 +- .../intake-issue/get-intake-issue-detail.md | 11 +- .../intake-issue/list-intake-issues.md | 11 +- docs/api-reference/intake-issue/overview.md | 29 +- .../update-intake-issue-detail.md | 15 +- docs/api-reference/introduction.md | 31 +- .../get-issue-activity-detail.md | 11 +- .../issue-activity/list-issue-activities.md | 11 +- docs/api-reference/issue-activity/overview.md | 37 +- .../issue-attachments/complete-upload.md | 11 +- .../issue-attachments/delete-attachment.md | 11 +- .../get-attachment-detail.md | 11 +- .../issue-attachments/get-attachments.md | 11 +- .../get-upload-credentials.md | 23 +- .../issue-attachments/overview.md | 195 ++- .../issue-attachments/update-attachment.md | 35 +- .../issue-attachments/upload-file.md | 38 +- .../issue-comment/add-issue-comment.md | 23 +- .../issue-comment/delete-issue-comment.md | 11 +- .../issue-comment/get-issue-comment-detail.md | 11 +- .../issue-comment/list-issue-comments.md | 11 +- docs/api-reference/issue-comment/overview.md | 32 +- .../update-issue-comment-detail.md | 23 +- .../options/add-dropdown-options.md | 25 +- .../options/delete-dropdown-options.md | 11 +- .../issue-types/options/get-option-details.md | 11 +- .../options/list-dropdown-options.md | 11 +- .../issue-types/options/overview.md | 3 +- .../options/update-dropdown-options.md | 25 +- .../issue-types/properties/add-property.md | 30 +- .../issue-types/properties/delete-property.md | 11 +- .../properties/get-property-details.md | 11 +- .../issue-types/properties/list-properties.md | 11 +- .../issue-types/properties/overview.md | 4 +- .../issue-types/properties/update-property.md | 27 +- .../issue-types/types/add-issue-type.md | 27 +- .../issue-types/types/delete-issue-type.md | 11 +- .../types/get-issue-type-details.md | 11 +- .../issue-types/types/list-issue-types.md | 11 +- .../issue-types/types/overview.md | 37 +- .../issue-types/types/update-issue-types.md | 27 +- .../issue-types/values/add-property-values.md | 18 +- .../values/list-property-values.md | 11 +- .../issue-types/values/overview.md | 4 +- docs/api-reference/issue/add-issue.md | 46 +- docs/api-reference/issue/delete-issue.md | 11 +- docs/api-reference/issue/get-issue-detail.md | 11 +- .../issue/get-issue-sequence-id.md | 16 +- docs/api-reference/issue/list-issues.md | 16 +- docs/api-reference/issue/overview.md | 154 +- docs/api-reference/issue/search-issues.md | 16 +- .../issue/update-issue-detail.md | 37 +- docs/api-reference/label/add-label.md | 24 +- docs/api-reference/label/delete-label.md | 11 +- docs/api-reference/label/get-label-detail.md | 11 +- docs/api-reference/label/list-labels.md | 16 +- docs/api-reference/label/overview.md | 27 +- .../label/update-label-detail.md | 15 +- docs/api-reference/link/add-link.md | 17 +- docs/api-reference/link/delete-link.md | 11 +- docs/api-reference/link/get-link-detail.md | 11 +- docs/api-reference/link/list-links.md | 11 +- docs/api-reference/link/overview.md | 25 +- docs/api-reference/link/update-link-detail.md | 17 +- .../members/get-project-members.md | 16 +- .../members/get-workspace-members.md | 16 +- docs/api-reference/members/overview.md | 54 +- .../module/add-module-work-items.md | 15 +- docs/api-reference/module/add-module.md | 40 +- docs/api-reference/module/archive-module.md | 11 +- docs/api-reference/module/delete-module.md | 11 +- .../api-reference/module/get-module-detail.md | 11 +- .../module/list-archived-modules.md | 11 +- .../module/list-module-work-items.md | 11 +- docs/api-reference/module/list-modules.md | 16 +- docs/api-reference/module/overview.md | 40 +- .../module/remove-module-work-item.md | 11 +- docs/api-reference/module/unarchive-module.md | 11 +- .../module/update-module-detail.md | 31 +- docs/api-reference/page/add-project-page.md | 26 +- docs/api-reference/page/add-workspace-page.md | 26 +- docs/api-reference/page/get-project-page.md | 11 +- docs/api-reference/page/get-workspace-page.md | 16 +- docs/api-reference/page/overview.md | 17 +- docs/api-reference/project/add-project.md | 28 +- docs/api-reference/project/delete-project.md | 16 +- .../project/get-project-detail.md | 16 +- docs/api-reference/project/list-projects.md | 16 +- docs/api-reference/project/overview.md | 7 +- .../project/update-project-detail.md | 26 +- docs/api-reference/state/add-state.md | 26 +- docs/api-reference/state/delete-state.md | 11 +- docs/api-reference/state/get-state-detail.md | 11 +- docs/api-reference/state/list-states.md | 16 +- docs/api-reference/state/overview.md | 32 +- .../state/update-state-detail.md | 15 +- docs/api-reference/sticky/add-sticky.md | 32 +- docs/api-reference/sticky/delete-sticky.md | 16 +- .../api-reference/sticky/get-sticky-detail.md | 16 +- docs/api-reference/sticky/list-stickies.md | 16 +- docs/api-reference/sticky/overview.md | 25 +- .../sticky/update-sticky-detail.md | 32 +- .../teamspace/add-projects-to-teamspace.md | 19 +- .../teamspace/add-teamspace-members.md | 24 +- docs/api-reference/teamspace/add-teamspace.md | 36 +- .../teamspace/delete-teamspace.md | 16 +- .../teamspace/get-teamspace-detail.md | 16 +- .../teamspace/list-teamspace-members.md | 16 +- .../teamspace/list-teamspace-projects.md | 15 +- .../teamspace/list-teamspaces.md | 16 +- docs/api-reference/teamspace/overview.md | 17 +- .../remove-projects-from-teamspace.md | 11 +- .../teamspace/remove-teamspace-members.md | 16 +- .../teamspace/update-teamspace-detail.md | 36 +- docs/api-reference/user/get-current-user.md | 16 +- docs/api-reference/user/overview.md | 17 +- docs/api-reference/worklogs/create-worklog.md | 17 +- docs/api-reference/worklogs/delete-worklog.md | 11 +- docs/api-reference/worklogs/get-total-time.md | 11 +- .../worklogs/get-worklogs-for-issue.md | 11 +- docs/api-reference/worklogs/overview.md | 69 +- docs/api-reference/worklogs/update-worklog.md | 17 +- docs/dev-tools/build-plane-app.md | 232 ++- docs/dev-tools/intro-webhooks.md | 28 +- docs/dev-tools/mcp-server.md | 26 +- docs/index.md | 5 +- .../governance/authentication/custom-sso.md | 52 +- .../governance/workspaces-and-teams.md | 4 +- docs/plane-one/introduction.md | 5 +- docs/plane-one/manage/advanced-deploy.md | 2 - docs/plane-one/manage/prime-cli.md | 61 +- docs/plane-one/manage/prime-client.md | 3 +- docs/plane-one/self-host/guides.md | 2 - docs/plane-one/self-host/methods/docker.md | 96 +- .../plane-one/self-host/methods/kubernetes.md | 366 ++-- docs/plane-one/self-host/overview.md | 5 +- docs/self-hosting/editions-and-versions.md | 25 +- docs/self-hosting/govern/advanced-search.md | 169 +- docs/self-hosting/govern/authentication.md | 3 +- docs/self-hosting/govern/communication.md | 5 +- .../govern/configure-dns-email-service.md | 215 +-- docs/self-hosting/govern/configure-ssl.md | 12 +- docs/self-hosting/govern/custom-domain.md | 64 +- .../govern/database-and-storage.md | 131 +- .../govern/environment-variables.md | 320 ++-- docs/self-hosting/govern/external-secrets.md | 259 +-- docs/self-hosting/govern/github-oauth.md | 3 +- docs/self-hosting/govern/google-oauth.md | 7 +- docs/self-hosting/govern/instance-admin.md | 97 +- .../govern/integrations/github.md | 92 +- .../govern/integrations/gitlab.md | 68 +- .../govern/integrations/sentry.md | 79 +- .../self-hosting/govern/integrations/slack.md | 292 ++-- docs/self-hosting/govern/ldap.md | 165 +- docs/self-hosting/govern/oidc-sso.md | 19 +- docs/self-hosting/govern/private-bucket.md | 85 +- docs/self-hosting/govern/reset-password.md | 28 +- docs/self-hosting/govern/reverse-proxy.md | 62 +- docs/self-hosting/govern/saml-sso.md | 36 +- docs/self-hosting/manage/backup-restore.md | 83 +- .../manage/community-to-airgapped.md | 67 +- .../manage-licenses/activate-airgapped.md | 7 +- .../manage-licenses/activate-enterprise.md | 3 +- .../activate-pro-and-business.md | 17 +- docs/self-hosting/manage/migrate-plane.md | 47 +- docs/self-hosting/manage/prime-cli.md | 65 +- .../manage/upgrade-from-0.13.2-0.14.0.md | 60 +- docs/self-hosting/manage/upgrade-plane.md | 19 +- docs/self-hosting/manage/view-logs.md | 14 +- .../methods/airgapped-edition-kubernetes.md | 465 +++--- .../self-hosting/methods/airgapped-edition.md | 184 ++- .../methods/airgapped-requirements.md | 14 +- .../methods/clone-docker-images.md | 29 +- docs/self-hosting/methods/coolify.md | 22 +- docs/self-hosting/methods/docker-aio.md | 134 +- docs/self-hosting/methods/docker-compose.md | 228 +-- docs/self-hosting/methods/docker-swarm.md | 74 +- docs/self-hosting/methods/kubernetes.md | 1470 ++++++++--------- docs/self-hosting/methods/one-click.md | 21 +- docs/self-hosting/methods/overview.md | 2 +- docs/self-hosting/methods/podman-quadlets.md | 120 +- docs/self-hosting/methods/portainer.md | 57 +- docs/self-hosting/overview.md | 6 +- docs/self-hosting/plane-architecture.md | 3 +- docs/self-hosting/telemetry.md | 63 +- docs/self-hosting/troubleshoot/cli-errors.md | 13 +- .../troubleshoot/installation-errors.md | 3 +- .../troubleshoot/license-errors.md | 6 +- .../troubleshoot/storage-errors.md | 89 +- docs/self-hosting/upgrade-from-community.md | 125 +- package.json | 4 +- pnpm-lock.yaml | 882 ++++++---- postcss.config.js | 2 +- 268 files changed, 6026 insertions(+), 6024 deletions(-) create mode 100644 .prettierrc diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 00000000..3f584f60 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,4 @@ +{ + "printWidth": 120, + "singleQuote": true +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14befd0e..aeccf53d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,17 +12,20 @@ Thank you for your interest in contributing to Plane's developer documentation. ### Local Setup 1. Fork and clone the repository: + ```bash git clone https://github.com/makeplane/developer-docs.git cd developer-docs ``` 2. Install dependencies: + ```bash pnpm install ``` 3. Start the development server: + ```bash pnpm dev ``` @@ -33,20 +36,20 @@ Thank you for your interest in contributing to Plane's developer documentation. ### Content Directories -| Directory | Purpose | -|-----------|---------| -| `docs/api-reference/` | REST API endpoint documentation | -| `docs/self-hosting/` | Deployment and configuration guides | -| `docs/dev-tools/` | Developer tools, webhooks, and extensions | -| `docs/plane-one/` | Plane One (licensed edition) documentation | +| Directory | Purpose | +| --------------------- | ------------------------------------------ | +| `docs/api-reference/` | REST API endpoint documentation | +| `docs/self-hosting/` | Deployment and configuration guides | +| `docs/dev-tools/` | Developer tools, webhooks, and extensions | +| `docs/plane-one/` | Plane One (licensed edition) documentation | ### Configuration Files -| File | Purpose | -|------|---------| -| `docs/.vitepress/config.mts` | Navigation, sidebar, and site settings | -| `docs/.vitepress/theme/style.css` | Global CSS styles | -| `docs/.vitepress/theme/components/` | Custom Vue components | +| File | Purpose | +| ----------------------------------- | -------------------------------------- | +| `docs/.vitepress/config.mts` | Navigation, sidebar, and site settings | +| `docs/.vitepress/theme/style.css` | Global CSS styles | +| `docs/.vitepress/theme/components/` | Custom Vue components | ## Writing Documentation @@ -88,6 +91,7 @@ Place images in `docs/.vitepress/public/images/` and reference them with absolut ### Branch Naming Use descriptive branch names: + - `docs/add-webhook-guide` - `fix/typo-in-api-reference` - `update/kubernetes-deployment` @@ -95,6 +99,7 @@ Use descriptive branch names: ### Commit Messages Write clear, concise commit messages: + - `Add webhook payload examples` - `Fix broken link in self-hosting guide` - `Update Docker Compose instructions for v1.0` @@ -141,6 +146,7 @@ response = requests.get( ### API Documentation When documenting API endpoints: + - Include the HTTP method and path - List all parameters with types and descriptions - Show request and response examples diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index fbf2b297..2df12a9c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,23 +1,24 @@ -import { defineConfig } from 'vitepress' -import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs' +import { defineConfig } from 'vitepress'; +import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'; export default defineConfig({ vite: { optimizeDeps: { - include: ['lucide-vue-next'] - } + include: ['lucide-vue-next'], + }, }, markdown: { config(md) { - md.use(tabsMarkdownPlugin) - } + md.use(tabsMarkdownPlugin); + }, }, title: 'Plane developer documentation', - description: 'Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform. Complete guides for developers building on Plane.', + description: + 'Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform. Complete guides for developers building on Plane.', // SEO: Generate sitemap automatically sitemap: { - hostname: 'https://developers.plane.so' + hostname: 'https://developers.plane.so', }, // SEO: Clean URLs without .html extension @@ -33,7 +34,14 @@ export default defineConfig({ ['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1.0' }], ['meta', { name: 'author', content: 'Plane' }], ['meta', { name: 'robots', content: 'index, follow' }], - ['meta', { name: 'keywords', content: 'plane, api, self-hosting, project management, developer documentation, kubernetes, docker, rest api, webhooks, plane api' }], + [ + 'meta', + { + name: 'keywords', + content: + 'plane, api, self-hosting, project management, developer documentation, kubernetes, docker, rest api, webhooks, plane api', + }, + ], ['meta', { name: 'theme-color', content: '#3b82f6' }], // SEO: Canonical URL @@ -42,14 +50,28 @@ export default defineConfig({ // Open Graph meta tags ['meta', { property: 'og:type', content: 'website' }], ['meta', { property: 'og:title', content: 'Developer documentation | Plane' }], - ['meta', { property: 'og:description', content: 'Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform.' }], + [ + 'meta', + { + property: 'og:description', + content: + 'Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform.', + }, + ], ['meta', { property: 'og:image', content: 'https://media.docs.plane.so/logo/og-docs.webp' }], ['meta', { property: 'og:url', content: 'https://developers.plane.so' }], // Twitter Card meta tags ['meta', { name: 'twitter:card', content: 'summary_large_image' }], ['meta', { name: 'twitter:title', content: 'Developer documentation | Plane' }], - ['meta', { name: 'twitter:description', content: 'Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform.' }], + [ + 'meta', + { + name: 'twitter:description', + content: + 'Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform.', + }, + ], ['meta', { name: 'twitter:image', content: 'https://media.docs.plane.so/logo/og-docs.webp' }], ], @@ -57,12 +79,12 @@ export default defineConfig({ siteTitle: false, logo: { light: '/logo/dev-logo-watermark-light.png', - dark: '/logo/dev-logo-watermark-dark.png' + dark: '/logo/dev-logo-watermark-dark.png', }, outline: { level: [2, 3], - label: 'On this page' + label: 'On this page', }, nav: [ @@ -70,7 +92,7 @@ export default defineConfig({ { text: 'API Reference', link: '/api-reference/introduction' }, { text: 'Build and extend', link: '/dev-tools/build-plane-app' }, { text: 'Plane Docs', link: 'https://docs.plane.so' }, - { text: 'Sign in', link: 'https://app.plane.so/sign-in' } + { text: 'Sign in', link: 'https://app.plane.so/sign-in' }, ], sidebar: { @@ -80,8 +102,8 @@ export default defineConfig({ items: [ { text: 'Overview', link: '/self-hosting/overview' }, { text: 'Plane Editions', link: '/self-hosting/editions-and-versions' }, - { text: 'Plane Architecture', link: '/self-hosting/plane-architecture' } - ] + { text: 'Plane Architecture', link: '/self-hosting/plane-architecture' }, + ], }, { text: 'Install', @@ -93,8 +115,8 @@ export default defineConfig({ items: [ { text: 'Docker Compose', link: '/self-hosting/methods/docker-compose' }, { text: 'Docker AIO', link: '/self-hosting/methods/docker-aio' }, - { text: 'Docker Swarm', link: '/self-hosting/methods/docker-swarm' } - ] + { text: 'Docker Swarm', link: '/self-hosting/methods/docker-swarm' }, + ], }, { text: 'Kubernetes', link: '/self-hosting/methods/kubernetes' }, { text: 'Podman Quadlets', link: '/self-hosting/methods/podman-quadlets' }, @@ -105,18 +127,18 @@ export default defineConfig({ { text: 'Overview', link: '/self-hosting/methods/airgapped-requirements' }, { text: 'For Docker', link: '/self-hosting/methods/airgapped-edition' }, { text: 'For Kubernetes', link: '/self-hosting/methods/airgapped-edition-kubernetes' }, - { text: 'Clone Docker Images', link: '/self-hosting/methods/clone-docker-images' } - ] + { text: 'Clone Docker Images', link: '/self-hosting/methods/clone-docker-images' }, + ], }, { text: 'Managed Platforms', collapsed: true, items: [ { text: 'Coolify', link: '/self-hosting/methods/coolify' }, - { text: 'Portainer', link: '/self-hosting/methods/portainer' } - ] - } - ] + { text: 'Portainer', link: '/self-hosting/methods/portainer' }, + ], + }, + ], }, { text: 'Configure', @@ -132,8 +154,8 @@ export default defineConfig({ { text: 'OIDC SSO', link: '/self-hosting/govern/oidc-sso' }, { text: 'SAML SSO', link: '/self-hosting/govern/saml-sso' }, { text: 'LDAP', link: '/self-hosting/govern/ldap' }, - { text: 'Reset Password', link: '/self-hosting/govern/reset-password' } - ] + { text: 'Reset Password', link: '/self-hosting/govern/reset-password' }, + ], }, { text: 'SMTP for email', link: '/self-hosting/govern/communication' }, { text: 'External services', link: '/self-hosting/govern/database-and-storage' }, @@ -146,8 +168,8 @@ export default defineConfig({ { text: 'GitHub', link: '/self-hosting/govern/integrations/github' }, { text: 'GitLab', link: '/self-hosting/govern/integrations/gitlab' }, { text: 'Sentry', link: '/self-hosting/govern/integrations/sentry' }, - { text: 'Slack', link: '/self-hosting/govern/integrations/slack' } - ] + { text: 'Slack', link: '/self-hosting/govern/integrations/slack' }, + ], }, { text: 'DNS for Intake Email', link: '/self-hosting/govern/configure-dns-email-service' }, { text: 'OpenSearch for search', link: '/self-hosting/govern/advanced-search' }, @@ -155,8 +177,8 @@ export default defineConfig({ { text: 'External reverse proxy', link: '/self-hosting/govern/reverse-proxy' }, { text: 'Private storage buckets', link: '/self-hosting/govern/private-bucket' }, { text: 'Environment variables', link: '/self-hosting/govern/environment-variables' }, - { text: 'Telemetry', link: '/self-hosting/telemetry' } - ] + { text: 'Telemetry', link: '/self-hosting/telemetry' }, + ], }, { text: 'Manage', @@ -166,25 +188,28 @@ export default defineConfig({ collapsed: true, items: [ { text: 'Update to latest version', link: '/self-hosting/manage/upgrade-plane' }, - { text: 'For versions before 0.14.0', link: '/self-hosting/manage/upgrade-from-0.13.2-0.14.0' } - ] + { text: 'For versions before 0.14.0', link: '/self-hosting/manage/upgrade-from-0.13.2-0.14.0' }, + ], }, { text: 'Manage licenses', collapsed: true, items: [ - { text: 'Activate Pro or Business', link: '/self-hosting/manage/manage-licenses/activate-pro-and-business' }, + { + text: 'Activate Pro or Business', + link: '/self-hosting/manage/manage-licenses/activate-pro-and-business', + }, { text: 'Activate Enterprise', link: '/self-hosting/manage/manage-licenses/activate-enterprise' }, - { text: 'Activate Airgapped', link: '/self-hosting/manage/manage-licenses/activate-airgapped' } - ] + { text: 'Activate Airgapped', link: '/self-hosting/manage/manage-licenses/activate-airgapped' }, + ], }, { text: 'Backup and restore', link: '/self-hosting/manage/backup-restore' }, { text: 'Upgrade Community to Commercial Edition', link: '/self-hosting/upgrade-from-community' }, { text: 'Upgrade Community to Airgapped Edition', link: '/self-hosting/manage/community-to-airgapped' }, { text: 'View Logs', link: '/self-hosting/manage/view-logs' }, { text: 'Migrate Plane', link: '/self-hosting/manage/migrate-plane' }, - { text: 'Prime CLI', link: '/self-hosting/manage/prime-cli' } - ] + { text: 'Prime CLI', link: '/self-hosting/manage/prime-cli' }, + ], }, { text: 'Troubleshoot', @@ -192,9 +217,9 @@ export default defineConfig({ { text: 'Installation Errors', link: '/self-hosting/troubleshoot/installation-errors' }, { text: 'License Errors', link: '/self-hosting/troubleshoot/license-errors' }, { text: 'CLI Errors', link: '/self-hosting/troubleshoot/cli-errors' }, - { text: 'Storage Errors', link: '/self-hosting/troubleshoot/storage-errors' } - ] - } + { text: 'Storage Errors', link: '/self-hosting/troubleshoot/storage-errors' }, + ], + }, ], '/api-reference/': [ @@ -211,8 +236,8 @@ export default defineConfig({ { text: 'List Projects', link: '/api-reference/project/list-projects' }, { text: 'Get Project', link: '/api-reference/project/get-project-detail' }, { text: 'Update Project', link: '/api-reference/project/update-project-detail' }, - { text: 'Delete Project', link: '/api-reference/project/delete-project' } - ] + { text: 'Delete Project', link: '/api-reference/project/delete-project' }, + ], }, { text: 'State', @@ -223,8 +248,8 @@ export default defineConfig({ { text: 'List States', link: '/api-reference/state/list-states' }, { text: 'Get State', link: '/api-reference/state/get-state-detail' }, { text: 'Update State', link: '/api-reference/state/update-state-detail' }, - { text: 'Delete State', link: '/api-reference/state/delete-state' } - ] + { text: 'Delete State', link: '/api-reference/state/delete-state' }, + ], }, { text: 'Label', @@ -235,8 +260,8 @@ export default defineConfig({ { text: 'List Labels', link: '/api-reference/label/list-labels' }, { text: 'Get Label', link: '/api-reference/label/get-label-detail' }, { text: 'Update Label', link: '/api-reference/label/update-label-detail' }, - { text: 'Delete Label', link: '/api-reference/label/delete-label' } - ] + { text: 'Delete Label', link: '/api-reference/label/delete-label' }, + ], }, { text: 'Work Item', @@ -249,8 +274,8 @@ export default defineConfig({ { text: 'Get by Sequence ID', link: '/api-reference/issue/get-issue-sequence-id' }, { text: 'Search Work Items', link: '/api-reference/issue/search-issues' }, { text: 'Update Work Item', link: '/api-reference/issue/update-issue-detail' }, - { text: 'Delete Work Item', link: '/api-reference/issue/delete-issue' } - ] + { text: 'Delete Work Item', link: '/api-reference/issue/delete-issue' }, + ], }, { text: 'Work Item Links', @@ -261,8 +286,8 @@ export default defineConfig({ { text: 'List Links', link: '/api-reference/link/list-links' }, { text: 'Get Link', link: '/api-reference/link/get-link-detail' }, { text: 'Update Link', link: '/api-reference/link/update-link-detail' }, - { text: 'Delete Link', link: '/api-reference/link/delete-link' } - ] + { text: 'Delete Link', link: '/api-reference/link/delete-link' }, + ], }, { text: 'Work Item Activity', @@ -270,8 +295,8 @@ export default defineConfig({ items: [ { text: 'Overview', link: '/api-reference/issue-activity/overview' }, { text: 'List Activities', link: '/api-reference/issue-activity/list-issue-activities' }, - { text: 'Get Activity', link: '/api-reference/issue-activity/get-issue-activity-detail' } - ] + { text: 'Get Activity', link: '/api-reference/issue-activity/get-issue-activity-detail' }, + ], }, { text: 'Work Item Comments', @@ -282,8 +307,8 @@ export default defineConfig({ { text: 'List Comments', link: '/api-reference/issue-comment/list-issue-comments' }, { text: 'Get Comment', link: '/api-reference/issue-comment/get-issue-comment-detail' }, { text: 'Update Comment', link: '/api-reference/issue-comment/update-issue-comment-detail' }, - { text: 'Delete Comment', link: '/api-reference/issue-comment/delete-issue-comment' } - ] + { text: 'Delete Comment', link: '/api-reference/issue-comment/delete-issue-comment' }, + ], }, { text: 'Work Item Attachments', @@ -296,8 +321,8 @@ export default defineConfig({ { text: 'Upload File', link: '/api-reference/issue-attachments/upload-file' }, { text: 'Complete Upload', link: '/api-reference/issue-attachments/complete-upload' }, { text: 'Update Attachment', link: '/api-reference/issue-attachments/update-attachment' }, - { text: 'Delete Attachment', link: '/api-reference/issue-attachments/delete-attachment' } - ] + { text: 'Delete Attachment', link: '/api-reference/issue-attachments/delete-attachment' }, + ], }, { text: 'Work Item Types', @@ -308,8 +333,8 @@ export default defineConfig({ { text: 'List Types', link: '/api-reference/issue-types/types/list-issue-types' }, { text: 'Get Type Details', link: '/api-reference/issue-types/types/get-issue-type-details' }, { text: 'Update Type', link: '/api-reference/issue-types/types/update-issue-types' }, - { text: 'Delete Type', link: '/api-reference/issue-types/types/delete-issue-type' } - ] + { text: 'Delete Type', link: '/api-reference/issue-types/types/delete-issue-type' }, + ], }, { text: 'Custom Properties', @@ -320,8 +345,8 @@ export default defineConfig({ { text: 'List Properties', link: '/api-reference/issue-types/properties/list-properties' }, { text: 'Get Property Details', link: '/api-reference/issue-types/properties/get-property-details' }, { text: 'Update Property', link: '/api-reference/issue-types/properties/update-property' }, - { text: 'Delete Property', link: '/api-reference/issue-types/properties/delete-property' } - ] + { text: 'Delete Property', link: '/api-reference/issue-types/properties/delete-property' }, + ], }, { text: 'Custom Property Values', @@ -329,8 +354,8 @@ export default defineConfig({ items: [ { text: 'Overview', link: '/api-reference/issue-types/values/overview' }, { text: 'Add Property Values', link: '/api-reference/issue-types/values/add-property-values' }, - { text: 'List Property Values', link: '/api-reference/issue-types/values/list-property-values' } - ] + { text: 'List Property Values', link: '/api-reference/issue-types/values/list-property-values' }, + ], }, { text: 'Custom Property Options', @@ -341,8 +366,8 @@ export default defineConfig({ { text: 'List Dropdown Options', link: '/api-reference/issue-types/options/list-dropdown-options' }, { text: 'Get Option Details', link: '/api-reference/issue-types/options/get-option-details' }, { text: 'Update Dropdown Options', link: '/api-reference/issue-types/options/update-dropdown-options' }, - { text: 'Delete Dropdown Options', link: '/api-reference/issue-types/options/delete-dropdown-options' } - ] + { text: 'Delete Dropdown Options', link: '/api-reference/issue-types/options/delete-dropdown-options' }, + ], }, { text: 'Cycle', @@ -360,8 +385,8 @@ export default defineConfig({ { text: 'Update Cycle', link: '/api-reference/cycle/update-cycle-detail' }, { text: 'Unarchive Cycle', link: '/api-reference/cycle/unarchive-cycle' }, { text: 'Remove Work Item', link: '/api-reference/cycle/remove-cycle-work-item' }, - { text: 'Delete Cycle', link: '/api-reference/cycle/delete-cycle' } - ] + { text: 'Delete Cycle', link: '/api-reference/cycle/delete-cycle' }, + ], }, { text: 'Module', @@ -378,8 +403,8 @@ export default defineConfig({ { text: 'Update Module', link: '/api-reference/module/update-module-detail' }, { text: 'Unarchive Module', link: '/api-reference/module/unarchive-module' }, { text: 'Remove Work Item', link: '/api-reference/module/remove-module-work-item' }, - { text: 'Delete Module', link: '/api-reference/module/delete-module' } - ] + { text: 'Delete Module', link: '/api-reference/module/delete-module' }, + ], }, { text: 'Pages', @@ -389,8 +414,8 @@ export default defineConfig({ { text: 'Add Workspace Page', link: '/api-reference/page/add-workspace-page' }, { text: 'Add Project Page', link: '/api-reference/page/add-project-page' }, { text: 'Get Workspace Page', link: '/api-reference/page/get-workspace-page' }, - { text: 'Get Project Page', link: '/api-reference/page/get-project-page' } - ] + { text: 'Get Project Page', link: '/api-reference/page/get-project-page' }, + ], }, { text: 'Intake', @@ -401,8 +426,8 @@ export default defineConfig({ { text: 'List Intake Issues', link: '/api-reference/intake-issue/list-intake-issues' }, { text: 'Get Intake Issue', link: '/api-reference/intake-issue/get-intake-issue-detail' }, { text: 'Update Intake Issue', link: '/api-reference/intake-issue/update-intake-issue-detail' }, - { text: 'Delete Intake Issue', link: '/api-reference/intake-issue/delete-intake-issue' } - ] + { text: 'Delete Intake Issue', link: '/api-reference/intake-issue/delete-intake-issue' }, + ], }, { text: 'Time Tracking', @@ -413,8 +438,8 @@ export default defineConfig({ { text: 'Get Worklogs for Issue', link: '/api-reference/worklogs/get-worklogs-for-issue' }, { text: 'Get Total Time', link: '/api-reference/worklogs/get-total-time' }, { text: 'Update Worklog', link: '/api-reference/worklogs/update-worklog' }, - { text: 'Delete Worklog', link: '/api-reference/worklogs/delete-worklog' } - ] + { text: 'Delete Worklog', link: '/api-reference/worklogs/delete-worklog' }, + ], }, { text: 'Epics', @@ -422,8 +447,8 @@ export default defineConfig({ items: [ { text: 'Overview', link: '/api-reference/epics/overview' }, { text: 'List Epics', link: '/api-reference/epics/list-epics' }, - { text: 'Get Epic', link: '/api-reference/epics/get-epic-detail' } - ] + { text: 'Get Epic', link: '/api-reference/epics/get-epic-detail' }, + ], }, { text: 'Initiatives', @@ -434,8 +459,8 @@ export default defineConfig({ { text: 'List Initiatives', link: '/api-reference/initiative/list-initiatives' }, { text: 'Get Initiative', link: '/api-reference/initiative/get-initiative-detail' }, { text: 'Update Initiative', link: '/api-reference/initiative/update-initiative-detail' }, - { text: 'Delete Initiative', link: '/api-reference/initiative/delete-initiative' } - ] + { text: 'Delete Initiative', link: '/api-reference/initiative/delete-initiative' }, + ], }, { text: 'Initiative Labels', @@ -445,11 +470,14 @@ export default defineConfig({ { text: 'Add Labels to Initiative', link: '/api-reference/initiative/add-labels-to-initiative' }, { text: 'List Initiative Labels', link: '/api-reference/initiative/list-initiative-labels' }, { text: 'Get Label Detail', link: '/api-reference/initiative/get-initiative-label-detail' }, - { text: 'List Labels for Initiative', link: '/api-reference/initiative/list-initiative-labels-for-initiative' }, + { + text: 'List Labels for Initiative', + link: '/api-reference/initiative/list-initiative-labels-for-initiative', + }, { text: 'Update Label', link: '/api-reference/initiative/update-initiative-label-detail' }, { text: 'Remove Labels', link: '/api-reference/initiative/remove-labels-from-initiative' }, - { text: 'Delete Label', link: '/api-reference/initiative/delete-initiative-label' } - ] + { text: 'Delete Label', link: '/api-reference/initiative/delete-initiative-label' }, + ], }, { text: 'Initiative Projects', @@ -457,8 +485,8 @@ export default defineConfig({ items: [ { text: 'Add Projects', link: '/api-reference/initiative/add-projects-to-initiative' }, { text: 'List Projects', link: '/api-reference/initiative/list-initiative-projects' }, - { text: 'Remove Projects', link: '/api-reference/initiative/remove-projects-from-initiative' } - ] + { text: 'Remove Projects', link: '/api-reference/initiative/remove-projects-from-initiative' }, + ], }, { text: 'Initiative Epics', @@ -466,8 +494,8 @@ export default defineConfig({ items: [ { text: 'Add Epics', link: '/api-reference/initiative/add-epics-to-initiative' }, { text: 'List Epics', link: '/api-reference/initiative/list-initiative-epics' }, - { text: 'Remove Epics', link: '/api-reference/initiative/remove-epics-from-initiative' } - ] + { text: 'Remove Epics', link: '/api-reference/initiative/remove-epics-from-initiative' }, + ], }, { text: 'Customers', @@ -481,8 +509,8 @@ export default defineConfig({ { text: 'List Customer Work Items', link: '/api-reference/customer/list-customer-work-items' }, { text: 'Update Customer', link: '/api-reference/customer/update-customer-detail' }, { text: 'Unlink Work Item', link: '/api-reference/customer/unlink-work-item-from-customer' }, - { text: 'Delete Customer', link: '/api-reference/customer/delete-customer' } - ] + { text: 'Delete Customer', link: '/api-reference/customer/delete-customer' }, + ], }, { text: 'Customer Properties', @@ -495,8 +523,8 @@ export default defineConfig({ { text: 'Get Property Value', link: '/api-reference/customer/get-customer-property-value' }, { text: 'Update Property', link: '/api-reference/customer/update-customer-property-detail' }, { text: 'Update Property Value', link: '/api-reference/customer/update-customer-property-value' }, - { text: 'Delete Property', link: '/api-reference/customer/delete-customer-property' } - ] + { text: 'Delete Property', link: '/api-reference/customer/delete-customer-property' }, + ], }, { text: 'Customer Requests', @@ -506,8 +534,8 @@ export default defineConfig({ { text: 'List Requests', link: '/api-reference/customer/list-customer-requests' }, { text: 'Get Request Detail', link: '/api-reference/customer/get-customer-request-detail' }, { text: 'Update Request', link: '/api-reference/customer/update-customer-request-detail' }, - { text: 'Delete Request', link: '/api-reference/customer/delete-customer-request' } - ] + { text: 'Delete Request', link: '/api-reference/customer/delete-customer-request' }, + ], }, { text: 'Teamspaces', @@ -518,8 +546,8 @@ export default defineConfig({ { text: 'List Teamspaces', link: '/api-reference/teamspace/list-teamspaces' }, { text: 'Get Teamspace', link: '/api-reference/teamspace/get-teamspace-detail' }, { text: 'Update Teamspace', link: '/api-reference/teamspace/update-teamspace-detail' }, - { text: 'Delete Teamspace', link: '/api-reference/teamspace/delete-teamspace' } - ] + { text: 'Delete Teamspace', link: '/api-reference/teamspace/delete-teamspace' }, + ], }, { text: 'Teamspace Members', @@ -527,8 +555,8 @@ export default defineConfig({ items: [ { text: 'List Members', link: '/api-reference/teamspace/list-teamspace-members' }, { text: 'Add Members', link: '/api-reference/teamspace/add-teamspace-members' }, - { text: 'Remove Members', link: '/api-reference/teamspace/remove-teamspace-members' } - ] + { text: 'Remove Members', link: '/api-reference/teamspace/remove-teamspace-members' }, + ], }, { text: 'Teamspace Projects', @@ -536,8 +564,8 @@ export default defineConfig({ items: [ { text: 'List Projects', link: '/api-reference/teamspace/list-teamspace-projects' }, { text: 'Add Projects', link: '/api-reference/teamspace/add-projects-to-teamspace' }, - { text: 'Remove Projects', link: '/api-reference/teamspace/remove-projects-from-teamspace' } - ] + { text: 'Remove Projects', link: '/api-reference/teamspace/remove-projects-from-teamspace' }, + ], }, { text: 'Stickies', @@ -548,8 +576,8 @@ export default defineConfig({ { text: 'List Stickies', link: '/api-reference/sticky/list-stickies' }, { text: 'Get Sticky', link: '/api-reference/sticky/get-sticky-detail' }, { text: 'Update Sticky', link: '/api-reference/sticky/update-sticky-detail' }, - { text: 'Delete Sticky', link: '/api-reference/sticky/delete-sticky' } - ] + { text: 'Delete Sticky', link: '/api-reference/sticky/delete-sticky' }, + ], }, { text: 'Members', @@ -557,18 +585,18 @@ export default defineConfig({ items: [ { text: 'Overview', link: '/api-reference/members/overview' }, { text: 'Get Workspace Members', link: '/api-reference/members/get-workspace-members' }, - { text: 'Get Project Members', link: '/api-reference/members/get-project-members' } - ] + { text: 'Get Project Members', link: '/api-reference/members/get-project-members' }, + ], }, { text: 'User', collapsed: true, items: [ { text: 'Overview', link: '/api-reference/user/overview' }, - { text: 'Get Current User', link: '/api-reference/user/get-current-user' } - ] - } - ] + { text: 'Get Current User', link: '/api-reference/user/get-current-user' }, + ], + }, + ], }, ], @@ -578,31 +606,30 @@ export default defineConfig({ items: [ { text: 'Build Plane App', link: '/dev-tools/build-plane-app' }, { text: 'Webhooks', link: '/dev-tools/intro-webhooks' }, - { text: 'MCP Server', link: '/dev-tools/mcp-server' } - ] - } + { text: 'MCP Server', link: '/dev-tools/mcp-server' }, + ], + }, ], - }, socialLinks: [ { icon: 'github', link: 'https://github.com/makeplane/plane' }, { icon: 'discord', link: 'https://discord.com/invite/A92xrEGCge' }, { icon: 'twitter', link: 'https://twitter.com/planepowers' }, - { icon: 'linkedin', link: 'https://www.linkedin.com/company/planepowers/' } + { icon: 'linkedin', link: 'https://www.linkedin.com/company/planepowers/' }, ], search: { - provider: 'local' + provider: 'local', }, editLink: { - pattern: 'https://github.com/makeplane/developer-docs/edit/main/:path' + pattern: 'https://github.com/makeplane/developer-docs/edit/main/:path', }, /*footer: { message: 'Released under the Apache License 2.0.', copyright: 'Copyright © 2024 Plane' }*/ - } -}) + }, +}); diff --git a/docs/.vitepress/theme/components/ApiParam.vue b/docs/.vitepress/theme/components/ApiParam.vue index 5c3a22f3..c746168b 100644 --- a/docs/.vitepress/theme/components/ApiParam.vue +++ b/docs/.vitepress/theme/components/ApiParam.vue @@ -1,13 +1,13 @@