How to Contribute Documentation? about guides

[panosnethood]

Thanks @hellekin! Looking at previous commits, it seems that it should be enough to change the .rst files. @haniavis could help on how you can build locally the documentation, but for simple changes you could already try a pull request directly changing the corresponding .rst file.

[haniavis]

Hi,

I just cleaned the repository from old build files.

This documentation is built using the Sphinx tool. So if you want to build locally the documentation, you should first clone the repo, then install sphinx in your machine and finally execute the following inside the guides folder:
sphinx-build -b html tech/source/ /your_output_folder/
Then you will be able to see the html files in your output folder.

Now in order to push these changes to the MAZI repository, you should fork the repository, optionally create another branch, make the changes and then create a pull request.

If you think that forking and creating a pull request is too much for this (probably), you can simply create another issue with your feedback and we will merge your feedback to the repository.

[panosnethood]

I updated here the guidelines for contributors: https://github.com/mazi-project/guides/wiki/Contributing

Next step is to write guidelines for the contributors to the software code ...

[hellekin]

OK. I think there should be a Makefile to build the documentation, and the build/ directory should not be in the repository, only the sources. That would remove confusion... Maybe a Dockerfile could be there as well for people to preview the build without polluting their system with Sphinx dependencies.

[hellekin]

Hi @haniavis, I made #10 that should also close this issue.