You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kibble.apache.org by Daniel Gruno <hu...@apache.org> on 2018/01/12 18:25:58 UTC

Getting started on documentation for Kibble

Hi folks,
I've started writing some documentation on setup/usage for Kibble inside
the main repo, under docs/. It's using the RsT format, which means we
can have ReadTheDocs generate the documentation on commit for us,
available at https://apache-kibble.readthedocs.io/

So far I've gotten the installation/setup instructions somewhat done,
and next I'll move onto how to set up an organisation and add sources.
If anyone is willing to 'document as they explore', it would be greatly
appreciated. In particular, I'd be interested in how people go about
using the UI, any secrets/tips they have etc, but also just general
usage documentation.

There seems to be a growing interest in trying out the software, so
having proper documentation would be awesome and helpful.

With regards,
Daniel.