Skip to content

Edit this Documentation

ACCESS-rAM3-configs documentation contributions welcome 🙏

This documentation is a work in progress, and we welcome any contributions, including corrections and suggestions.

All contributions are welcome but we would particularly appreciate text suggestions (below). Contributions can be made in a few ways:

Quick contributions

Tip

This method has the advantage to be very quick (<1 minute!). The caveat is that, unless you have write access to the access-ram3-config-docs repository, you will not be able to preview the changes rendered into a website or create whole new pages.

The simplest and fastest way to make a change to an existing page is to click the edit "pencil" on the top-right corner. This will go to the relevant GitHub markdown file and clicking the top-right pencil again on GitHub will allow you to edit the file. Once complete, click Commit changes.... There are then two possibilities, depending on whether you have write access to access-ram3-config-docs:

  1. No write access (e.g. you are not part of the ACCESS-NRI GitHub organisation): this will prompt you to make a fork and then a pull request (less than 1 minute!).
  2. You have write access: please commit changes on a new branch and then use a pull request (this relates to the next option).

Larger contributions (online PR-previews)

Tip

This method allows you create whole new pages, and to preview the changes rendered into a website. It does not require you to install any software, but is only available for people with write access to access-ram3-config-docs.

Create a new branch, e.g. <github username>/doc-update, make doc changes (the documentation source code is in the documentation folder), then open a related PR and a GitHub preview will be created automatically.

Larger contributions (mkdocs offline)

Tip

Similar to the above, this method allows you create whole new pages and to preview the changes rendered into a website. It works whether or not you have write access to access-ram3-config-docs, but requires you to install mkdocs and takes the longest to set up.

Following these instructions but noting the documentation sources are in the documentation folder. You'll need to fork and clone the access-ram3-config-docs repository if you want to write your own content (mkdocs serve should be invoked from within the documentation directory).

If you want to add a new page, you should add a markdown file in the pages folder (or one of its sub-folders, as appropriate) with the page-related content.
Then, update the documentation navigation in the mkdocs.yml file by adding an entry under the nav: section. Note you'll need to specify the correct path for the added page, relative to the docs folder.