Skip to content

📝 Add Documentation for Deleting Account #55

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 4 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
📝 Add Documentation for Deleting Account
  • Loading branch information
karan925 committed Jun 26, 2024
commit 454a07eb24cb159b791b27795fbc349d90e50a09
145 changes: 145 additions & 0 deletions docs/guides/delete-account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
---
title: Delete CodeRabbit Account
sidebar_label: Delete CodeRabbit Account
# description:
sidebar_position: 3
---

The guide explains how to delete your CodeRabbit account and all the data
associated with it.

:::danger Irreversible Account Deletion

Deleting your CodeRabbit account is permanent and cannot be undone. This action
will permanently erase all data associated with your account, including:

- Organizations and Repositories: All organizations and repositories integrated with CodeRabbit.
- Learnings and Insights: All data generated by the CodeRabbit AI Bot.
- Subscriptions and Billing: All subscription details and billing information.
- Settings: All repository and organization level settings configured by you.
- Reports: All recurring reports created by you.
- Integrations: All connections with third-party services such as Jira, Linear, etc., established by you.

:::

### Deleting the CodeRabbit Account via the UI

:::info

Only accounts where the user has admin access will be deleted.

:::

Sign into your CodeRabbit account and navigate to the **Subscription** page.

Select the orange colored **Delete Account** button just below the Manage
Subscription button. If you do not see the button, then likely you are not an
admin user for that specific organization. Upon selecting a organization which
as admin access, the button will appear.

A Modal informing the user about the result of deleting the account will appear.
You can open the dropdowns for more information. The information provided will
be included in this guide further below.

<div align="center">
![Delete Account](./images/delete_account_light.png#gh-light-mode-only)
![Delete Account](./images/delete_account_dark.png#gh-dark-mode-only)
</div>

Deletion will only occur once the user specifically types in "delete" in the
input box provided.

You will be redirected to the login page once the account is deleted. Please
look at the next section for additional steps required by the user.

### What if I just want to restrict access to one or more organizations?

In the **GitHub** UI, you can simply uninstall the CodeRabbit Github App and
CodeRabbit OAuth App for the organization(s).

In the **GitLab** UI, you can simply uninstall the CodeRabbit webhook from the
project(s) and remove the CodeRabbit Bot user from the members list within the
project(s).

:::info

CodeRabbit does not use any data ever for training purposes for **Pro** plan
users. CodeRabbit does not store any of your codebase on its servers. Any code
that is processed in real-time during the review process is thrown away upon
completion of the review and is never stored.

:::

## Additional Steps Required by the User

### GitHub

#### Remove / Revoke the CodeRabbit OAuth App from your GitHub account

1. Navigate to your Organizations settings on GitHub
2. Click on <strong>OAuth Application Policy</strong>
3. Select the pencil icon next to <strong>coderabbitai</strong>
4. Click <strong>Revoke</strong> to remove permissions

#### Uninstall the CodeRabbit GitHub App from your GitHub account

1. Navigate to your Organizations settings on GitHub.
2. Click on <strong>GitHub Apps</strong> on the left sidebar.
3. Select <strong>Configure</strong>
4. Select <strong>Uninstall</strong> near the bottom of the page

### GitLab and Self-Hosted GitLab

#### Remove / Revoke the CodeRabbit OAuth App from your GitLab account

1. Navigate to your <strong>User Settings</strong> in GitLab
2. Click on <strong>Applications</strong>
3. Click <strong>Revoke</strong> on the CodeRabbit application and confirm

#### Uninstall the CodeRabbit Webhook from your GitLab account

1. Navigate to your <strong>Group</strong> where you installed CodeRabbit in the
GitLab UI
2. Select a project you installed CodeRabbit on, Hover over{" "}
<strong>Settings</strong> and select{" "} <strong>Webhooks</strong>
3. Select <strong>Delete</strong> and confirm the deletion the project hook.
4. Select <strong>Uninstall</strong> near the bottom of the page

#### Uninstall the CodeRabbit Bot User from your GitLab account

1. Navigate to your <strong>Group</strong> where you installed CodeRabbit in the
GitLab UI
2. Select a project you installed CodeRabbit on, Hover over{" "}
<strong>Manage</strong> and select <strong>Members</strong>
3. Select <strong>Remove Member</strong> and confirm to remove the CodeRabbit
from your project

:::warning

The steps are necessary to completely off-board CodeRabbit from your
GitHub/GitLab account. Failure to do so will result in CodeRabbit still having
permissions to your GitHub/GitLab 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.

:::

## Conclusion

If you've reached here and decided to delete your CodeRabbit account, we're sad
to see you go 😢.

If you have any pending questions or need assistance, please feel free to reach
out to our support team.

We appreciate your time and feedback. Happy coding! 🚀

:::note

We welcome all types of feedback and suggestions to help us improve our product.
Please feel free to leave us a message telling us what you did or did not like
about CodeRabbit on our [Discord](https://discord.gg/8Q5ZJj6) or via
[Email](mailto:[email protected]).

:::
Binary file added docs/guides/images/delete_account_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/images/delete_account_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.