Skip to content

Update delete organization page with Azure DevOps info #102

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 30, 2024

Conversation

petrisorcoderabbit
Copy link
Contributor

@petrisorcoderabbit petrisorcoderabbit commented Sep 30, 2024

Summary by CodeRabbit

  • Documentation
    • Updated guide on deleting a CodeRabbit account, highlighting the permanence of the action and data loss.
    • Added steps for uninstalling CodeRabbit from Azure DevOps.
    • Retained and clarified sections for GitHub and GitLab integrations.
    • Included a warning about the importance of completing uninstallation steps.

Copy link
Contributor

coderabbitaidev bot commented Sep 30, 2024

Walkthrough

The documentation for deleting a CodeRabbit account has been updated to include a detailed guide on the process, highlighting the irreversible nature of account deletion and the data loss involved. A new section specifically addresses the steps for uninstalling CodeRabbit from Azure DevOps, while existing sections for GitHub and GitLab have been modified for clarity. A warning has been added to emphasize the importance of following the outlined steps to ensure complete off-boarding from CodeRabbit.

Changes

File Path Change Summary
docs/guides/delete-account.md Updated to include a guide on deleting a CodeRabbit account, added Azure DevOps uninstallation steps, and modified GitHub/GitLab sections for clarity. A warning about the importance of the steps has also been included.

🪧 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 24c2734
Status: ✅  Deploy successful!
Preview URL: https://f1ea4e34.coderabbit-docs.pages.dev
Branch Preview URL: https://update-delete-org-docs-with.coderabbit-docs.pages.dev

View logs

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

🧹 Outside diff range and nitpick comments (2)
docs/guides/delete-account.md (2)

100-109: LGTM! Consider these minor improvements for clarity and consistency.

The new Azure DevOps section is well-structured and provides clear instructions for uninstalling CodeRabbit. However, consider the following suggestions to enhance the documentation:

  1. Update the numbering of steps to be more specific, e.g.:

    1. Navigate to your <strong>Project Settings</strong> in the Azure DevOps UI where CodeRabbit is installed.
    2. Under <strong>Project Settings</strong>, go to <strong>Service Hooks</strong>.
    3. Select the webhooks that are added by CodeRabbit.
    4. Click the <strong>Delete</strong> icon at the top of the page.
    5. Remove the CodeRabbit user:
       a. Navigate to <strong>Project Settings</strong> > <strong>Permissions</strong>.
       b. Find and remove the CodeRabbit user.
    6. Delete the <strong>Personal Access Token</strong>:
       a. Go to your Azure DevOps profile settings.
       b. Select <strong>Personal Access Tokens</strong>.
       c. Find the token associated with CodeRabbit and revoke it.
  2. Add a brief explanation of what a Personal Access Token is and why it needs to be deleted.


Line range hint 111-119: Update the warning message to include Azure DevOps.

For consistency and completeness, please update the warning message to include Azure DevOps. Here's a suggested revision:

:::warning

The steps are necessary to completely off-board CodeRabbit from your
GitHub/GitLab/Azure DevOps account. Failure to do so will result in CodeRabbit still having
permissions to your GitHub/GitLab/Azure DevOps account, although no data will be processed.

Signing back in without completing the above steps will re-introduce a minimal
set of data being stored as a part of the sign in process.

:::

This change ensures that users of all supported platforms are aware of the importance of following the uninstallation steps.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 97113ad and 24c2734.

📒 Files selected for processing (1)
  • docs/guides/delete-account.md (1 hunks)

@aravindputrevu aravindputrevu merged commit 71f9429 into main Sep 30, 2024
2 checks passed
@aravindputrevu aravindputrevu deleted the update-delete-org-docs-with-azure-devops-info branch September 30, 2024 23:02
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