1655770 - Improve Frost Documentation

Status: ASSIGNED

(Cloud Services :: Operations: Metrics/Monitoring, task)

Description

[Brian Pitts]

We should ensure there is quality documentation for several scenarios

Brainstorming list in https://docs.google.com/document/d/1c61_BOjOs2CB5sQ88Ov3O51s_Uep1_RsO_TadkwYnHk/edit#

Comment 1

[AJ Bahnken [:ajvb] (she/her)]

:bobm - FYI hwine started on some documentation around frost in this branch: https://github.com/mozilla/frost/compare/FAQ

Comment 2

[Brian Pitts]

Capturing a decision from slack:

Generic documentation will go in the frost repo.

Mozilla-specific documentation will go in the foxsec-automation repo.

Comment 3

[Sven Marnach :sven]

I will start with these steps:

• Write some introduction text describing what Frost is in the README.
• Move most documentation from the README to the docs folder.
• Set up GitHub Pages to serve the Sphinx documentation, including CircleCI setup.

Comment 4

[AJ Bahnken [:ajvb] (she/her)]

Sounds good Sven. Just so you know, Github Pages are set up already (https://mozilla.github.io/frost/), but are built off of the docs/ directory in the master branch.

Comment 5

[hwine]

(In reply to AJ Bahnken [:ajvb] from comment #1)

:bobm - FYI hwine started on some documentation around frost in this branch: https://github.com/mozilla/frost/compare/FAQ

Update: live docs

• doc source is default branch docs directory
• doc rebuild is make doc-build from workspace root, then push.

Comment 6

[Bob Micheletto [:bobm]]

Created a PR for adding a new AWS account to the automated scans.

Comment 7

[Bob Micheletto [:bobm]]

(In reply to Bob Micheletto [:bobm] from comment #6)

Created a PR for adding a new AWS account to the automated scans.

Landed.

Comment 8

[Bob Micheletto [:bobm]]

Created a PR for adding a Getting Started section.