SEO fixes for integrations page#229
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation updates for GitHub and GitLab integration guides, introducing platform-specific subsections for Cloud and on-premises deployments. Keywords metadata refined and introductory guidance paragraphs added to clarify setup distinctions between each platform variant. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/self-hosting/govern/integrations/github.md`:
- Around line 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.
- 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.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/self-hosting/govern/integrations/github.mddocs/self-hosting/govern/integrations/gitlab.md
| 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, |
There was a problem hiding this comment.
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 appAs 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.
| 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.
| 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 | ||
|
|
There was a problem hiding this comment.
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 ServerAlso 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.
2 participants
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit