diff --git a/docs/getting-started.rst b/docs/getting-started.rst index daabfdf3..63d53797 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -132,3 +132,26 @@ If you want to accelerate the process of getting your collection deployed or adj .. note:: Only members of the `mozilla/all-wg` workgroup have read access to this repository. If you are part of the `mozilla` Github organization, you can request your membership via the https://github.com/orgs/mozilla/teams/remote-settings-collections-owners/members team. + + +.. _collection-offboarding: + +Collection Offboarding +---------------------- + +If you want to decommission a collection, please `open a Bugzilla ticket `_. + +Alternatively, if you have access to the `remote-settings-permissions `_ repository, you can fork it and run the following command from its root directory: + +.. code-block:: bash + + ./manage.py deletecollection COLECTION_NAME + +And open a pull-request with the command output as description (See `this example _`). + +.. note:: + + Deleting a collection is irreversible and will delete all its records and attachments. + + The collection won't be listed in the monitor/changes list, and clients will stop synchronizing it. + However, the clients' local data will remain stored in users' profiles.