Separate the github and gitlab enterprise into separate pages#225
Open
sriramveeraghanta wants to merge 1 commit intomasterfrom
Open
Separate the github and gitlab enterprise into separate pages#225sriramveeraghanta wants to merge 1 commit intomasterfrom
sriramveeraghanta wants to merge 1 commit intomasterfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis pull request reorganizes integration documentation by splitting GitHub and GitLab guides into separate cloud and enterprise/self-managed versions. Two new deployment-specific guides are added, existing cloud guides are simplified with cross-references, and navigation configuration is updated to link the new enterprise guides. Changes
Poem
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 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
🧹 Nitpick comments (1)
docs/self-hosting/govern/integrations/gitlab-self-managed.md (1)
55-64: Consider nesting scope bullets under the “Scopes” item for readability.This is easier to scan if the individual scopes are nested as sub-bullets.
♻️ Suggested markdown tweak
- **Scopes** Select the following scopes to grant Plane the necessary permissions: -- **api** - Grants complete read/write access to the API, including all groups and projects -- **read_api** - Grants read access to the API, including all groups and projects -- **read_user** - Grants read-only access to your profile information -- **read_repository** - Grants read-only access to repositories on private projects -- **profile** - Grants read-only access to the user's profile data using OpenID Connect -- **email** - Grants read-only access to the user's primary email address using OpenID Connect + - **api** - Grants complete read/write access to the API, including all groups and projects + - **read_api** - Grants read access to the API, including all groups and projects + - **read_user** - Grants read-only access to your profile information + - **read_repository** - Grants read-only access to repositories on private projects + - **profile** - Grants read-only access to the user's profile data using OpenID Connect + - **email** - Grants read-only access to the user's primary email address using OpenID Connect🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/govern/integrations/gitlab-self-managed.md` around lines 55 - 64, The "Scopes" section currently lists individual scope items at the same level as the heading; update the markdown so the "Scopes" heading remains a top-level bullet and the individual scope entries (api, read_api, read_user, read_repository, profile, email) are indented as nested sub-bullets under that "Scopes" item to improve readability and scanning.
🤖 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-enterprise.md`:
- Line 55: Replace inconsistent capitalization in the document by standardizing
the product name and acronyms: change every occurrence of "Github" to "GitHub"
(search for the literal "Github") and change lowercase "url" to uppercase "URL"
where it refers to web addresses (search for the literal "url"); update the
instances found near the verification text that mentions workspace connection
with the Github App and the other occurrences referenced in the review so all
user-facing strings consistently use "GitHub" and "URL".
- Line 157: The sentence "Convert the Private key to convert it to base64"
contains duplicated phrasing; update that line so it reads succinctly (e.g.,
"Convert the private key to base64" or "Convert the private key into base64")
and normalize capitalization of "private key" to lowercase to match surrounding
style; ensure the rest of the step remains unchanged.
---
Nitpick comments:
In `@docs/self-hosting/govern/integrations/gitlab-self-managed.md`:
- Around line 55-64: The "Scopes" section currently lists individual scope items
at the same level as the heading; update the markdown so the "Scopes" heading
remains a top-level bullet and the individual scope entries (api, read_api,
read_user, read_repository, profile, email) are indented as nested sub-bullets
under that "Scopes" item to improve readability and scanning.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/.vitepress/config.mtsdocs/self-hosting/govern/integrations/github-enterprise.mddocs/self-hosting/govern/integrations/github.mddocs/self-hosting/govern/integrations/gitlab-self-managed.mddocs/self-hosting/govern/integrations/gitlab.md
| https://<your-domain>/silo/api/oauth/github-enterprise/auth/user/callback | ||
| ``` | ||
|
|
||
| These URLs allow Plane to verify and enable workspace connection with the Github App. |
There was a problem hiding this comment.
Normalize product-name and acronym capitalization.
Line 55, Line 214, and Line 218 use “Github” instead of “GitHub”, and Line 152 uses “url” instead of “URL”. Please standardize these to avoid inconsistencies in user-facing docs.
✏️ Suggested wording fixes
- These URLs allow Plane to verify and enable workspace connection with the Github App.
+ These URLs allow Plane to verify and enable workspace connection with the GitHub App.
- - App Slug (You can find this in browser url)
+ - App Slug (You can find this in browser URL)
-### Github integration suddenly stopped working after a while
+### GitHub integration suddenly stopped working after a while
-1. Make sure you've `opted out` of Server Token expiration and reconnect once again to the organization account to Plane. Check in Github App Settings > Optional Features
+1. Make sure you've `opted out` of Server Token expiration and reconnect once again to the organization account to Plane. Check in GitHub App Settings > Optional FeaturesAlso applies to: 152-152, 214-218
🧰 Tools
🪛 LanguageTool
[uncategorized] ~55-~55: The official name of this software platform is spelled with a capital “H”.
Context: ...nd enable workspace connection with the 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-enterprise.md` at line 55,
Replace inconsistent capitalization in the document by standardizing the product
name and acronyms: change every occurrence of "Github" to "GitHub" (search for
the literal "Github") and change lowercase "url" to uppercase "URL" where it
refers to web addresses (search for the literal "url"); update the instances
found near the verification text that mentions workspace connection with the
Github App and the other occurrences referenced in the review so all user-facing
strings consistently use "GitHub" and "URL".
| - Client secret | ||
| - Private key | ||
|
|
||
| 7. Convert the Private key to convert it to base64. Since private keys are typically multi-line, they can cause parsing errors or issues when setting environment variables. To avoid this, run the following command to convert the key to base64: |
There was a problem hiding this comment.
Fix duplicated phrasing in the private-key step.
Line 157 repeats “convert” twice, which makes the instruction awkward.
✏️ Suggested wording fix
-7. Convert the Private key to convert it to base64. Since private keys are typically multi-line, they can cause parsing errors or issues when setting environment variables. To avoid this, run the following command to convert the key to base64:
+7. Convert the private key to base64. Since private keys are typically multi-line, they can cause parsing errors or issues when setting environment variables. To avoid this, run the following command:📝 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
| 7. Convert the Private key to convert it to base64. Since private keys are typically multi-line, they can cause parsing errors or issues when setting environment variables. To avoid this, run the following command to convert the key to base64: | |
| 7. Convert the private key to base64. Since private keys are typically multi-line, they can cause parsing errors or issues when setting environment variables. To avoid this, run the following command: |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/self-hosting/govern/integrations/github-enterprise.md` at line 157, The
sentence "Convert the Private key to convert it to base64" contains duplicated
phrasing; update that line so it reads succinctly (e.g., "Convert the private
key to base64" or "Convert the private key into base64") and normalize
capitalization of "private key" to lowercase to match surrounding style; ensure
the rest of the step remains unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit