diff --git a/docs/guides/delete-account.md b/docs/guides/delete-account.md new file mode 100644 index 00000000..425a2b01 --- /dev/null +++ b/docs/guides/delete-account.md @@ -0,0 +1,109 @@ +--- +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: + + - Organization and Repositories: The organization and repositories integrated with CodeRabbit. + - For Self-Hosted GitLab users, all the organizations and repositories data will be removed from CodeRabbit servers. + - 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 open +upon selecting **Delete Account**. You can open the dropdowns for more +information. + +<div align="center"> + + +</div> + +Deletion will only occur once the admin 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. + +## 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. + +::: diff --git a/docs/guides/images/delete_account_dark.png b/docs/guides/images/delete_account_dark.png new file mode 100644 index 00000000..d420bd37 Binary files /dev/null and b/docs/guides/images/delete_account_dark.png differ diff --git a/docs/guides/images/delete_account_light.png b/docs/guides/images/delete_account_light.png new file mode 100644 index 00000000..3d44aa33 Binary files /dev/null and b/docs/guides/images/delete_account_light.png differ