New strategy for managing documentation
Created on February 27, 2018. Copied from redmine (https://bugs.ligo.org/redmine/issues/6108)
Currently, GraceDB provides Sphinx-built user and admin documentation via the web interface. This is served by Apache via an extremely clunky mechanism which requires duplicates of the server's CSS and JS files in the documentation folders for use by Sphinx.
Proposing a new way of managing documentation:
- Divide user documentation into two parts:
- FAQ/Help page written in Django views/templates and hosted on GraceDB. Describes GraceDB and how to use the web interface.
- readthedocs page for gracedb-client
- Admin docs move to a git repository (preferably something private like gracedb/admin-tools or gracedb/scripts). Could just be part of the repo's wiki.
This is obviously not a high priority, but something that could be done at some point to alleviate the headaches associated with the current structure.