The goal of this print project is to improve the ODC's documentation.
- Some tasks will have already been identified where we know the documentation need improvement, these will be listed in the issues already (see A big list of small tasks below)
- Typos aren’t likely to be listed as issues, but spotting them and submitting pull requests to fix them is welcome!
- Even raising suggestions for ways to improve the documentation for beginners is useful, so if you find something confusing let us know! Simply open a new issue in this repository with what you found difficult and the team will get back to you.
For first starters, have a read of the GitHub docs on how to create a pull request.
This will help you understand how to edit some simple documentation pages and how to get that change accepted into the main codebase, and published to the documentation site.
There's a GitHub Project that lists tasks here.
If you would like to do one, grab it, put your name on it, and move it to the 'in progress' section. Contact Alex Leith if you need to get access to this project.
The Datacube-Core project uses Restructured Text. Here's a guide.
You can read the documentation here and when you find something that doesn't make sense, click the "Edit on Github" button to go to the file and make your changes. Creating lots of small pull requests and assigning Alex Leith to them will mean that your change is more likely to get quickly accepted.