Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Create a new official type of Remote Settings
Basically, you will have to go through these 3 steps:

1. Design your data model (see below) and prepare the list of colleagues that will be allowed to review your data
2. Request the creation of your collection using `this Bugzilla ticket template <https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=mathieu%40mozilla.com&bug_file_loc=http%3A%2F%2F&bug_ignored=0&bug_severity=normal&bug_status=NEW&bug_type=task&cf_accessibility_severity=---&cf_fx_iteration=---&cf_fx_points=---&cf_status_conduit_push=---&cf_status_firefox153=---&cf_status_firefox154=---&cf_status_firefox155=---&cf_status_firefox_esr115=---&cf_status_firefox_esr140=---&cf_status_firefox_esr153=---&cf_tracking_conduit_push=---&cf_tracking_firefox153=---&cf_tracking_firefox154=---&cf_tracking_firefox155=---&cf_tracking_firefox_esr115=---&cf_tracking_firefox_esr140=---&cf_tracking_firefox_esr153=---&cf_tracking_firefox_relnote=---&comment=Collection%20name%3A%20_____%20%28eg.%20fingerprint-fonts%2C%20focus-experiments%2C%20...%29%0D%0ADescription%3A%20...%0D%0AEstimated%20collection%20size%3A%20%20%7EX%20records%2C%20%28%7EY%20kB%20as%20serialized%20JSON%29%0D%0A%0D%0AAllow%20file%20attachments%20on%20records%3A%20%28yes%2Fno%29%0D%0AAre%20attachments%20required%20on%20records%20%28yes%2Fno%29%0D%0ABundle%20all%20attachments%20in%20one%20archive%20for%20faster%20sync%20on%20new%20profiles%3F%20%28yes%2Fno%29%0D%0AEstimated%20size%20of%20attachments%3F%20%28note%3A%20files%20over%2020MB%20will%20be%20blocked%20if%20not%20explicitly%20allowed%29%0D%0AEstimated%20frequency%2Fsize%20of%20attachments%20updates%3A%20___%20%20%28eg.%20X%20kB%20per%20week%29%0D%0A%0D%0A%28optional%29%20List%20of%20fields%20names%20to%20display%20as%20columns%20in%20the%20records%20list%20UI%3A%20%28eg.%20%22name%22%2C%20%22details.size%22%29%0D%0A%28optional%29%20JSON%20schema%20to%20validate%20records%20%28in%20YAML%20format%29%3A%20%28eg.%20https%3A%2F%2Fgist.github.com%2Fleplatrem%2F4d86d5a64a56b5d8990be9af592d0e7f%29%0D%0A%28optional%29%20Manual%20records%20ID%3A%20%28yes%2Fno%29%0D%0A%28optional%29%20JEXL%20target%20filters%3A%20%28yes%2Fno%29%0D%0A%0D%0AList%20of%20LDAP%20emails%20allowed%20to%20change%20the%20records%20%28editors%29%3A%0D%0A%20-%20user1%40mozilla.com%0D%0A%20-%20...%0D%0A%0D%0AList%20of%20LDAP%20emails%20allowed%20to%20approve%20the%20changes%20%28reviewers%29%2C%20if%20different%20from%20editors.%0D%0A%20-%20user1%40mozilla.com%0D%0A%20-%20...%0D%0A&component=Server%3A%20Remote%20Settings&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-37=X&flag_type-607=X&flag_type-708=X&flag_type-721=X&flag_type-737=X&flag_type-748=X&flag_type-787=X&flag_type-803=X&flag_type-846=X&flag_type-864=X&flag_type-936=X&flag_type-963=X&flag_type-968=X&flag_type-970=X&groups=mozilla-employee-confidential&needinfo_role=other&needinfo_type=needinfo_from&op_sys=Unspecified&priority=--&product=Cloud%20Services&rep_platform=Unspecified&short_desc=Please%20create%20the%20new%20collection%20%22_____%22&target_milestone=---&version=unspecified>`_
2. Request the creation of your collection using `this Bugzilla ticket template <https://bugzilla.mozilla.org/enter_bug.cgi?bug_file_loc=http%3A%2F%2F&bug_ignored=0&bug_severity=normal&bug_status=NEW&bug_type=task&cf_accessibility_severity=---&cf_fx_iteration=---&cf_fx_points=---&cf_status_conduit_push=---&cf_status_firefox153=---&cf_status_firefox154=---&cf_status_firefox155=---&cf_status_firefox_esr115=---&cf_status_firefox_esr140=---&cf_status_firefox_esr153=---&cf_tracking_conduit_push=---&cf_tracking_firefox153=---&cf_tracking_firefox154=---&cf_tracking_firefox155=---&cf_tracking_firefox_esr115=---&cf_tracking_firefox_esr140=---&cf_tracking_firefox_esr153=---&cf_tracking_firefox_relnote=---&comment=Collection%20name%3A%20_____%20%28eg.%20fingerprint-fonts%2C%20focus-experiments%2C%20...%29%0D%0A%28optional%29%20Bucket%3A%20%28default%3A%20main%29%0D%0ADescription%3A%20...%0D%0ACost%20center%3A%20_____%20%28numeric%2C%20eg.%201234%29%0D%0AEstimated%20collection%20size%3A%20%20~X%20records%2C%20%28~Y%20kB%20as%20serialized%20JSON%29%0D%0A%0D%0AList%20of%20LDAP%20emails%20allowed%20to%20change%20the%20records%20%28editors%29%3A%0D%0A%20-%20user1%40mozilla.com%0D%0A%20-%20...%0D%0A%0D%0AList%20of%20LDAP%20emails%20allowed%20to%20approve%20the%20changes%20%28reviewers%29%2C%20if%20different%20from%20editors.%0D%0A%20-%20user1%40mozilla.com%0D%0A%20-%20...%0D%0A%0D%0AAllow%20file%20attachments%20on%20records%3A%20%28yes%2Fno%29%0D%0AAre%20attachments%20required%20on%20records%20%28yes%2Fno%29%0D%0ABundle%20all%20attachments%20in%20one%20archive%20for%20faster%20sync%20on%20new%20profiles%3F%20%28yes%2Fno%29%0D%0AEstimated%20size%20of%20attachments%3F%20%28note%3A%20files%20over%2020MB%20will%20be%20blocked%20if%20not%20explicitly%20allowed%29%0D%0AEstimated%20frequency%2Fsize%20of%20attachments%20updates%3A%20___%20%20%28eg.%20X%20kB%20per%20week%29%0D%0A%0D%0A%28optional%29%20JEXL%20target%20filters%3A%20%28yes%2Fno%29%0D%0A%28optional%29%20JSON%20schema%20to%20validate%20records%20%28in%20YAML%20format%29%3A%20%28eg.%20https%3A%2F%2Fgist.github.com%2Fleplatrem%2F4d86d5a64a56b5d8990be9af592d0e7f%29%0D%0A%28optional%29%20Manual%20records%20ID%3A%20%28yes%2Fno%29%0D%0A%28optional%29%20UI%20schema%20to%20customize%20the%20record%20form%20%28in%20YAML%20format%29%3A%20%28see%20https%3A%2F%2Frjsf-team.github.io%2Freact-jsonschema-form%2Fdocs%2Fapi-reference%2FuiSchema%29%0D%0A%28optional%29%20List%20of%20fields%20names%20to%20display%20as%20columns%20in%20the%20records%20list%20UI%3A%20%28eg.%20%22name%22%2C%20%22details.size%22%29%0D%0A&component=Server%3A%20Remote%20Settings&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-37=X&flag_type-607=X&flag_type-708=X&flag_type-721=X&flag_type-737=X&flag_type-748=X&flag_type-787=X&flag_type-803=X&flag_type-846=X&flag_type-864=X&flag_type-936=X&flag_type-963=X&flag_type-968=X&flag_type-970=X&groups=mozilla-employee-confidential&needinfo_role=other&needinfo_type=needinfo_from&op_sys=Unspecified&priority=--&product=Cloud%20Services&rep_platform=Unspecified&short_desc=Please%20create%20the%20new%20collection%20%22_____%22&target_milestone=---&version=unspecified>`_
3. While the collection is being created, setup the `Mozilla VPN <https://mana.mozilla.org/wiki/display/IT/Mozilla+Corporate+VPN>`_. If you are mentioned as an editor or reviewer, you will be given the appropriate VPN group automatically.

Once done, you will be able to login and edit your records on the Admin UIs:
Expand Down Expand Up @@ -180,7 +180,7 @@ If you want to accelerate the process of getting your collection deployed or adj
Collection Offboarding
----------------------

If you want to decommission a collection, please `open a Bugzilla ticket <https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=mathieu%40mozilla.com&bug_ignored=0&bug_severity=--&bug_status=NEW&cf_accessibility_severity=---&cf_fx_iteration=---&cf_fx_points=---&cf_status_conduit_push=---&cf_status_firefox148=---&cf_status_firefox149=---&cf_status_firefox150=---&cf_status_firefox_esr115=---&cf_status_firefox_esr140=---&cf_tracking_conduit_push=---&cf_tracking_firefox148=---&cf_tracking_firefox149=---&cf_tracking_firefox150=---&cf_tracking_firefox_esr115=---&cf_tracking_firefox_esr140=---&cf_tracking_firefox_relnote=---&component=Server%3A%20Remote%20Settings&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-37=X&flag_type-607=X&flag_type-708=X&flag_type-721=X&flag_type-737=X&flag_type-748=X&flag_type-787=X&flag_type-803=X&flag_type-846=X&flag_type-864=X&flag_type-936=X&flag_type-963=X&flag_type-968=X&needinfo_role=other&needinfo_type=needinfo_from&op_sys=Unspecified&priority=--&product=Cloud%20Services&rep_platform=Unspecified&short_desc=Please%20delete%20the%20collection%20%60NAME%60&target_milestone=---&version=unspecified>`_.
If you want to decommission a collection, please `open a Bugzilla ticket <https://bugzilla.mozilla.org/enter_bug.cgi?bug_ignored=0&bug_severity=--&bug_status=NEW&cf_accessibility_severity=---&cf_fx_iteration=---&cf_fx_points=---&cf_status_conduit_push=---&cf_status_firefox148=---&cf_status_firefox149=---&cf_status_firefox150=---&cf_status_firefox_esr115=---&cf_status_firefox_esr140=---&cf_tracking_conduit_push=---&cf_tracking_firefox148=---&cf_tracking_firefox149=---&cf_tracking_firefox150=---&cf_tracking_firefox_esr115=---&cf_tracking_firefox_esr140=---&cf_tracking_firefox_relnote=---&component=Server%3A%20Remote%20Settings&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-37=X&flag_type-607=X&flag_type-708=X&flag_type-721=X&flag_type-737=X&flag_type-748=X&flag_type-787=X&flag_type-803=X&flag_type-846=X&flag_type-864=X&flag_type-936=X&flag_type-963=X&flag_type-968=X&needinfo_role=other&needinfo_type=needinfo_from&op_sys=Unspecified&priority=--&product=Cloud%20Services&rep_platform=Unspecified&short_desc=Please%20delete%20the%20collection%20%60NAME%60&target_milestone=---&version=unspecified>`_.

Alternatively, if you have access to the `remote-settings-permissions <https://github.com/mozilla/remote-settings-permissions/pulls>`_ repository, you can fork it and run the following command from its root directory:

Expand Down
Loading