openedx / edx-django-utils

edX utilities for Django Application development.
https://edx.readthedocs.io/projects/edx-django-utils/en/latest/
Apache License 2.0
26 stars 20 forks source link

update doc outline and extract how tos #128

Closed robrap closed 3 years ago

robrap commented 3 years ago

Description:

docs: update published doc outline

Updates the doc index to provide some minor enhancements, and to include the monitoring decisions and how-tos.

See docs/monitoring/README.rst for the decision on how these docs were included.

Here is a screenshot of the new outline:

Screen Shot 2021-05-17 at 3 49 09 PM

docs: refactor squad and theme name change how to

Extracts the following new how tos:

Author concerns:

I'm uncertain about how I included the monitoring docs in the outline, but I didn't wanted to be blocked and I wanted to be able to point to these docs from the runbook.

Merge checklist: