Skip to content

added gitlab update image and self hosted doc #92

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.

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
merged 1 commit into from
Sep 6, 2024

Conversation

dikshant-infracloud
Copy link
Contributor

@dikshant-infracloud dikshant-infracloud commented Sep 6, 2024

This PR is being raised as the image for access token was confusing and docs for self hosted have mentioned wrong scopes which do not exist

Summary by CodeRabbit

  • Documentation
    • Updated instructions for selecting scopes when creating a personal access token in self-hosted GitLab to enhance clarity and align with current security practices.

Copy link
Contributor

coderabbitaidev bot commented Sep 6, 2024

Walkthrough

The documentation for self-hosted GitLab has been updated to reflect a change in the required scopes for creating a personal access token. Users are now instructed to select the scopes api read_api read_user instead of the previous api user email. This adjustment aligns the permissions with updated functionality or security practices.

Changes

Files Change Summary
docs/platforms/self-hosted-gitlab.md Updated instructions for personal access token scopes from api user email to api read_api read_user.

Tip

CodeRabbit's handle has changed from @coderabbitai to @coderabbitaidev. Please use the new handle for all interactions.


Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitaidev in a new review comment at the desired location with your query. Examples:
    • @coderabbitaidev generate unit testing code for this file.
    • @coderabbitaidev modularize this function.
  • PR comments: Tag @coderabbitaidev in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitaidev generate interesting stats about this repository and render them as a table.
    • @coderabbitaidev show all the console.log statements in this repository.
    • @coderabbitaidev read src/utils.ts and generate unit testing code.
    • @coderabbitaidev read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitaidev help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitaidev pause to pause the reviews on a PR.
  • @coderabbitaidev resume to resume the paused reviews.
  • @coderabbitaidev review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitaidev full review to do a full review from scratch and review all the files again.
  • @coderabbitaidev summary to regenerate the summary of the PR.
  • @coderabbitaidev resolve resolve all the CodeRabbit review comments.
  • @coderabbitaidev configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitaidev help to get help.

Other keywords and placeholders

  • Add @coderabbitaidev ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitaidev summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitaidev or @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitaidev coderabbitaidev 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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fecb639 and a9b0f7f.

Files ignored due to path filters (1)
  • static/img/integrations/admin-access-token.png is excluded by !**/*.png, !**/*.png and included by none
Files selected for processing (1)
  • docs/platforms/self-hosted-gitlab.md (1 hunks)
Additional comments not posted (1)
docs/platforms/self-hosted-gitlab.md (1)

91-91: Scope Update Approved

The update to the scopes required for the personal access token is approved. The new scopes api read_api read_user are correctly listed.

However, it would enhance the documentation to include a brief explanation of what each scope entails. This can help users understand why these specific scopes are necessary and how they affect the functionality.

[suggestion]
Consider adding descriptions for each scope to improve clarity:

- `api`: Allows access to all API endpoints except those that explicitly require higher privileges.
- `read_api`: Grants read access to the API, which includes various GET requests to retrieve information.
- `read_user`: Allows access to read the user's profile and other personal information.

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.

3 participants