kibble-1 icon indicating copy to clipboard operation
kibble-1 copied to clipboard

Write basic usage documentation

Open Humbedooh opened this issue 7 years ago • 2 comments

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.

Humbedooh avatar Feb 18 '18 11:02 Humbedooh

I can work on this :)

amunz avatar Feb 19 '18 17:02 amunz

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? :)

Humbedooh avatar Feb 20 '18 12:02 Humbedooh