Skip to content

Commit 5e2ea12

Browse files
update docs (sourcegraph#58008)
1 parent ace36c7 commit 5e2ea12

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

Diff for: doc/admin/config/batch_changes.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ GitHub Apps are also the recommended way to [sync repositories on GitHub](../ext
198198

199199
<!-- NOTE: The instructions in the following sections closely mirror those in doc/admin/external_service/github.md. When making changes here, be sure to consider if those changes should also be made over there! -->
200200

201-
To create a GitHub App for commit signing and connect it to Sourcegraph:
201+
To create a GitHub App for commit signing and connect it to Sourcegraph:
202202

203-
1. Go to **Site admin > Batch Changes > Settings** on Sourcegraph.
203+
1. Go to **Site admin > Batch Changes > Settings** on Sourcegraph.
204204

205205
<img alt="The Batch Changes settings page on Sourcegraph, scrolled to show commit signing integrations" src="https://sourcegraphstatic.com/docs/images/administration/config/github-apps/github-apps-batches-list.png" class="screenshot theme-light-only" />
206206
<img alt="The Batch Changes settings page on Sourcegraph, scrolled to show commit signing integrations" src="https://sourcegraphstatic.com/docs/images/administration/config/github-apps/github-apps-batches-list-dark.png" class="screenshot theme-dark-only" />
@@ -236,7 +236,7 @@ To create a GitHub App for commit signing and connect it to Sourcegraph:
236236

237237
The initial GitHub App setup will only install the App on the organization or user account that you registered it with. If your code is spread across multiple organizations or user accounts, you will need to create additional installations for each namespace that you want Batch Changes to be able to sign commits in.
238238

239-
By default, Sourcegraph creates a private GitHub App, which only allows the App to be installed on the same organization or user account that it was created in. If you did not set the App to public visibility during creation, you will need to [change the visibility](https://docs.github.com/en/apps/maintaining-github-apps/modifying-a-github-app#changing-the-visibility-of-a-github-app) to public before you can install it in other namespaces. For security considerations, see [GitHub's documentation on private vs public apps](https://docs.github.com/en/apps/creating-github-apps/setting-up-a-github-app/making-a-github-app-public-or-private).
239+
By default, Sourcegraph creates a private GitHub App, which only allows the App to be installed on the same organization or user account that it was created in. If you did not set the App to public visibility during creation, you will need to [change the visibility](https://docs.github.com/en/apps/maintaining-github-apps/modifying-a-github-app#changing-the-visibility-of-a-github-app) to public before you can install it in other namespaces. For security considerations, see [GitHub's documentation on private vs public apps](https://docs.github.com/en/apps/creating-github-apps/setting-up-a-github-app/making-a-github-app-public-or-private).
240240

241241
Once public, App can be installed in additional namespaces either from Sourcegraph or from GitHub.
242242

@@ -286,7 +286,7 @@ Installation access tokens are short-lived, non-refreshable tokens that give Sou
286286

287287
<span class="badge badge-note">Sourcegraph 5.1.5+</span>
288288

289-
If you are using a self-signed certificate for your GitHub Enterprise instance, configure `tls.external` under `experimentalFeatures`
289+
If you are using a self-signed certificate for your GitHub Enterprise instance, configure `tls.external` under `experimentalFeatures`
290290
in the **Site configuration** with your certificate(s).
291291

292292
```json
@@ -300,3 +300,10 @@ in the **Site configuration** with your certificate(s).
300300
}
301301
}
302302
```
303+
304+
### Ownership
305+
306+
When a user is deleted, their Batch Changes become inaccessible in the UI but the data is not permanently deleted.
307+
This allows recovering the Batch Changes if the user is restored.
308+
309+
However, if the user deletion is permanent, deleting both account and data, then the associated Batch Changes are also permanently deleted from the database. This frees storage space and removes dangling references.

Diff for: doc/batch_changes/explanations/introduction_to_batch_changes.md

+7
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,13 @@ A single batch change can span many repositories and many code hosts.
4949

5050
To learn about the internals of Batch Changes, see [Batch Changes](../../../dev/background-information/batch_changes/index.md) in the developer documentation.
5151

52+
## Ownership
53+
54+
When a user is deleted, their Batch Changes become inaccessible in the UI but the data is not permanently deleted.
55+
This allows recovering the Batch Changes if the user is restored.
56+
57+
However, if the user deletion is permanent, deleting both account and data, then the associated Batch Changes are also permanently deleted from the database. This frees storage space and removes dangling references.
58+
5259
## Known issues
5360

5461
- Batch Changes currently support **GitHub**, **GitLab** and **Bitbucket Server and Bitbucket Data Center** repositories. If you're interested in using Batch Changes on other code hosts, [let us know](https://about.sourcegraph.com/contact).

0 commit comments

Comments
 (0)