Contributing

Documentation

We welcome any your support in documenting your Kuwaiba journey in order to share with other users and commit to retain the easy to use and helpful support to start documenting. Don’t hesitate to start writing even if the words github, restructured text and pull request are new for you. Nevertheless the actual working surrounding is quite comprehensive, we will try to make any small step easier and let you concentrate on the issue.

Contributing to Documenting Kuwaiba from scratch

Kuwaiba documentation is build on ReadTheDocs (RTD) platform. That means automatic documentation deployment with the Sphinx engine. To work with that platform you need git installed, github account and text editor, working with git. We prefer VS Code, so the following story will be in relation with this editor, but you can work with the one of your choice.

Tip

If you are new with VS Code, see official videos, covering our needs:

• Learn Visual Studio Code in 7min (Official Beginner Tutorial)

• Git: Commits in Visual Studio Code

• 5 Tips for Note Taking with VS Code & Git

• Pull Requests in VS Code

As far as ReadTheDocs is using reStructuredText (RST) it is considered useful to install an extension reStructuredText by LeXtudio (RTL). Unfortunately the extension is now considered for experienced users so we give you some breadcrumbs.

When you feel comfortable enough with VS Code, you might find useful the official Sphinx RST Tutorial or try this nice video course by chance available on youtube.