Skip to content

SEO fixes for integrations page #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sriramveeraghanta merged 3 commits into from
Mar 2, 2026
Merged

SEO fixes for integrations page #229

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ca8507
SEO fixes for integrations page
danciaclara Mar 2, 2026
f5dead2
formatting fixes
danciaclara Mar 2, 2026
e50a5d2
minor fix
danciaclara Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/self-hosting/govern/integrations/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configure GitHub for Plane integration
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
keywords: plane github integration, github cloud, github enterprise, github sync, pull request tracking, commit linking, github app,
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Fix frontmatter keywords formatting to unblock CI.

Line 4 has a trailing comma/space in keywords, which is consistent with the reported Prettier failure.

Proposed fix 
-keywords: plane github integration, github cloud, github enterprise, github sync, pull request tracking, commit linking, github app, 
+keywords: plane github integration, github cloud, github enterprise, github sync, pull request tracking, commit linking, github app

As per coding guidelines, "**/*.{ts,tsx,js,jsx,vue,json,md,mts}: Prettier formatting checks must pass in CI, with 120 character line width, 2-space indent, semicolons, double quotes, and ES5 trailing commas".

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
keywords: plane github integration, github cloud, github enterprise, github sync, pull request tracking, commit linking, github app,
keywords: plane github integration, github cloud, github enterprise, github sync, pull request tracking, commit linking, github app
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/self-hosting/govern/integrations/github.md` at line 4, The frontmatter
`keywords` entry has a trailing comma/space causing Prettier to fail; edit the
YAML frontmatter in docs/self-hosting/govern/integrations/github.md and remove
the trailing comma/space from the `keywords:` value (or convert it to a proper
YAML list) so the `keywords` line no longer ends with ", " and conforms to the
project's Prettier rules; ensure the `keywords` key is a valid comma-separated
string or list without a trailing comma.

---

# Configure GitHub for Plane integration <Badge type="info" text="Pro" />
Expand Down Expand Up @@ -36,6 +36,10 @@ To configure GitHub integration, you'll need to create a GitHub App within your

== GitHub Cloud {#github-cloud}

Follow these steps to create a GitHub App, set callback URLs, and configure webhooks so Plane can sync PRs and commits from GitHub Cloud.

#### GitHub Cloud

Comment on lines +39 to +42
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Use consistent heading depth under section context.

Line 39 (#### GitHub Cloud) jumps heading depth and triggers MD001. The same pattern appears at Line 85 for the enterprise subsection. Use ### to avoid heading increment warnings.

Proposed fix 
-#### GitHub Cloud
+### GitHub Cloud
...
-#### GitHub Enterprise Server
+### GitHub Enterprise Server

Also applies to: 85-86

🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 39-39: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/self-hosting/govern/integrations/github.md` around lines 39 - 42, The
markdown uses a deeper heading level (####) for "GitHub Cloud" and the
enterprise subsection which breaks the heading hierarchy and triggers MD001;
update the heading tokens for the "GitHub Cloud" and the enterprise subsection
headings from '####' to '###' so they consistently sit under the parent section
and avoid heading increment warnings.

1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization.

2. Click **New GitHub App**.
Expand Down Expand Up @@ -76,6 +80,9 @@ To configure GitHub integration, you'll need to create a GitHub App within your
![Add Webhook URL](/images/integrations/github/add-webhook-url.webp)

== GitHub Enterprise Server {#github-enterprise-server}
These steps cover hostname, callback URLs, and private key differences for on‑prem GitHub deployments.

#### GitHub Enterprise Server

1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization.

Expand Down
11 changes: 10 additions & 1 deletion docs/self-hosting/govern/integrations/gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configure GitLab for Plane integration
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
keywords: plane gitlab integration, gitlab.com, gitlab self-managed, gitlab sync, merge request tracking
---

# Configure GitLab for Plane integration <Badge type="info" text="Pro" />
Expand Down Expand Up @@ -33,6 +33,11 @@ After creating and configuring the GitLab application and configuring the instan

== GitLab Cloud {#gitlab-cloud}

Follow these steps to register an application on the public GitLab service, set the redirect URI and scopes,
and then configure your Plane instance so it can sync merge requests and commits.

#### GitLab Cloud

1. On the left sidebar in GitLab, select your avatar.

2. Select **Preferences** tab.
Expand Down Expand Up @@ -67,6 +72,10 @@ After creating and configuring the GitLab application and configuring the instan

== GitLab Self-managed {#gitlab-self-managed}

These instructions cover registering an OAuth app on your private GitLab server, using the correct callback URLs, and assigning the required scopes for Plane to access your repos and users.

#### GitLab Self-managed

1. Log in to your GitLab instance.
2. Click on your profile icon in the top-right corner.
3. From the dropdown menu that appears, select **Edit profile**.
Expand Down
Loading