mozilla-services/shavar

Move all shavar + shavar lists docs to README or readthedocs

Opened this issue · 1 comments

We have multiple repos that work together with shavar server and have an associated work process that should be documented. In addition, we have shavar server test documentation spread in various wikis, etc. that should probably be consolidated here as well.

DEPLOY PROCESSES

LIST VETTING

see: Shavar - list vetting (google doc)

TEST

GENERAL DOCUMENTATION

https://wiki.mozilla.org/Services/TrackingProtection
github repo:https://github.com/mozilla-services/shavar/

TESTPLANS

client-side:
https://wiki.mozilla.org/QA/Polaris/Tracking_protection

server-side:
https://wiki.mozilla.org/Services/TrackingProtection/Shavar_Server_-_Testing

Also,

steps for decommissioning a list

(per @ckolos)

  1. Remove the list config from the shavar-list-creation-config repo files (stage/prod).ini (mozilla-services/shavar-list-creation-config) This will stop the jenkins tasks from building the digest files and the s3 digests will no longer be updated
  2. Remove the server list config from the shavar-server-list-config repo (mozilla-services/shavar-server-list-config) This will, pending upcoming commits, stop the server from serving the digest file to clients
  3. Once confirmed that the list is no longer being served by the server, remove the list from the stage/prod shavar digest bucket
    Cleanup from step 3
  4. Once all the above has been done, remove the list source repo (wherever that is)
    Cleanup overall.