Hi Mike,
On 17/04/2020 05:01, Mike Kelsey wrote:
Hello, all! Since starting to deal seriously with EasyBuild, I've posted
several issues and pull requests which involve the documentation. In my own
experiment, I'm not shy about asking my collaborators to update our
Confluence documentation, so I should be willing to do the same.
Would it be okay to do that sort of thing myself, or leave it to the
experts?
-- Mike Kelsey
We certainly welcome contributions to the documentation!
It's housed in the 'docs' subdirectory of the 'easybuild' repository at
https://github.com/easybuilders/easybuild.
Updated to the docs can be made via pull requests, see
https://github.com/easybuilders/easybuild/pull/616 for example.
We use the reStructuredText format for the documentation.
A handy tool to pre-check whether the formatting works correctly is
http://rst.ninjs.org, where you can copy-paste snippets of documentation
in the box on the left, and it'll be instantly rendered on the right
(use the "Nature" theme).
The only thing that doesn't work there is references to other parts of
the documentation, so you'll need to double/triple check those manually.
Or, you can set up readthedocs for your fork of the easybuild repo, if
you're up for that, to thoroughly pre-check the formatted docs before
opening the pull request (see for example
https://github.com/easybuilders/easybuild/pull/607).
regards,
Kenneth
