kibble-1
kibble-1 copied to clipboard
Write basic usage documentation
We need someone to get started on writing documentation on how to use Kibble;
- How do you set up the base
- How do you set up an organisation
- How to add sources, what to keep in mind
- How to browse projects (what's the sub-filter for etc)
- How to grab data, exports etc
- What to look for when assessing a project/community's health.
I can work on this :)
Awesome! To get you started, we use ReStructured Text for our documentation (cheat sheet can be found at https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst ) and you would probably start a new document in the docs/ directory with this, which would then be woven into the main documentation. See https://github.com/apache/kibble/tree/master/docs/source for the current layout of the docs. I would suggest you start on a file called usage.rst maybe? :)