Contributing to DocumentationΒΆ
The steps for adding new documentation to the ESGF Installer documentation page are as follows
- Create a new ReStructured Text (rst) file named as {doc_name.rst}. Example: the API page is named api.rst
- Populate the file with the relevant documentation information
- Edit the index.rst file to reference the newly created rst file. Example: Look for the relevant table of contents section (toctree) or create a new one. The add the file name (with no extension) underneath the toctree section
- Run the
`push_to_github.sh`
script to build the new html pages and upload them to Github Pages.