diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index e4f30a34..c48aeda9 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -125,6 +125,8 @@ export default withMermaid(defineConfig({ transformPageData(pageData) { const head = pageData.frontmatter.head ??= [] + + // Inject canonical URL if not already defined in frontmatter const hasCanonical = head.some( ([tag, attrs]) => tag === 'link' && attrs?.rel === 'canonical' ) @@ -134,6 +136,12 @@ export default withMermaid(defineConfig({ .replace(/\.md$/, '') head.push(['link', { rel: 'canonical', href: canonicalUrl }]) } + + // Inject frontmatter keywords as a meta tag (VitePress doesn't do this natively) + const keywords = pageData.frontmatter.keywords + if (keywords) { + head.push(['meta', { name: 'keywords', content: keywords }]) + } }, themeConfig: { diff --git a/docs/api-reference/customer/delete-customer.md b/docs/api-reference/customer/delete-customer.md index ab7d8605..7ff1af9e 100644 --- a/docs/api-reference/customer/delete-customer.md +++ b/docs/api-reference/customer/delete-customer.md @@ -1,6 +1,6 @@ --- title: Delete a customer -description: Delete a customer via Plane API. HTTP DELETE request for removing resources. +description: Permanently delete a customer record via Plane API. Removes the customer and unlinks associated work items. Returns 204 on success. keywords: plane, plane api, rest api, api integration, customers, crm, customer management --- diff --git a/docs/api-reference/cycle/delete-cycle.md b/docs/api-reference/cycle/delete-cycle.md index 3cea6bcb..a8ef04a1 100644 --- a/docs/api-reference/cycle/delete-cycle.md +++ b/docs/api-reference/cycle/delete-cycle.md @@ -1,6 +1,6 @@ --- title: Delete a cycle -description: Delete a cycle via Plane API. HTTP DELETE request for removing resources. +description: Permanently delete a cycle via Plane API. Removes the cycle and disassociates its work items. Returns 204 on success. keywords: plane, plane api, rest api, api integration, cycles, sprints, iterations --- diff --git a/docs/api-reference/inbox-issue/delete-inbox-issue.md b/docs/api-reference/inbox-issue/delete-inbox-issue.md index f8e879df..46c33785 100644 --- a/docs/api-reference/inbox-issue/delete-inbox-issue.md +++ b/docs/api-reference/inbox-issue/delete-inbox-issue.md @@ -1,6 +1,6 @@ --- title: Delete intake issue -description: Delete intake issue via Plane API. HTTP DELETE request for removing resources. +description: Delete an intake issue from the inbox via Plane API. Permanently removes the triaged submission. Returns 204 on success. keywords: plane, plane api, rest api, api integration, work items, issues, tasks --- diff --git a/docs/api-reference/initiative/delete-initiative.md b/docs/api-reference/initiative/delete-initiative.md index 6424909d..cda5c0c9 100644 --- a/docs/api-reference/initiative/delete-initiative.md +++ b/docs/api-reference/initiative/delete-initiative.md @@ -1,6 +1,6 @@ --- title: Delete an initiative -description: Delete an initiative via Plane API. HTTP DELETE request for removing resources. +description: Permanently delete an initiative via Plane API. Removes the initiative and disassociates linked epics, projects, and labels. Returns 204 on success. keywords: plane, plane api, rest api, api integration, initiatives, roadmap, planning --- diff --git a/docs/api-reference/intake-issue/delete-intake-issue.md b/docs/api-reference/intake-issue/delete-intake-issue.md index 0f2ae3f2..0b17cc3a 100644 --- a/docs/api-reference/intake-issue/delete-intake-issue.md +++ b/docs/api-reference/intake-issue/delete-intake-issue.md @@ -1,6 +1,6 @@ --- title: Delete an intake work item -description: Delete an intake work item via Plane API. HTTP DELETE request for removing resources. +description: Delete an intake work item via Plane API. Permanently removes the submission from the intake queue. Returns 204 on success. keywords: plane, plane api, rest api, api integration, work items, issues, tasks, intake, triage, submissions --- diff --git a/docs/api-reference/issue-attachments/delete-attachment.md b/docs/api-reference/issue-attachments/delete-attachment.md index 0481f89d..701fe91b 100644 --- a/docs/api-reference/issue-attachments/delete-attachment.md +++ b/docs/api-reference/issue-attachments/delete-attachment.md @@ -1,6 +1,6 @@ --- title: Delete an attachment -description: Delete an attachment via Plane API. HTTP DELETE request for removing resources. +description: Delete a file attachment from a work item via Plane API. Permanently removes the uploaded file. Returns 204 on success. keywords: plane, plane api, rest api, api integration, work items, issues, tasks, attachments, files, uploads --- diff --git a/docs/api-reference/issue-comment/delete-issue-comment.md b/docs/api-reference/issue-comment/delete-issue-comment.md index 50b8d12b..bc993a92 100644 --- a/docs/api-reference/issue-comment/delete-issue-comment.md +++ b/docs/api-reference/issue-comment/delete-issue-comment.md @@ -1,6 +1,6 @@ --- title: Delete a work item comment -description: Delete a work item comment via Plane API. HTTP DELETE request for removing resources. +description: Delete a comment from a work item via Plane API. Permanently removes the comment and its content. Returns 204 on success. keywords: plane, plane api, rest api, api integration, work items, issues, tasks, comments, discussion, collaboration --- diff --git a/docs/api-reference/issue/delete-issue.md b/docs/api-reference/issue/delete-issue.md index ac3e1731..f37e6210 100644 --- a/docs/api-reference/issue/delete-issue.md +++ b/docs/api-reference/issue/delete-issue.md @@ -1,6 +1,6 @@ --- title: Delete a work item -description: Delete a work item via Plane API. HTTP DELETE request for removing resources. +description: Permanently delete a work item via Plane API. Removes the issue and its associated comments, links, and attachments. Returns 204 on success. keywords: plane, plane api, rest api, api integration, work items, issues, tasks --- diff --git a/docs/api-reference/label/delete-label.md b/docs/api-reference/label/delete-label.md index 8cb73c06..f9646334 100644 --- a/docs/api-reference/label/delete-label.md +++ b/docs/api-reference/label/delete-label.md @@ -1,6 +1,6 @@ --- title: Delete a label -description: Delete a label via Plane API. HTTP DELETE request for removing resources. +description: Delete a label from a project via Plane API. Removes the label and disassociates it from all work items. Returns 204 on success. keywords: plane, plane api, rest api, api integration, labels, tags, categorization --- diff --git a/docs/api-reference/link/add-link.md b/docs/api-reference/link/add-link.md index a8c7c30f..c9fa58e6 100644 --- a/docs/api-reference/link/add-link.md +++ b/docs/api-reference/link/add-link.md @@ -1,7 +1,7 @@ --- title: Create a link description: Create a link via Plane API. HTTP POST request format, required fields, and example responses. -keywords: plane, plane api, rest api, api integration +keywords: plane api, create link, add url reference, work item link, issue link, rest api, api integration --- diff --git a/docs/api-reference/link/delete-link.md b/docs/api-reference/link/delete-link.md index cb551f6f..fae6f716 100644 --- a/docs/api-reference/link/delete-link.md +++ b/docs/api-reference/link/delete-link.md @@ -1,7 +1,7 @@ --- title: Delete a link -description: Delete a link via Plane API. HTTP DELETE request for removing resources. -keywords: plane, plane api, rest api, api integration +description: Remove a URL link from a work item via Plane API. Deletes the link reference without affecting the target URL. Returns 204 on success. +keywords: plane api, delete link, remove link, work item link, issue link, rest api, api integration --- diff --git a/docs/api-reference/link/get-link-detail.md b/docs/api-reference/link/get-link-detail.md index fc953e31..dc912f1d 100644 --- a/docs/api-reference/link/get-link-detail.md +++ b/docs/api-reference/link/get-link-detail.md @@ -1,7 +1,7 @@ --- title: Retrieve a link description: Get retrieve a link details via Plane API. Retrieve complete information for a specific resource. -keywords: plane, plane api, rest api, api integration +keywords: plane api, get link detail, retrieve link, work item link, issue link, rest api, api integration --- diff --git a/docs/api-reference/link/list-links.md b/docs/api-reference/link/list-links.md index f856c12b..b0ab0e9d 100644 --- a/docs/api-reference/link/list-links.md +++ b/docs/api-reference/link/list-links.md @@ -1,7 +1,7 @@ --- title: List all links description: List all links via Plane API. HTTP GET request with pagination, filtering, and query parameters. -keywords: plane, plane api, rest api, api integration +keywords: plane api, list links, get all links, work item links, issue links, rest api, api integration --- diff --git a/docs/api-reference/link/overview.md b/docs/api-reference/link/overview.md index 5555e148..bbf75f40 100644 --- a/docs/api-reference/link/overview.md +++ b/docs/api-reference/link/overview.md @@ -1,7 +1,7 @@ --- title: Overview description: Plane Link API overview. Learn about endpoints, request/response format, and how to work with link via REST API. -keywords: plane, plane api, rest api, api integration +keywords: plane api, rest api, work item links, issue links, url references, link management, plane integration --- diff --git a/docs/api-reference/link/update-link-detail.md b/docs/api-reference/link/update-link-detail.md index babf9926..181819ae 100644 --- a/docs/api-reference/link/update-link-detail.md +++ b/docs/api-reference/link/update-link-detail.md @@ -1,7 +1,7 @@ --- title: Update a link description: Update a link via Plane API. HTTP PATCH request format, editable fields, and example responses. -keywords: plane, plane api, rest api, api integration +keywords: plane api, update link, modify link, work item link, issue link, rest api, api integration --- diff --git a/docs/api-reference/members/get-project-members.md b/docs/api-reference/members/get-project-members.md index 67e53fd1..d912c0f7 100644 --- a/docs/api-reference/members/get-project-members.md +++ b/docs/api-reference/members/get-project-members.md @@ -1,7 +1,7 @@ --- title: List all project members description: List all project members via Plane API. HTTP GET request with pagination, filtering, and query parameters. -keywords: plane, plane api, rest api, api integration, projects, project management +keywords: plane api, project members, list project members, member roles, project management, user management, rest api, api integration --- diff --git a/docs/api-reference/members/get-workspace-members.md b/docs/api-reference/members/get-workspace-members.md index 93031e8e..2d348746 100644 --- a/docs/api-reference/members/get-workspace-members.md +++ b/docs/api-reference/members/get-workspace-members.md @@ -1,7 +1,7 @@ --- title: Get all workspace members description: List all workspace members via Plane API. HTTP GET request with pagination, filtering, and query parameters. -keywords: plane, plane api, rest api, api integration +keywords: plane api, workspace members, list members, member roles, user management, rest api, api integration --- diff --git a/docs/api-reference/members/overview.md b/docs/api-reference/members/overview.md index 1cf70dcc..39179f30 100644 --- a/docs/api-reference/members/overview.md +++ b/docs/api-reference/members/overview.md @@ -1,7 +1,7 @@ --- title: Overview description: Plane Members API overview. Learn about endpoints, request/response format, and how to work with members via REST API. -keywords: plane, plane api, rest api, api integration +keywords: plane api, members, workspace members, team members, member roles, user management, rest api, api integration --- diff --git a/docs/api-reference/module/delete-module.md b/docs/api-reference/module/delete-module.md index d91d8023..bf068b30 100644 --- a/docs/api-reference/module/delete-module.md +++ b/docs/api-reference/module/delete-module.md @@ -1,6 +1,6 @@ --- title: Delete a module -description: Delete a module via Plane API. HTTP DELETE request for removing resources. +description: Permanently delete a module via Plane API. Removes the module and disassociates its work items. Returns 204 on success. keywords: plane, plane api, rest api, api integration, modules, features --- diff --git a/docs/api-reference/project/delete-project.md b/docs/api-reference/project/delete-project.md index f990fb38..fb178bb1 100644 --- a/docs/api-reference/project/delete-project.md +++ b/docs/api-reference/project/delete-project.md @@ -1,6 +1,6 @@ --- title: Delete a project -description: Delete a project via Plane API. HTTP DELETE request for removing resources. +description: Permanently delete a project and all its data via Plane API. This action is irreversible and removes all work items, cycles, and modules within the project. keywords: plane, plane api, rest api, api integration, projects, project management --- diff --git a/docs/api-reference/state/delete-state.md b/docs/api-reference/state/delete-state.md index 68647096..7812aa3c 100644 --- a/docs/api-reference/state/delete-state.md +++ b/docs/api-reference/state/delete-state.md @@ -1,6 +1,6 @@ --- title: Delete a state -description: Delete a state via Plane API. HTTP DELETE request for removing resources. +description: Delete a workflow state from a project via Plane API. The state must not be in use by any work items. Returns 204 on success. keywords: plane, plane api, rest api, api integration, states, workflow, status --- diff --git a/docs/api-reference/sticky/add-sticky.md b/docs/api-reference/sticky/add-sticky.md index f2bd222b..2e1b44e4 100644 --- a/docs/api-reference/sticky/add-sticky.md +++ b/docs/api-reference/sticky/add-sticky.md @@ -1,7 +1,7 @@ --- title: Create a sticky description: Create a sticky via Plane API. HTTP POST request format, required fields, and example responses. -keywords: plane, plane api, rest api, api integration +keywords: plane api, create sticky, add note, sticky note, quick capture, rest api, api integration --- diff --git a/docs/api-reference/sticky/delete-sticky.md b/docs/api-reference/sticky/delete-sticky.md index bba0e5c4..c20b8ecd 100644 --- a/docs/api-reference/sticky/delete-sticky.md +++ b/docs/api-reference/sticky/delete-sticky.md @@ -1,7 +1,7 @@ --- title: Delete a sticky -description: Delete a sticky via Plane API. HTTP DELETE request for removing resources. -keywords: plane, plane api, rest api, api integration +description: Delete a sticky note via Plane API. Permanently removes the note from your workspace. Returns 204 on success. +keywords: plane api, delete sticky, remove note, sticky note, rest api, api integration --- diff --git a/docs/api-reference/sticky/get-sticky-detail.md b/docs/api-reference/sticky/get-sticky-detail.md index 90e11dbe..e0983891 100644 --- a/docs/api-reference/sticky/get-sticky-detail.md +++ b/docs/api-reference/sticky/get-sticky-detail.md @@ -1,7 +1,7 @@ --- title: Retrieve a sticky description: Get retrieve a sticky details via Plane API. Retrieve complete information for a specific resource. -keywords: plane, plane api, rest api, api integration +keywords: plane api, get sticky detail, retrieve note, sticky note, rest api, api integration --- diff --git a/docs/api-reference/sticky/list-stickies.md b/docs/api-reference/sticky/list-stickies.md index 1029d7c4..736a67e7 100644 --- a/docs/api-reference/sticky/list-stickies.md +++ b/docs/api-reference/sticky/list-stickies.md @@ -1,7 +1,7 @@ --- title: List all stickies description: List all stickies via Plane API. HTTP GET request with pagination, filtering, and query parameters. -keywords: plane, plane api, rest api, api integration +keywords: plane api, list stickies, get all notes, sticky notes, quick notes, rest api, api integration --- diff --git a/docs/api-reference/sticky/overview.md b/docs/api-reference/sticky/overview.md index 29300d3f..78a659dd 100644 --- a/docs/api-reference/sticky/overview.md +++ b/docs/api-reference/sticky/overview.md @@ -1,7 +1,7 @@ --- title: Overview description: Plane Sticky API overview. Learn about endpoints, request/response format, and how to work with sticky via REST API. -keywords: plane, plane api, rest api, api integration +keywords: plane api, sticky notes, quick notes, personal notes, workspace stickies, rest api, api integration --- diff --git a/docs/api-reference/sticky/update-sticky-detail.md b/docs/api-reference/sticky/update-sticky-detail.md index e65ba6cf..cbf42f76 100644 --- a/docs/api-reference/sticky/update-sticky-detail.md +++ b/docs/api-reference/sticky/update-sticky-detail.md @@ -1,7 +1,7 @@ --- title: Update a sticky description: Update a sticky via Plane API. HTTP PATCH request format, editable fields, and example responses. -keywords: plane, plane api, rest api, api integration +keywords: plane api, update sticky, modify note, sticky note, rest api, api integration --- diff --git a/docs/api-reference/teamspace/add-projects-to-teamspace.md b/docs/api-reference/teamspace/add-projects-to-teamspace.md index a6940e50..ae44141a 100644 --- a/docs/api-reference/teamspace/add-projects-to-teamspace.md +++ b/docs/api-reference/teamspace/add-projects-to-teamspace.md @@ -1,7 +1,7 @@ --- title: Add projects to teamspace description: Create projects to teamspace via Plane API. HTTP POST request format, required fields, and example responses. -keywords: plane, plane api, rest api, api integration, projects, project management +keywords: plane api, add projects to teamspace, team project management, team collaboration, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/add-teamspace-members.md b/docs/api-reference/teamspace/add-teamspace-members.md index cecc8e60..e55b00e5 100644 --- a/docs/api-reference/teamspace/add-teamspace-members.md +++ b/docs/api-reference/teamspace/add-teamspace-members.md @@ -1,7 +1,7 @@ --- title: Add members to teamspace description: Create members to teamspace via Plane API. HTTP POST request format, required fields, and example responses. -keywords: plane, plane api, rest api, api integration +keywords: plane api, add teamspace members, invite team members, team management, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/add-teamspace.md b/docs/api-reference/teamspace/add-teamspace.md index d1de0f7b..89630806 100644 --- a/docs/api-reference/teamspace/add-teamspace.md +++ b/docs/api-reference/teamspace/add-teamspace.md @@ -1,7 +1,7 @@ --- title: Create a teamspace description: Create a teamspace via Plane API. HTTP POST request format, required fields, and example responses. -keywords: plane, plane api, rest api, api integration +keywords: plane api, create teamspace, add team, team management, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/delete-teamspace.md b/docs/api-reference/teamspace/delete-teamspace.md index d0ab958e..a4d306cf 100644 --- a/docs/api-reference/teamspace/delete-teamspace.md +++ b/docs/api-reference/teamspace/delete-teamspace.md @@ -1,7 +1,7 @@ --- title: Delete a teamspace -description: Delete a teamspace via Plane API. HTTP DELETE request for removing resources. -keywords: plane, plane api, rest api, api integration +description: Delete a teamspace via Plane API. Removes the team grouping and disassociates its members and projects. Returns 204 on success. +keywords: plane api, delete teamspace, remove team, team management, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/get-teamspace-detail.md b/docs/api-reference/teamspace/get-teamspace-detail.md index 74b54650..187d4706 100644 --- a/docs/api-reference/teamspace/get-teamspace-detail.md +++ b/docs/api-reference/teamspace/get-teamspace-detail.md @@ -1,7 +1,7 @@ --- title: Retrieve a teamspace description: Get retrieve a teamspace details via Plane API. Retrieve complete information for a specific resource. -keywords: plane, plane api, rest api, api integration +keywords: plane api, get teamspace detail, retrieve team, team management, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/list-teamspace-members.md b/docs/api-reference/teamspace/list-teamspace-members.md index c9d3bb19..3a06c2e1 100644 --- a/docs/api-reference/teamspace/list-teamspace-members.md +++ b/docs/api-reference/teamspace/list-teamspace-members.md @@ -1,7 +1,7 @@ --- title: List all teamspace members description: List all teamspace members via Plane API. HTTP GET request with pagination, filtering, and query parameters. -keywords: plane, plane api, rest api, api integration +keywords: plane api, list teamspace members, team members, team management, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/list-teamspace-projects.md b/docs/api-reference/teamspace/list-teamspace-projects.md index e5660293..6a964605 100644 --- a/docs/api-reference/teamspace/list-teamspace-projects.md +++ b/docs/api-reference/teamspace/list-teamspace-projects.md @@ -1,7 +1,7 @@ --- title: List teamspace projects description: List teamspace projects via Plane API. HTTP GET request with pagination, filtering, and query parameters. -keywords: plane, plane api, rest api, api integration, projects, project management +keywords: plane api, teamspace projects, team project management, team collaboration, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/list-teamspaces.md b/docs/api-reference/teamspace/list-teamspaces.md index 79cbff6c..a9dbc88f 100644 --- a/docs/api-reference/teamspace/list-teamspaces.md +++ b/docs/api-reference/teamspace/list-teamspaces.md @@ -1,7 +1,7 @@ --- title: List all teamspaces description: List all teamspaces via Plane API. HTTP GET request with pagination, filtering, and query parameters. -keywords: plane, plane api, rest api, api integration +keywords: plane api, list teamspaces, get all teams, team management, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/overview.md b/docs/api-reference/teamspace/overview.md index c6816875..066cd752 100644 --- a/docs/api-reference/teamspace/overview.md +++ b/docs/api-reference/teamspace/overview.md @@ -1,7 +1,7 @@ --- title: Overview description: Plane Teamspace API overview. Learn about endpoints, request/response format, and how to work with teamspace via REST API. -keywords: plane, plane api, rest api, api integration +keywords: plane api, teamspace, team management, team collaboration, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/remove-projects-from-teamspace.md b/docs/api-reference/teamspace/remove-projects-from-teamspace.md index 2cdbae8f..12911ec9 100644 --- a/docs/api-reference/teamspace/remove-projects-from-teamspace.md +++ b/docs/api-reference/teamspace/remove-projects-from-teamspace.md @@ -1,7 +1,7 @@ --- title: Remove projects from teamspace description: Delete projects from teamspace via Plane API. HTTP DELETE request for removing resources. -keywords: plane, plane api, rest api, api integration, projects, project management +keywords: plane api, remove projects from teamspace, team project management, team collaboration, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/remove-teamspace-members.md b/docs/api-reference/teamspace/remove-teamspace-members.md index 73b6df98..ba950503 100644 --- a/docs/api-reference/teamspace/remove-teamspace-members.md +++ b/docs/api-reference/teamspace/remove-teamspace-members.md @@ -1,7 +1,7 @@ --- title: Remove members from teamspace description: Delete members from teamspace via Plane API. HTTP DELETE request for removing resources. -keywords: plane, plane api, rest api, api integration +keywords: plane api, remove teamspace members, team management, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/teamspace/update-teamspace-detail.md b/docs/api-reference/teamspace/update-teamspace-detail.md index 59b01d40..48169152 100644 --- a/docs/api-reference/teamspace/update-teamspace-detail.md +++ b/docs/api-reference/teamspace/update-teamspace-detail.md @@ -1,7 +1,7 @@ --- title: Update a teamspace description: Update a teamspace via Plane API. HTTP PATCH request format, editable fields, and example responses. -keywords: plane, plane api, rest api, api integration +keywords: plane api, update teamspace, modify team, team management, workspace teams, rest api, api integration --- diff --git a/docs/api-reference/user/get-current-user.md b/docs/api-reference/user/get-current-user.md index 942a0112..54bcb01d 100644 --- a/docs/api-reference/user/get-current-user.md +++ b/docs/api-reference/user/get-current-user.md @@ -1,7 +1,7 @@ --- title: Retrieve current user description: List retrieve current user via Plane API. HTTP GET request with pagination, filtering, and query parameters. -keywords: plane, plane api, rest api, api integration +keywords: plane api, get current user, user profile, authenticated user, user details, rest api, api integration --- diff --git a/docs/api-reference/user/overview.md b/docs/api-reference/user/overview.md index db5ec7da..a8c77952 100644 --- a/docs/api-reference/user/overview.md +++ b/docs/api-reference/user/overview.md @@ -1,7 +1,7 @@ --- title: Overview description: Plane User API overview. Learn about endpoints, request/response format, and how to work with user via REST API. -keywords: plane, plane api, rest api, api integration +keywords: plane api, user profile, current user, user account, authentication, rest api, api integration --- diff --git a/docs/api-reference/worklogs/delete-worklog.md b/docs/api-reference/worklogs/delete-worklog.md index eac39b7e..edbd5e75 100644 --- a/docs/api-reference/worklogs/delete-worklog.md +++ b/docs/api-reference/worklogs/delete-worklog.md @@ -1,6 +1,6 @@ --- title: Delete a worklog -description: Delete a worklog via Plane API. HTTP DELETE request for removing resources. +description: Delete a time tracking worklog entry via Plane API. Removes the logged time from the work item. Returns 204 on success. keywords: plane, plane api, rest api, api integration, time tracking, worklogs, time management --- diff --git a/docs/dev-tools/agents/best-practices.md b/docs/dev-tools/agents/best-practices.md index b8ac0609..363ba01a 100644 --- a/docs/dev-tools/agents/best-practices.md +++ b/docs/dev-tools/agents/best-practices.md @@ -1,6 +1,7 @@ --- -title: Best practices -description: Guidelines for building responsive, user-friendly Plane agents that provide a seamless experience. +title: Agent best practices +description: Guidelines for building responsive, user-friendly Plane agents that provide a seamless experience. Covers error handling, response patterns, and user communication. +keywords: plane agent best practices, agent design patterns, plane bot guidelines, agent error handling, responsive agents, plane agent development --- # Best practices diff --git a/docs/dev-tools/agents/building-an-agent.md b/docs/dev-tools/agents/building-an-agent.md index 0dc3a74e..87807e54 100644 --- a/docs/dev-tools/agents/building-an-agent.md +++ b/docs/dev-tools/agents/building-an-agent.md @@ -1,6 +1,7 @@ --- title: Building an Agent description: Step-by-step guide to creating a Plane agent, including OAuth setup, webhook handling, and activity creation. +keywords: build plane agent, plane agent tutorial, oauth agent setup, plane webhook handler, agent activity api, plane bot development, ai agent integration --- # Building an agent diff --git a/docs/dev-tools/agents/overview.md b/docs/dev-tools/agents/overview.md index 26820c6c..dfeb7c8c 100644 --- a/docs/dev-tools/agents/overview.md +++ b/docs/dev-tools/agents/overview.md @@ -1,6 +1,7 @@ --- title: Agents Overview description: Learn how to build AI agents that integrate with Plane workspaces, enabling automated task handling, intelligent responses, and seamless collaboration. +keywords: plane agents, ai agents, plane automation, workspace integration, plane bot, ai-powered project management, plane developer tools, agent api --- # Agents overview diff --git a/docs/dev-tools/agents/signals-content-payload.md b/docs/dev-tools/agents/signals-content-payload.md index 750707a5..11d9da24 100644 --- a/docs/dev-tools/agents/signals-content-payload.md +++ b/docs/dev-tools/agents/signals-content-payload.md @@ -1,6 +1,7 @@ --- title: Signals & Content Payload -description: Detailed reference for activity signals and content payload structures in Plane agents. +description: Detailed reference for activity signals and content payload structures in Plane agents. Includes signal types, payload formats, and content examples. +keywords: plane agent signals, activity payload, agent content structure, plane agent events, agent activity signals, plane webhook payload, agent data format --- # Signals and content payload diff --git a/docs/dev-tools/build-plane-app/choose-token-flow.md b/docs/dev-tools/build-plane-app/choose-token-flow.md index 4405b924..88b8119f 100644 --- a/docs/dev-tools/build-plane-app/choose-token-flow.md +++ b/docs/dev-tools/build-plane-app/choose-token-flow.md @@ -1,6 +1,7 @@ --- title: Choose token flow -description: Decide between Bot Token and User Token flows and learn how to implement them. +description: Decide between Bot Token and User Token flows for your Plane app. Compare client credentials and authorization code grant types for different use cases. +keywords: plane token flow, bot token, user token, oauth flow, client credentials, authorization code, plane api authentication, plane access token --- # Choose token flow diff --git a/docs/dev-tools/build-plane-app/create-oauth-application.md b/docs/dev-tools/build-plane-app/create-oauth-application.md index f5a6b4dd..e74129aa 100644 --- a/docs/dev-tools/build-plane-app/create-oauth-application.md +++ b/docs/dev-tools/build-plane-app/create-oauth-application.md @@ -1,6 +1,7 @@ --- title: Create an OAuth Application -description: Register your app to get Client ID and Secret. +description: Register your Plane OAuth application to get Client ID and Secret. Configure setup URL, redirect URI, and webhook endpoints for your integration. +keywords: plane oauth application, create plane app, client id secret, plane app registration, oauth credentials, plane workspace integration, plane api authentication --- # Create an OAuth Application diff --git a/docs/dev-tools/build-plane-app/examples.md b/docs/dev-tools/build-plane-app/examples.md index c8d803ed..f881845d 100644 --- a/docs/dev-tools/build-plane-app/examples.md +++ b/docs/dev-tools/build-plane-app/examples.md @@ -1,6 +1,7 @@ --- -title: Complete examples -description: Full code examples for Node.js (Express) and Python (Flask). +title: Plane app code examples +description: Full code examples for building Plane OAuth apps with Node.js (Express) and Python (Flask). Includes bot token flow, user token flow, and webhook handling. +keywords: plane app example, plane oauth example, plane node.js integration, plane python integration, plane express app, plane flask app, plane api code sample --- # Complete examples diff --git a/docs/dev-tools/build-plane-app/oauth-scopes.md b/docs/dev-tools/build-plane-app/oauth-scopes.md index 77ce90d7..6c06eaf8 100644 --- a/docs/dev-tools/build-plane-app/oauth-scopes.md +++ b/docs/dev-tools/build-plane-app/oauth-scopes.md @@ -1,6 +1,7 @@ --- title: OAuth Scopes -description: All OAuth scopes available when building a Plane app. +description: Complete reference of all OAuth scopes available when building a Plane app. Includes read and write permissions for projects, work items, cycles, modules, and more. +keywords: plane oauth scopes, plane api permissions, oauth read write scopes, plane app authorization, plane api access control, workspace scopes, project scopes --- # OAuth scopes diff --git a/docs/dev-tools/build-plane-app/overview.md b/docs/dev-tools/build-plane-app/overview.md index c7919bc1..0a165f59 100644 --- a/docs/dev-tools/build-plane-app/overview.md +++ b/docs/dev-tools/build-plane-app/overview.md @@ -1,6 +1,7 @@ --- title: Build a Plane App -description: Build and integrate an app with Plane using OAuth 2.0 authentication. +description: Build and integrate an app with Plane using OAuth 2.0 authentication. Covers bot tokens, user tokens, webhooks, and API access for custom integrations. +keywords: build plane app, plane oauth app, plane integration, plane api app, oauth 2.0 plane, plane developer platform, custom plane integration, plane third-party app --- # Build a Plane app diff --git a/docs/dev-tools/build-plane-app/sdks.md b/docs/dev-tools/build-plane-app/sdks.md index 069ba3e2..9644c14c 100644 --- a/docs/dev-tools/build-plane-app/sdks.md +++ b/docs/dev-tools/build-plane-app/sdks.md @@ -1,6 +1,7 @@ --- -title: SDKs -description: Official SDKs to build apps faster. +title: Plane SDKs +description: Official Plane SDKs for Node.js and Python. Get typed API clients and OAuth helpers to build Plane integrations faster. +keywords: plane sdk, plane node sdk, plane python sdk, plane api client, plane-node-sdk, plane-sdk, plane npm package, plane pypi package, plane developer tools --- # SDKs diff --git a/docs/dev-tools/build-plane-app/webhooks.md b/docs/dev-tools/build-plane-app/webhooks.md index 3b51efcc..dcc4d59e 100644 --- a/docs/dev-tools/build-plane-app/webhooks.md +++ b/docs/dev-tools/build-plane-app/webhooks.md @@ -1,6 +1,7 @@ --- title: Handling webhooks -description: How to receive and verify webhooks from Plane. +description: Receive and verify webhooks from Plane in your application. Learn about webhook headers, signature verification, event types, and payload handling. +keywords: plane webhooks, webhook verification, plane event notifications, webhook signature, plane webhook handler, real-time events, plane webhook payload --- # Handling webhooks diff --git a/docs/dev-tools/plane-compose.md b/docs/dev-tools/plane-compose.md index 5f8b70f7..609b4252 100644 --- a/docs/dev-tools/plane-compose.md +++ b/docs/dev-tools/plane-compose.md @@ -1,6 +1,7 @@ --- title: Plane Compose description: Define Plane projects, workflows, and work items in YAML files. Version control your project structure and sync bidirectionally with Plane using the command line. +keywords: plane compose, plane yaml, infrastructure as code, plane cli, plane project configuration, plane version control, plane sync, plane command line tool --- # Plane Compose diff --git a/docs/self-hosting/editions-and-versions.md b/docs/self-hosting/editions-and-versions.md index 03fa1e0a..a919d2e6 100644 --- a/docs/self-hosting/editions-and-versions.md +++ b/docs/self-hosting/editions-and-versions.md @@ -1,7 +1,7 @@ --- title: Understanding Plane's editions -description: Learn how to understanding plane's editions for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Compare Plane Community, Pro, Business, and Enterprise editions. Understand features, pricing tiers, and version differences for self-hosted deployments. +keywords: plane editions, plane community edition, plane pro, plane enterprise, plane business, self-hosting comparison, plane pricing tiers --- diff --git a/docs/self-hosting/govern/advanced-search.md b/docs/self-hosting/govern/advanced-search.md index 4ba7f515..91a8e8a7 100644 --- a/docs/self-hosting/govern/advanced-search.md +++ b/docs/self-hosting/govern/advanced-search.md @@ -1,7 +1,7 @@ --- title: Configure OpenSearch for advanced search -description: Learn how to configure opensearch for advanced search for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Enable full-text search in Plane with OpenSearch. Configure advanced search indexing for work items, projects, and pages in your self-hosted instance. +keywords: plane opensearch, full-text search, advanced search, search indexing, elasticsearch, self-hosting, plane search --- diff --git a/docs/self-hosting/govern/authentication.md b/docs/self-hosting/govern/authentication.md index f56fea47..a2a41fb2 100644 --- a/docs/self-hosting/govern/authentication.md +++ b/docs/self-hosting/govern/authentication.md @@ -1,7 +1,7 @@ --- title: Overview description: Configure authentication methods for self-hosted Plane. Setup OAuth, SSO, SAML, OIDC, LDAP and other authentication providers. -keywords: plane, self-hosting, deployment, plane installation, authentication, sso, oauth, configuration, administration +keywords: plane authentication, auth providers, sso setup, oauth configuration, saml, oidc, ldap, self-hosting security --- diff --git a/docs/self-hosting/govern/communication.md b/docs/self-hosting/govern/communication.md index ac9c812c..022bd5dc 100644 --- a/docs/self-hosting/govern/communication.md +++ b/docs/self-hosting/govern/communication.md @@ -1,7 +1,7 @@ --- title: Configure SMTP for email notifications description: Configure SMTP email settings for Plane. Setup email notifications and communication for your self-hosted instance. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +keywords: plane smtp, email notifications, smtp configuration, email setup, self-hosting, plane email, mail server --- diff --git a/docs/self-hosting/govern/configure-dns-email-service.md b/docs/self-hosting/govern/configure-dns-email-service.md index 0d306b5b..ac0e2320 100644 --- a/docs/self-hosting/govern/configure-dns-email-service.md +++ b/docs/self-hosting/govern/configure-dns-email-service.md @@ -1,7 +1,7 @@ --- title: Configure DNS for Intake Email -description: Learn how to configure dns for intake email for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Configure DNS MX records for Plane intake email. Route incoming emails to create work items automatically in your self-hosted instance. +keywords: plane dns configuration, mx records, intake email, email to issue, self-hosting, plane email setup, dns setup --- # Configure DNS for Intake Email diff --git a/docs/self-hosting/govern/configure-ssl.md b/docs/self-hosting/govern/configure-ssl.md index 30720b89..e10adad6 100644 --- a/docs/self-hosting/govern/configure-ssl.md +++ b/docs/self-hosting/govern/configure-ssl.md @@ -1,7 +1,7 @@ --- title: Set up SSL description: Configure SSL/TLS certificates for Plane. Setup HTTPS encryption for secure self-hosted Plane deployment. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration, ssl, https, security +keywords: plane ssl, https setup, tls certificate, ssl configuration, lets encrypt, secure deployment, self-hosting security --- diff --git a/docs/self-hosting/govern/custom-domain.md b/docs/self-hosting/govern/custom-domain.md index 812e570e..9deeff46 100644 --- a/docs/self-hosting/govern/custom-domain.md +++ b/docs/self-hosting/govern/custom-domain.md @@ -1,7 +1,7 @@ --- title: Configure custom domain description: Configure custom domain for self-hosted Plane. Setup your own domain name for your Plane instance. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +keywords: plane custom domain, domain setup, dns configuration, self-hosting, plane domain name, custom url --- # Configure custom domain diff --git a/docs/self-hosting/govern/database-and-storage.md b/docs/self-hosting/govern/database-and-storage.md index 37d7a0d3..ad901ab5 100644 --- a/docs/self-hosting/govern/database-and-storage.md +++ b/docs/self-hosting/govern/database-and-storage.md @@ -1,7 +1,7 @@ --- title: Configure external services description: Configure external database and storage for Plane. Setup PostgreSQL, Redis, and S3-compatible storage services. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +keywords: plane external database, postgresql setup, redis configuration, s3 storage, minio, self-hosting, plane storage --- diff --git a/docs/self-hosting/govern/environment-variables.md b/docs/self-hosting/govern/environment-variables.md index 190a57c9..b39445b9 100644 --- a/docs/self-hosting/govern/environment-variables.md +++ b/docs/self-hosting/govern/environment-variables.md @@ -1,7 +1,7 @@ --- title: Environment variables reference description: Configure environment variables for Plane. Complete reference of all configuration options and settings. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +keywords: plane environment variables, configuration reference, env settings, plane config, self-hosting settings, plane env --- diff --git a/docs/self-hosting/govern/external-secrets.md b/docs/self-hosting/govern/external-secrets.md index 4c917a7e..7c997d53 100644 --- a/docs/self-hosting/govern/external-secrets.md +++ b/docs/self-hosting/govern/external-secrets.md @@ -1,7 +1,7 @@ --- title: Configure external secrets for Kubernetes deployments -description: Learn how to configure external secrets for kubernetes deployments for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Use external secrets operators with Plane on Kubernetes. Integrate AWS Secrets Manager, HashiCorp Vault, or Azure Key Vault for secure configuration. +keywords: plane external secrets, kubernetes secrets, vault integration, aws secrets manager, secret management, self-hosting --- diff --git a/docs/self-hosting/govern/github-oauth.md b/docs/self-hosting/govern/github-oauth.md index a9a740f6..5617c21b 100644 --- a/docs/self-hosting/govern/github-oauth.md +++ b/docs/self-hosting/govern/github-oauth.md @@ -1,7 +1,7 @@ --- title: Github OAuth description: Configure GitHub OAuth authentication for Plane. Enable GitHub sign-in for your self-hosted Plane instance. -keywords: plane, self-hosting, deployment, plane installation, authentication, sso, oauth, configuration, administration +keywords: plane github oauth, github sign-in, github authentication, github login, oauth provider, self-hosting, plane sso --- diff --git a/docs/self-hosting/govern/google-oauth.md b/docs/self-hosting/govern/google-oauth.md index 6be9e673..9528cdee 100644 --- a/docs/self-hosting/govern/google-oauth.md +++ b/docs/self-hosting/govern/google-oauth.md @@ -1,7 +1,7 @@ --- title: Google OAuth description: Setup Google OAuth authentication for Plane. Step-by-step guide to enable Google sign-in for your self-hosted instance. -keywords: plane, self-hosting, deployment, plane installation, authentication, sso, oauth, configuration, administration +keywords: plane google oauth, google sign-in, google authentication, google login, oauth provider, self-hosting, plane sso --- diff --git a/docs/self-hosting/govern/instance-admin.md b/docs/self-hosting/govern/instance-admin.md index da53923b..8ae8f075 100644 --- a/docs/self-hosting/govern/instance-admin.md +++ b/docs/self-hosting/govern/instance-admin.md @@ -1,7 +1,7 @@ --- title: Instance admin and God mode description: Configure Plane instance admin settings. Learn about God mode and administrative controls for self-hosted Plane. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +keywords: plane instance admin, god mode, admin panel, plane administration, instance settings, self-hosting admin --- diff --git a/docs/self-hosting/govern/integrations/github.md b/docs/self-hosting/govern/integrations/github.md index 87a58883..7f85f97a 100644 --- a/docs/self-hosting/govern/integrations/github.md +++ b/docs/self-hosting/govern/integrations/github.md @@ -1,7 +1,7 @@ --- title: Configure GitHub for Plane integration -description: Learn how to configure github for plane integration for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Connect GitHub to your self-hosted Plane instance. Sync pull requests, commits, and branches with Plane work items for seamless development tracking. +keywords: plane github integration, github sync, pull request tracking, commit linking, github app, self-hosting, plane devops --- diff --git a/docs/self-hosting/govern/integrations/gitlab.md b/docs/self-hosting/govern/integrations/gitlab.md index 190cd433..bdb44415 100644 --- a/docs/self-hosting/govern/integrations/gitlab.md +++ b/docs/self-hosting/govern/integrations/gitlab.md @@ -1,7 +1,7 @@ --- title: Configure GitLab for Plane integration -description: Learn how to configure gitlab for plane integration for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Connect GitLab to your self-hosted Plane instance. Sync merge requests and commits with Plane work items for development workflow tracking. +keywords: plane gitlab integration, gitlab sync, merge request tracking, gitlab webhook, self-hosting, plane devops --- diff --git a/docs/self-hosting/govern/integrations/sentry.md b/docs/self-hosting/govern/integrations/sentry.md index ebe94100..c14e0208 100644 --- a/docs/self-hosting/govern/integrations/sentry.md +++ b/docs/self-hosting/govern/integrations/sentry.md @@ -1,7 +1,7 @@ --- title: Configure Sentry for Plane integration -description: Learn how to configure sentry for plane integration for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Connect Sentry error monitoring to your self-hosted Plane instance. Automatically create work items from Sentry alerts and track error resolution. +keywords: plane sentry integration, error tracking, sentry alerts, bug tracking, error monitoring, self-hosting, plane devops --- diff --git a/docs/self-hosting/govern/integrations/slack.md b/docs/self-hosting/govern/integrations/slack.md index 294a8743..0a417b47 100644 --- a/docs/self-hosting/govern/integrations/slack.md +++ b/docs/self-hosting/govern/integrations/slack.md @@ -1,7 +1,7 @@ --- title: Configure Slack for Plane integration -description: Learn how to configure slack for plane integration for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Connect Slack to your self-hosted Plane instance. Get notifications for work item updates and interact with Plane from Slack channels. +keywords: plane slack integration, slack notifications, slack bot, workspace notifications, slack webhook, self-hosting, plane communication --- diff --git a/docs/self-hosting/govern/ldap.md b/docs/self-hosting/govern/ldap.md index 7486f0fc..099c05fa 100644 --- a/docs/self-hosting/govern/ldap.md +++ b/docs/self-hosting/govern/ldap.md @@ -1,7 +1,7 @@ --- title: LDAP authentication description: Setup LDAP authentication for Plane. Configure Lightweight Directory Access Protocol for directory-based authentication. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +keywords: plane ldap, ldap authentication, active directory, directory service, ldap configuration, enterprise authentication, self-hosting --- diff --git a/docs/self-hosting/govern/oidc-sso.md b/docs/self-hosting/govern/oidc-sso.md index 1c2c6d63..be152bc6 100644 --- a/docs/self-hosting/govern/oidc-sso.md +++ b/docs/self-hosting/govern/oidc-sso.md @@ -1,7 +1,7 @@ --- title: OIDC SSO description: Setup OIDC SSO authentication for Plane. Configure OpenID Connect single sign-on for enterprise authentication. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +keywords: plane oidc, openid connect, sso configuration, single sign-on, oidc provider, enterprise sso, self-hosting --- diff --git a/docs/self-hosting/govern/private-bucket.md b/docs/self-hosting/govern/private-bucket.md index 035c2061..7f2db49a 100644 --- a/docs/self-hosting/govern/private-bucket.md +++ b/docs/self-hosting/govern/private-bucket.md @@ -1,7 +1,7 @@ --- title: Switch from public to private buckets • Commercial Edition -description: Learn how to switch from public to private buckets • commercial edition for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Switch Plane storage from public to private S3 buckets. Secure file uploads with signed URLs and access control for commercial editions. +keywords: plane private bucket, s3 private storage, signed urls, secure file uploads, storage migration, self-hosting, plane storage security --- diff --git a/docs/self-hosting/govern/reset-password.md b/docs/self-hosting/govern/reset-password.md index 8c7adde8..ac8c2489 100644 --- a/docs/self-hosting/govern/reset-password.md +++ b/docs/self-hosting/govern/reset-password.md @@ -1,7 +1,7 @@ --- title: Reset password -description: Learn how to reset password for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Reset user and admin passwords for self-hosted Plane. Recover access to your instance using CLI commands or database operations. +keywords: plane password reset, admin password recovery, plane account recovery, self-hosting, plane login issues --- diff --git a/docs/self-hosting/govern/reverse-proxy.md b/docs/self-hosting/govern/reverse-proxy.md index 3426fac7..5bde9a72 100644 --- a/docs/self-hosting/govern/reverse-proxy.md +++ b/docs/self-hosting/govern/reverse-proxy.md @@ -1,7 +1,7 @@ --- title: Configure external reverse proxy -description: Learn how to configure external reverse proxy for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +description: Configure Nginx, Caddy, or Traefik as a reverse proxy for self-hosted Plane. Setup upstream proxying, headers, and WebSocket support. +keywords: plane reverse proxy, nginx proxy, traefik, caddy, upstream proxy, proxy configuration, self-hosting --- diff --git a/docs/self-hosting/govern/saml-sso.md b/docs/self-hosting/govern/saml-sso.md index 7811a6d6..842c99c1 100644 --- a/docs/self-hosting/govern/saml-sso.md +++ b/docs/self-hosting/govern/saml-sso.md @@ -1,7 +1,7 @@ --- title: SAML SSO description: Configure SAML SSO authentication for Plane. Setup Security Assertion Markup Language for enterprise SSO. -keywords: plane, self-hosting, deployment, plane installation, configuration, administration +keywords: plane saml, saml sso, enterprise sso, saml configuration, identity provider, okta, azure ad, self-hosting --- diff --git a/docs/self-hosting/manage/backup-restore.md b/docs/self-hosting/manage/backup-restore.md index 68c88851..7a5f1375 100644 --- a/docs/self-hosting/manage/backup-restore.md +++ b/docs/self-hosting/manage/backup-restore.md @@ -1,7 +1,7 @@ --- title: Backup and restore data description: Backup and restore Plane data. Complete guide for backing up database, storage, and configuration files. -keywords: plane, self-hosting, deployment, plane installation, backup, restore, data management +keywords: plane backup, plane restore, database backup, postgresql backup, data recovery, plane data export, self-hosting --- diff --git a/docs/self-hosting/manage/community-to-airgapped.md b/docs/self-hosting/manage/community-to-airgapped.md index c689f1a7..7d7afd10 100644 --- a/docs/self-hosting/manage/community-to-airgapped.md +++ b/docs/self-hosting/manage/community-to-airgapped.md @@ -1,7 +1,7 @@ --- title: Upgrade from Community to Airgapped Edition description: Deploy Plane in airgapped environment without internet access. Complete guide for offline Plane installation. -keywords: plane, self-hosting, deployment, plane installation +keywords: plane community to airgapped, edition upgrade, airgapped migration, offline deployment, air-gapped plane, self-hosting --- diff --git a/docs/self-hosting/manage/manage-licenses/activate-airgapped.md b/docs/self-hosting/manage/manage-licenses/activate-airgapped.md index bf75282d..0363d5c8 100644 --- a/docs/self-hosting/manage/manage-licenses/activate-airgapped.md +++ b/docs/self-hosting/manage/manage-licenses/activate-airgapped.md @@ -1,7 +1,7 @@ --- title: Activate Airgapped Edition license -description: Deploy Plane in airgapped environment without internet access. Complete guide for offline Plane installation. -keywords: plane, self-hosting, deployment, plane installation +description: Activate and configure your Plane Airgapped Edition license. Offline license activation for air-gapped environments without internet access. +keywords: plane airgapped license, offline activation, air-gapped deployment, plane license key, self-hosting --- diff --git a/docs/self-hosting/manage/manage-licenses/activate-enterprise.md b/docs/self-hosting/manage/manage-licenses/activate-enterprise.md index 3bfaeaa3..ac04ca4e 100644 --- a/docs/self-hosting/manage/manage-licenses/activate-enterprise.md +++ b/docs/self-hosting/manage/manage-licenses/activate-enterprise.md @@ -1,7 +1,7 @@ --- title: Activate Enterprise license -description: Learn how to activate enterprise license for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Activate your Plane Enterprise Edition license. Enable advanced features including SAML SSO, audit logs, and custom roles for your self-hosted instance. +keywords: plane enterprise license, license activation, enterprise edition, plane enterprise features, self-hosting --- diff --git a/docs/self-hosting/manage/manage-licenses/activate-pro-and-business.md b/docs/self-hosting/manage/manage-licenses/activate-pro-and-business.md index 8415e2ea..76df737e 100644 --- a/docs/self-hosting/manage/manage-licenses/activate-pro-and-business.md +++ b/docs/self-hosting/manage/manage-licenses/activate-pro-and-business.md @@ -1,7 +1,7 @@ --- title: Activate Pro and Business licenses -description: Learn how to activate pro and business licenses for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Activate your Plane Pro or Business Edition license. Upgrade from Community Edition to unlock advanced project management features. +keywords: plane pro license, plane business license, license activation, commercial edition, plane upgrade, self-hosting --- diff --git a/docs/self-hosting/manage/migrate-plane.md b/docs/self-hosting/manage/migrate-plane.md index 53515d8d..eec5e506 100644 --- a/docs/self-hosting/manage/migrate-plane.md +++ b/docs/self-hosting/manage/migrate-plane.md @@ -1,7 +1,7 @@ --- title: Move Plane instance to a new server description: Migrate Plane between servers or environments. Guide for moving your Plane installation to new infrastructure. -keywords: plane, self-hosting, deployment, plane installation +keywords: plane migration, server migration, plane data transfer, infrastructure move, plane backup restore, self-hosting --- diff --git a/docs/self-hosting/manage/prime-cli.md b/docs/self-hosting/manage/prime-cli.md index a2af4e9c..e6a9c12c 100644 --- a/docs/self-hosting/manage/prime-cli.md +++ b/docs/self-hosting/manage/prime-cli.md @@ -1,7 +1,7 @@ --- title: Command line tools -description: Learn how to command line tools for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Use Plane Prime CLI for managing your self-hosted instance. Commands for setup, configuration, upgrades, and troubleshooting from the terminal. +keywords: plane cli, prime cli, command line tools, plane management, plane setup commands, self-hosting, plane terminal --- diff --git a/docs/self-hosting/manage/upgrade-from-0.13.2-0.14.0.md b/docs/self-hosting/manage/upgrade-from-0.13.2-0.14.0.md index 4b7d127a..f15dd883 100644 --- a/docs/self-hosting/manage/upgrade-from-0.13.2-0.14.0.md +++ b/docs/self-hosting/manage/upgrade-from-0.13.2-0.14.0.md @@ -1,7 +1,7 @@ --- title: Mandatory checkpoint at v0.14.0 description: Upgrade self-hosted Plane to the latest version. Step-by-step guide for updating your Plane installation safely. -keywords: plane, self-hosting, deployment, plane installation, upgrade, migration, update +keywords: plane v0.14 upgrade, mandatory checkpoint, plane migration 0.13, breaking changes, version upgrade, self-hosting update --- diff --git a/docs/self-hosting/manage/upgrade-plane.md b/docs/self-hosting/manage/upgrade-plane.md index ce659d30..80eb7849 100644 --- a/docs/self-hosting/manage/upgrade-plane.md +++ b/docs/self-hosting/manage/upgrade-plane.md @@ -1,7 +1,7 @@ --- title: Update Plane version description: Upgrade self-hosted Plane to the latest version. Step-by-step guide for updating your Plane installation safely. -keywords: plane, self-hosting, deployment, plane installation, upgrade, migration, update +keywords: plane version upgrade, update plane, plane latest version, upgrade guide, self-hosting update, plane migration --- diff --git a/docs/self-hosting/manage/view-logs.md b/docs/self-hosting/manage/view-logs.md index d7d3d803..c9e5316b 100644 --- a/docs/self-hosting/manage/view-logs.md +++ b/docs/self-hosting/manage/view-logs.md @@ -1,7 +1,7 @@ --- title: View container logs -description: Learn how to view container logs for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: View and debug container logs for self-hosted Plane. Monitor Docker and Kubernetes service logs to troubleshoot issues. +keywords: plane logs, container logs, docker logs, kubernetes logs, plane debugging, plane troubleshooting, self-hosting --- diff --git a/docs/self-hosting/methods/airgapped-edition-kubernetes.md b/docs/self-hosting/methods/airgapped-edition-kubernetes.md index 1e464069..ec004d81 100644 --- a/docs/self-hosting/methods/airgapped-edition-kubernetes.md +++ b/docs/self-hosting/methods/airgapped-edition-kubernetes.md @@ -1,7 +1,7 @@ --- title: Deploy Plane with airgapped Kubernetes description: Deploy Plane on Kubernetes using Helm charts. Complete guide for production-ready Kubernetes deployment with scaling and management. -keywords: plane, self-hosting, deployment, plane installation, kubernetes, helm, k8s +keywords: plane airgapped kubernetes, offline k8s deployment, air-gapped helm, kubernetes offline, plane helm airgapped, self-hosting --- diff --git a/docs/self-hosting/methods/airgapped-edition.md b/docs/self-hosting/methods/airgapped-edition.md index b0d07f4e..1cf63e97 100644 --- a/docs/self-hosting/methods/airgapped-edition.md +++ b/docs/self-hosting/methods/airgapped-edition.md @@ -1,7 +1,7 @@ --- title: Deploy Plane with Airgapped Docker description: Deploy Plane in airgapped environment without internet access. Complete guide for offline Plane installation. -keywords: plane, self-hosting, deployment, plane installation +keywords: plane airgapped, offline deployment, air-gapped docker, plane offline install, disconnected environment, self-hosting --- diff --git a/docs/self-hosting/methods/airgapped-requirements.md b/docs/self-hosting/methods/airgapped-requirements.md index dfebe8b8..822527a8 100644 --- a/docs/self-hosting/methods/airgapped-requirements.md +++ b/docs/self-hosting/methods/airgapped-requirements.md @@ -1,7 +1,7 @@ --- title: Airgapped deployment architecture -description: Deploy Plane in airgapped environment without internet access. Complete guide for offline Plane installation. -keywords: plane, self-hosting, deployment, plane installation +description: System requirements and architecture overview for Plane airgapped deployments. Hardware specs, network topology, and prerequisites for offline installations. +keywords: plane airgapped requirements, air-gapped architecture, offline prerequisites, system requirements, airgapped planning, self-hosting --- diff --git a/docs/self-hosting/methods/clone-docker-images.md b/docs/self-hosting/methods/clone-docker-images.md index 7677be58..73526abf 100644 --- a/docs/self-hosting/methods/clone-docker-images.md +++ b/docs/self-hosting/methods/clone-docker-images.md @@ -1,7 +1,7 @@ --- title: Clone Docker images to your private registry -description: Learn how to clone docker images to your private registry for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization +description: Mirror Plane Docker images to your private container registry. Pull, tag, and push images for airgapped or restricted network deployments. +keywords: plane docker images, private registry, container mirroring, docker pull, image cloning, airgapped docker, self-hosting --- diff --git a/docs/self-hosting/methods/coolify.md b/docs/self-hosting/methods/coolify.md index b167b379..f22c9892 100644 --- a/docs/self-hosting/methods/coolify.md +++ b/docs/self-hosting/methods/coolify.md @@ -1,7 +1,7 @@ --- title: Deploy Plane with Coolify -description: Learn how to deploy plane with coolify for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Deploy Plane using Coolify, an open-source PaaS. One-click deployment with automatic SSL, domain configuration, and container management. +keywords: plane coolify, coolify deployment, plane paas, one-click deployment, plane hosting platform, self-hosting --- # Deploy Plane with Coolify diff --git a/docs/self-hosting/methods/docker-aio.md b/docs/self-hosting/methods/docker-aio.md index 890780dc..92578365 100644 --- a/docs/self-hosting/methods/docker-aio.md +++ b/docs/self-hosting/methods/docker-aio.md @@ -1,7 +1,7 @@ --- title: Docker AIO (All-in-One) description: Deploy Plane with Docker All-in-One (AIO) setup. Quick installation guide for running Plane in a single Docker container. -keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization +keywords: plane docker aio, all-in-one container, single container deployment, quick install, plane docker setup, self-hosting --- diff --git a/docs/self-hosting/methods/docker-compose.md b/docs/self-hosting/methods/docker-compose.md index f302c3b4..0d87c7eb 100644 --- a/docs/self-hosting/methods/docker-compose.md +++ b/docs/self-hosting/methods/docker-compose.md @@ -1,7 +1,7 @@ --- title: Docker Compose description: Install Plane using Docker Compose. Step-by-step guide for deploying Plane with Docker on your server with all required services. -keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization +keywords: plane docker compose, docker deployment, container setup, docker install plane, plane containers, self-hosting --- diff --git a/docs/self-hosting/methods/docker-swarm.md b/docs/self-hosting/methods/docker-swarm.md index 8900fd63..46b24d2a 100644 --- a/docs/self-hosting/methods/docker-swarm.md +++ b/docs/self-hosting/methods/docker-swarm.md @@ -1,7 +1,7 @@ --- title: Deploy Plane with Docker Swarm description: Deploy Plane on Docker Swarm cluster. Guide for running Plane in a distributed Docker Swarm environment with high availability. -keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization +keywords: plane docker swarm, swarm deployment, distributed containers, high availability, plane cluster, docker orchestration, self-hosting --- # Deploy Plane with Docker Swarm diff --git a/docs/self-hosting/methods/install-methods-commercial/docker-compose.md b/docs/self-hosting/methods/install-methods-commercial/docker-compose.md index 284ee9fa..4accc9df 100644 --- a/docs/self-hosting/methods/install-methods-commercial/docker-compose.md +++ b/docs/self-hosting/methods/install-methods-commercial/docker-compose.md @@ -1,7 +1,7 @@ --- title: Docker Compose description: Install Plane using Docker Compose. Step-by-step guide for deploying Plane with Docker on your server with all required services. -keywords: plane, self-hosting, deployment, plane installation, docker, docker compose, containerization +keywords: plane commercial docker, commercial edition docker compose, plane pro docker, self-hosting commercial search: false sidebar: false head: diff --git a/docs/self-hosting/methods/install-methods-commercial/kubernetes.md b/docs/self-hosting/methods/install-methods-commercial/kubernetes.md index b828070c..814477b1 100644 --- a/docs/self-hosting/methods/install-methods-commercial/kubernetes.md +++ b/docs/self-hosting/methods/install-methods-commercial/kubernetes.md @@ -1,7 +1,7 @@ --- title: Kubernetes description: Deploy Plane on Kubernetes using Helm charts. Complete guide for production-ready Kubernetes deployment with scaling and management. -keywords: plane, self-hosting, deployment, plane installation, kubernetes, helm, k8s +keywords: plane commercial kubernetes, commercial edition helm, plane pro kubernetes, self-hosting commercial search: false sidebar: false head: diff --git a/docs/self-hosting/methods/kubernetes.md b/docs/self-hosting/methods/kubernetes.md index 17c6b329..0f36b08c 100644 --- a/docs/self-hosting/methods/kubernetes.md +++ b/docs/self-hosting/methods/kubernetes.md @@ -1,7 +1,7 @@ --- title: Kubernetes description: Deploy Plane on Kubernetes using Helm charts. Complete guide for production-ready Kubernetes deployment with scaling and management. -keywords: plane, self-hosting, deployment, plane installation, kubernetes, helm, k8s +keywords: plane kubernetes, helm chart, k8s deployment, kubernetes cluster, plane helm, production deployment, self-hosting --- # Kubernetes diff --git a/docs/self-hosting/methods/one-click.md b/docs/self-hosting/methods/one-click.md index 3ff1b8d2..d8806a00 100644 --- a/docs/self-hosting/methods/one-click.md +++ b/docs/self-hosting/methods/one-click.md @@ -1,7 +1,7 @@ --- title: One-click deploy -description: Learn how to one-click deploy for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Deploy Plane instantly with one-click installers on popular cloud providers. Quick setup on AWS, DigitalOcean, Render, and Railway. +keywords: plane one-click deploy, cloud deployment, aws plane, digitalocean plane, quick install, plane cloud hosting, self-hosting --- diff --git a/docs/self-hosting/methods/podman-quadlets.md b/docs/self-hosting/methods/podman-quadlets.md index 644f34ce..0e85aecd 100644 --- a/docs/self-hosting/methods/podman-quadlets.md +++ b/docs/self-hosting/methods/podman-quadlets.md @@ -1,7 +1,7 @@ --- title: Deploy Plane with Podman Quadlets description: Install Plane using Podman Quadlets. Guide for deploying Plane with Podman as a Docker alternative with systemd integration. -keywords: plane, self-hosting, deployment, plane installation +keywords: plane podman, podman quadlets, systemd containers, docker alternative, rootless containers, plane podman deployment, self-hosting --- diff --git a/docs/self-hosting/methods/portainer.md b/docs/self-hosting/methods/portainer.md index 7ca03798..b5460396 100644 --- a/docs/self-hosting/methods/portainer.md +++ b/docs/self-hosting/methods/portainer.md @@ -1,7 +1,7 @@ --- title: Deploy Plane with Portainer -description: Learn how to deploy plane with portainer for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Deploy and manage Plane using Portainer container management UI. Visual Docker management with stack deployment and monitoring. +keywords: plane portainer, portainer deployment, docker management ui, plane container management, portainer stack, self-hosting --- # Deploy Plane with Portainer diff --git a/docs/self-hosting/plane-architecture.md b/docs/self-hosting/plane-architecture.md index c81a1801..eb514de4 100644 --- a/docs/self-hosting/plane-architecture.md +++ b/docs/self-hosting/plane-architecture.md @@ -1,7 +1,7 @@ --- title: Plane self-hosted architecture -description: Learn how to plane self-hosted architecture for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Understand Plane self-hosted architecture including web server, API, workers, database, Redis, and storage components. System requirements and service topology. +keywords: plane architecture, plane system design, plane components, plane services, postgresql, redis, minio, plane infrastructure --- diff --git a/docs/self-hosting/telemetry.md b/docs/self-hosting/telemetry.md index 6b3a0420..54dabc8d 100644 --- a/docs/self-hosting/telemetry.md +++ b/docs/self-hosting/telemetry.md @@ -1,7 +1,7 @@ --- title: Data collection and usage -description: Learn how to data collection and usage for self-hosted Plane. Complete guide with step-by-step instructions. -keywords: plane, self-hosting, deployment, plane installation +description: Understand what telemetry data Plane collects, how it is used, and how to opt out. Privacy-focused data collection for self-hosted instances. +keywords: plane telemetry, data collection, plane privacy, analytics opt-out, plane usage data, self-hosted privacy --- diff --git a/docs/self-hosting/troubleshoot/cli-errors.md b/docs/self-hosting/troubleshoot/cli-errors.md index 637614d7..800903f4 100644 --- a/docs/self-hosting/troubleshoot/cli-errors.md +++ b/docs/self-hosting/troubleshoot/cli-errors.md @@ -1,7 +1,7 @@ --- title: CLI errors description: Troubleshoot cli errors. Common issues, error messages, and solutions for self-hosted Plane. -keywords: plane, self-hosting, deployment, plane installation +keywords: plane cli errors, prime cli troubleshooting, command line issues, plane cli fix, self-hosting troubleshooting --- diff --git a/docs/self-hosting/troubleshoot/installation-errors.md b/docs/self-hosting/troubleshoot/installation-errors.md index 514b1a85..e9150db6 100644 --- a/docs/self-hosting/troubleshoot/installation-errors.md +++ b/docs/self-hosting/troubleshoot/installation-errors.md @@ -1,7 +1,7 @@ --- title: Installation errors description: Troubleshoot installation errors. Common issues, error messages, and solutions for self-hosted Plane. -keywords: plane, self-hosting, deployment, plane installation +keywords: plane installation errors, deployment issues, docker errors, kubernetes errors, plane setup troubleshooting, self-hosting --- diff --git a/docs/self-hosting/troubleshoot/license-errors.md b/docs/self-hosting/troubleshoot/license-errors.md index 3eee629e..1b99137b 100644 --- a/docs/self-hosting/troubleshoot/license-errors.md +++ b/docs/self-hosting/troubleshoot/license-errors.md @@ -1,7 +1,7 @@ --- title: License errors -description: Manage Plane licenses for Pro, Business, and Enterprise editions. Activation guide for commercial Plane licenses. -keywords: plane, self-hosting, deployment, plane installation +description: Troubleshoot Plane license activation errors. Fix common issues with Pro, Business, Enterprise, and Airgapped license keys. +keywords: plane license errors, license activation issues, license troubleshooting, plane license fix, commercial license, self-hosting --- diff --git a/docs/self-hosting/troubleshoot/storage-errors.md b/docs/self-hosting/troubleshoot/storage-errors.md index 68035d88..1a785743 100644 --- a/docs/self-hosting/troubleshoot/storage-errors.md +++ b/docs/self-hosting/troubleshoot/storage-errors.md @@ -1,7 +1,7 @@ --- title: Storage errors -description: Configure external database and storage for Plane. Setup PostgreSQL, Redis, and S3-compatible storage services. -keywords: plane, self-hosting, deployment, plane installation +description: Troubleshoot Plane storage and upload errors. Fix S3, MinIO, and file upload issues for self-hosted Plane instances. +keywords: plane storage errors, s3 errors, minio issues, file upload errors, storage troubleshooting, plane uploads, self-hosting --- diff --git a/docs/self-hosting/upgrade-from-community.md b/docs/self-hosting/upgrade-from-community.md index 310652be..450c5737 100644 --- a/docs/self-hosting/upgrade-from-community.md +++ b/docs/self-hosting/upgrade-from-community.md @@ -1,7 +1,7 @@ --- title: Upgrade from Community to Commercial Edition description: Upgrade self-hosted Plane to the latest version. Step-by-step guide for updating your Plane installation safely. -keywords: plane, self-hosting, deployment, plane installation, upgrade, migration, update +keywords: plane upgrade community to commercial, edition migration, plane pro upgrade, plane business upgrade, self-hosting upgrade --- # Upgrade from Community to Commercial Edition