Project documentation
Closed this issue · 4 comments
I'm currently trying to work out documentation for portions of Fireant with readthedocs.io and sphinx. More specifically, I aim to document what Fireant does and how it works, as well as instructions on how to properly install / run it. If there's a need or want for more information (Jenkins / Docker / Unit Test documentation) as well, I can look into that. I'll most likely need to connect with all team members to get a better understanding on how I should document different aspects.
The only documentation I currently posses is the Updating Dependencies Tutorial which I based off of Nutch Confluence pages. It's currently formatted as a google doc in our team drive. Since Fireant is an automated service, I'm not sure whether this documentation is necessary. Let me know if I should still make a PR for this / update the documentation with readthedocs
@leetheod thanks for registering this issue. Please hyperlink to the Updating Dependencies Tutorial you've referenced above. I've never seen it before.
I don't think that tutorial will be relevant for updating the dependencies with Fireant... so lets just focus on the Fireant documentation.
Specifically, I'm interested in you documenting the Dockerfilke (which has still not been updated to the JDK11 upgrade I performed several weeks ago) adequately.
I've used readthedocs.io and sphinx to product documentation for loads of projects so I am very familiar with both.
For example, documentation for the podaacpy project can be found here.
The podaacpy project will give you ever piece of guidance you need to implement adequate documentation.
Thanks
Updating Dependencies Tutorial: https://docs.google.com/document/d/1YgFjg-EVRMW5pCsUUin1nXFkp-8zSvtaV4KVfxXkh8g/edit?usp=sharing
Sounds good, I will look into the podaacpy project documentation and apply it here.
Please go ahead and update the README to begin with.