Skip to content

Conversation

danciaclara
Copy link
Collaborator

@danciaclara danciaclara commented Oct 7, 2025

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • GitHub integration guides: cleaned up numbered list formatting for clearer step-by-step readability.
    • GitLab integration docs: major restructure into tabbed paths for GitLab Cloud and Self-managed, with separate instructions, screenshots, and visuals.
    • Expanded setup guidance: detailed OAuth application steps, redirect URI examples, confidentiality notes, and comprehensive scopes table.
    • Configuration improvements: clearer activation steps, credential copying, and environment variable guidance tailored to each edition.
    • Updated links to edition-specific pages for consistent navigation.

Copy link

vercel bot commented Oct 7, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
developer-docs Error Error Oct 7, 2025 10:59am

Copy link

coderabbitai bot commented Oct 7, 2025

Walkthrough

Documentation updates in self-hosting/govern/integrations: GitHub guide receives indentation-only formatting fixes; GitLab guide is restructured into tabbed Cloud vs Self-managed flows with updated steps, screenshots, links, and scoped permissions, plus configuration and activation details tailored per edition.

Changes

Cohort / File(s) Summary
GitHub docs formatting
self-hosting/govern/integrations/github.mdx
Tightens numbered list indentation in GitHub Cloud and Enterprise Server sections; no content or logic changes.
GitLab docs restructure (tabs, edition-specific)
self-hosting/govern/integrations/gitlab.mdx
Rewrites guide into Tabs for GitLab Cloud vs Self-managed; adds activation warning, step-by-step app creation, redirect URI and scopes details, edition-specific links, per-tab configuration steps, and updated images.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

I thump my paws on docs so neat,
Tabs now split each GitLab beat.
Cloud to self-host, paths align,
Links refreshed, permissions fine.
GitHub lists are trimmed just right—
Hop, hop! Formatting light.
Carrots raised to merge tonight. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title “GitLab self-managed configuration” refers to a real part of the changeset by highlighting the self-managed setup, but it does not fully capture the broader dual-path restructuring of the GitLab integration documentation which now includes both cloud and self-managed guides.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch gitlab-self-managed

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
self-hosting/govern/integrations/github.mdx (1)

75-134: Restore ordered-list indentation inside the GitHub Enterprise tab.

Dropping the two leading spaces before list items 2‑7 breaks the numbered list inside the tab—MDX treats them as separate paragraphs, so the order resets in the rendered docs. Please re-indent those items (match the Cloud tab) to preserve the sequence.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf59ae3 and 57cc722.

📒 Files selected for processing (2)
  • self-hosting/govern/integrations/github.mdx (3 hunks)
  • self-hosting/govern/integrations/gitlab.mdx (2 hunks)

Comment on lines +47 to +63

![Add app details](/images/integrations/gitlab/add-app-details.webp)

8. Set permissions by selecting the required **Scopes**. The table below explains each scope:

|Permission|Explanation|
|----------|-----------|
|`api`|Grants full read/write access to the API, including all groups, projects, container registry, dependency proxy, and package registry. Required for API requests.|
|`read_api`|Allows read-only access to all groups, projects, container registry, and package registry.|
|`read_user`|Grants read-only access to user profiles via the /user API endpoint, including username, public email, and full name. Also provides access to /users endpoints.|
|`read_repository`|Enables read-only access to repositories in private projects via Git-over-HTTP or the Repository Files API.|
|`write_repository`|Allows read/write access to repositories on private projects via Git-over-HTTP (not through the API).|
|`profile`|Grants read-only access to the user's profile data using OpenID Connect.|
|`email`|Provides read-only access to the user's primary email address using OpenID Connect.|

9. Click **Save Application** to finalize the setup.
</Tab>
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Mark the app as confidential—secret is required later.

Step 7 says the Confidential checkbox is optional, but the Configure Plane section instructs users to copy the application “Secret.” GitLab only issues a secret when the application is confidential, so leaving it unchecked breaks the integration flow. Please update the instructions to require Confidential.

🤖 Prompt for AI Agents
In self-hosting/govern/integrations/gitlab.mdx around lines 47 to 63, the guide
currently treats the "Confidential" checkbox as optional while later instructing
users to copy the application's Secret; since GitLab only issues a secret for
confidential applications, change the step to require selecting "Confidential"
(mark it as required/checked) and update any related wording to instruct users
to check the Confidential box so the application Secret will be generated for
use in Configure Plane.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants