Skip to content

Commit 33a7f28

Browse files
authoredJun 27, 2024··
📝 Add Documentation for Deleting Account (#55)
1 parent 4f9a044 commit 33a7f28

File tree

3 files changed

+109
-0
lines changed

3 files changed

+109
-0
lines changed
 

‎docs/guides/delete-account.md

+109
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: Delete CodeRabbit Account
3+
sidebar_label: Delete CodeRabbit Account
4+
# description:
5+
sidebar_position: 3
6+
---
7+
8+
The guide explains how to delete your CodeRabbit account and all the data
9+
associated with it.
10+
11+
:::danger Irreversible Account Deletion
12+
13+
Deleting your CodeRabbit account is permanent and cannot be undone. This action
14+
will permanently erase all data associated with your account, including:
15+
16+
- Organization and Repositories: The organization and repositories integrated with CodeRabbit.
17+
- For Self-Hosted GitLab users, all the organizations and repositories data will be removed from CodeRabbit servers.
18+
- Learnings and Insights: All data generated by the CodeRabbit AI Bot.
19+
- Subscriptions and Billing: All subscription details and billing information.
20+
- Settings: All repository and organization level settings configured by you.
21+
- Reports: All recurring reports created by you.
22+
- Integrations: All connections with third-party services such as Jira, Linear, etc., established by you.
23+
24+
:::
25+
26+
### Deleting the CodeRabbit Account via the UI
27+
28+
:::info
29+
30+
Only accounts where the user has admin access will be deleted.
31+
32+
:::
33+
34+
Sign into your CodeRabbit account and navigate to the **Subscription** page.
35+
36+
Select the orange colored **Delete Account** button just below the Manage
37+
Subscription button. If you do not see the button, then likely you are not an
38+
admin user for that specific organization. Upon selecting a organization which
39+
as admin access, the button will appear.
40+
41+
A Modal informing the user about the result of deleting the account will open
42+
upon selecting **Delete Account**. You can open the dropdowns for more
43+
information.
44+
45+
<div align="center">
46+
![Delete Account](./images/delete_account_light.png#gh-light-mode-only)
47+
![Delete Account](./images/delete_account_dark.png#gh-dark-mode-only)
48+
</div>
49+
50+
Deletion will only occur once the admin specifically types in "delete" in the
51+
input box provided.
52+
53+
You will be redirected to the login page once the account is deleted. Please
54+
look at the next section for additional steps required by the user.
55+
56+
## Additional Steps Required by the User
57+
58+
### GitHub
59+
60+
#### Remove / Revoke the CodeRabbit OAuth App from your GitHub account
61+
62+
1. Navigate to your Organizations settings on GitHub
63+
2. Click on <strong>OAuth Application Policy</strong>
64+
3. Select the pencil icon next to <strong>coderabbitai</strong>
65+
4. Click <strong>Revoke</strong> to remove permissions
66+
67+
#### Uninstall the CodeRabbit GitHub App from your GitHub account
68+
69+
1. Navigate to your Organizations settings on GitHub.
70+
2. Click on <strong>GitHub Apps</strong> on the left sidebar.
71+
3. Select <strong>Configure</strong>
72+
4. Select <strong>Uninstall</strong> near the bottom of the page
73+
74+
### GitLab and Self-Hosted GitLab
75+
76+
#### Remove / Revoke the CodeRabbit OAuth App from your GitLab account
77+
78+
1. Navigate to your <strong>User Settings</strong> in GitLab
79+
2. Click on <strong>Applications</strong>
80+
3. Click <strong>Revoke</strong> on the CodeRabbit application and confirm
81+
82+
#### Uninstall the CodeRabbit Webhook from your GitLab account
83+
84+
1. Navigate to your <strong>Group</strong> where you installed CodeRabbit in the
85+
GitLab UI
86+
2. Select a project you installed CodeRabbit on, Hover over{" "}
87+
<strong>Settings</strong> and select{" "} <strong>Webhooks</strong>
88+
3. Select <strong>Delete</strong> and confirm the deletion the project hook.
89+
4. Select <strong>Uninstall</strong> near the bottom of the page
90+
91+
#### Uninstall the CodeRabbit Bot User from your GitLab account
92+
93+
1. Navigate to your <strong>Group</strong> where you installed CodeRabbit in the
94+
GitLab UI
95+
2. Select a project you installed CodeRabbit on, Hover over{" "}
96+
<strong>Manage</strong> and select <strong>Members</strong>
97+
3. Select <strong>Remove Member</strong> and confirm to remove the CodeRabbit
98+
from your project
99+
100+
:::warning
101+
102+
The steps are necessary to completely off-board CodeRabbit from your
103+
GitHub/GitLab account. Failure to do so will result in CodeRabbit still having
104+
permissions to your GitHub/GitLab account, although no data will be processed.
105+
106+
Signing back in without completing the above steps will re-introduce a minimal
107+
set of data being stored as a part of the sign in process.
108+
109+
:::
74.8 KB
Loading
76.8 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.