Skip to content

Commit 454a07e

Browse files
committed
📝 Add Documentation for Deleting Account
1 parent e1017d6 commit 454a07e

File tree

3 files changed

+145
-0
lines changed

3 files changed

+145
-0
lines changed

docs/guides/delete-account.md

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
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+
- Organizations and Repositories: All organizations and repositories integrated with CodeRabbit.
17+
- Learnings and Insights: All data generated by the CodeRabbit AI Bot.
18+
- Subscriptions and Billing: All subscription details and billing information.
19+
- Settings: All repository and organization level settings configured by you.
20+
- Reports: All recurring reports created by you.
21+
- Integrations: All connections with third-party services such as Jira, Linear, etc., established by you.
22+
23+
:::
24+
25+
### Deleting the CodeRabbit Account via the UI
26+
27+
:::info
28+
29+
Only accounts where the user has admin access will be deleted.
30+
31+
:::
32+
33+
Sign into your CodeRabbit account and navigate to the **Subscription** page.
34+
35+
Select the orange colored **Delete Account** button just below the Manage
36+
Subscription button. If you do not see the button, then likely you are not an
37+
admin user for that specific organization. Upon selecting a organization which
38+
as admin access, the button will appear.
39+
40+
A Modal informing the user about the result of deleting the account will appear.
41+
You can open the dropdowns for more information. The information provided will
42+
be included in this guide further below.
43+
44+
<div align="center">
45+
![Delete Account](./images/delete_account_light.png#gh-light-mode-only)
46+
![Delete Account](./images/delete_account_dark.png#gh-dark-mode-only)
47+
</div>
48+
49+
Deletion will only occur once the user specifically types in "delete" in the
50+
input box provided.
51+
52+
You will be redirected to the login page once the account is deleted. Please
53+
look at the next section for additional steps required by the user.
54+
55+
### What if I just want to restrict access to one or more organizations?
56+
57+
In the **GitHub** UI, you can simply uninstall the CodeRabbit Github App and
58+
CodeRabbit OAuth App for the organization(s).
59+
60+
In the **GitLab** UI, you can simply uninstall the CodeRabbit webhook from the
61+
project(s) and remove the CodeRabbit Bot user from the members list within the
62+
project(s).
63+
64+
:::info
65+
66+
CodeRabbit does not use any data ever for training purposes for **Pro** plan
67+
users. CodeRabbit does not store any of your codebase on its servers. Any code
68+
that is processed in real-time during the review process is thrown away upon
69+
completion of the review and is never stored.
70+
71+
:::
72+
73+
## Additional Steps Required by the User
74+
75+
### GitHub
76+
77+
#### Remove / Revoke the CodeRabbit OAuth App from your GitHub account
78+
79+
1. Navigate to your Organizations settings on GitHub
80+
2. Click on <strong>OAuth Application Policy</strong>
81+
3. Select the pencil icon next to <strong>coderabbitai</strong>
82+
4. Click <strong>Revoke</strong> to remove permissions
83+
84+
#### Uninstall the CodeRabbit GitHub App from your GitHub account
85+
86+
1. Navigate to your Organizations settings on GitHub.
87+
2. Click on <strong>GitHub Apps</strong> on the left sidebar.
88+
3. Select <strong>Configure</strong>
89+
4. Select <strong>Uninstall</strong> near the bottom of the page
90+
91+
### GitLab and Self-Hosted GitLab
92+
93+
#### Remove / Revoke the CodeRabbit OAuth App from your GitLab account
94+
95+
1. Navigate to your <strong>User Settings</strong> in GitLab
96+
2. Click on <strong>Applications</strong>
97+
3. Click <strong>Revoke</strong> on the CodeRabbit application and confirm
98+
99+
#### Uninstall the CodeRabbit Webhook from your GitLab account
100+
101+
1. Navigate to your <strong>Group</strong> where you installed CodeRabbit in the
102+
GitLab UI
103+
2. Select a project you installed CodeRabbit on, Hover over{" "}
104+
<strong>Settings</strong> and select{" "} <strong>Webhooks</strong>
105+
3. Select <strong>Delete</strong> and confirm the deletion the project hook.
106+
4. Select <strong>Uninstall</strong> near the bottom of the page
107+
108+
#### Uninstall the CodeRabbit Bot User from your GitLab account
109+
110+
1. Navigate to your <strong>Group</strong> where you installed CodeRabbit in the
111+
GitLab UI
112+
2. Select a project you installed CodeRabbit on, Hover over{" "}
113+
<strong>Manage</strong> and select <strong>Members</strong>
114+
3. Select <strong>Remove Member</strong> and confirm to remove the CodeRabbit
115+
from your project
116+
117+
:::warning
118+
119+
The steps are necessary to completely off-board CodeRabbit from your
120+
GitHub/GitLab account. Failure to do so will result in CodeRabbit still having
121+
permissions to your GitHub/GitLab account, although no data will be processed.
122+
123+
Signing back in without completing the above steps will re-introduce a minimal
124+
set of data being stored as a part of the sign in process.
125+
126+
:::
127+
128+
## Conclusion
129+
130+
If you've reached here and decided to delete your CodeRabbit account, we're sad
131+
to see you go 😢.
132+
133+
If you have any pending questions or need assistance, please feel free to reach
134+
out to our support team.
135+
136+
We appreciate your time and feedback. Happy coding! 🚀
137+
138+
:::note
139+
140+
We welcome all types of feedback and suggestions to help us improve our product.
141+
Please feel free to leave us a message telling us what you did or did not like
142+
about CodeRabbit on our [Discord](https://discord.gg/8Q5ZJj6) or via
143+
[Email](mailto:support@coderabbit.ai).
144+
145+
:::
67.6 KB
Loading
70 KB
Loading

0 commit comments

Comments
 (0)