Right now we have some meta-docs at jupyter.readthedocs.io. They haven’t been updated super frequently, but they have a lot of great content. The theme the site uses also seems quite custom, and needs a little bit of work (e.g. the Jupyter logo seems to be the wrong size).
We’ve had some general conversation recently around improving the “meta” documentation in Jupyter. E.g. @parente has recently moved Docker Stacks to Discourse, and asked what we should do with the “contributing guidelines” page.
I propose that we do something like the following, and would love to hear what people think about it:
- Change the theme of
jupyter.readthedocs.ioto something simpler like the jupyterlab readthedocs theme, or the jupyterhub alabaster theme. - Take a pass through the content in order to make sure the information there is up-to-date.
- Move the “contributing guide” content here to this repository
- Add some kind of “list of jupyter repositories” to this documentation, similar to http://docs.astropy.org/en/stable/stability.html
- Edit the repository’s README to make clear they should ask questions in the Discourse, not the issues of that repo
- In the future, treat this repository as the host of the “contributing docs”.
- Potentially, rename this repository to something more descriptive, like “jupyter-contribute.readthedocs.io” or “team-compass.readthedocs.io”
What do folks think about this? (apologies if all of this has already been decided at some other point in time)
