add the documentation CI workflow

[kskarthik]

• Setup github actions which builds the docs when there is a change made to them.
• Add info about the dev setup for building the docs site
• added hot-reload functionality

Before you submit a pull request, please make sure:

• [x] The pull request should include a description of the problem you're trying to solve
• [x] The pull request should include overview of the suggested solution
• [x] If the pull requests changes current behavior, reasons why your solution is better.
• [x] The proposed code should be fully functional
• [ ] The proposed code should contain tests relevant to prove is functionality
• [ ] The proposed tests should ensure significative code coverage
• [x] All new and existing tests should pass

[evilaliv3]

Thank you @kskarthik

Would you please clarify why you consider this changes to be helpful? GlobaLeaks try to keep the codebase and the functionalities small and reduce over-engineering that is key for ensuring the project could be governed. We suggest as well that changes and development follows first and evaluation and a proposal with a ticket, to reduce unneeded work and plan and track together all the changes.

Few notes:

• At the moment the documentation is already continuously published on doc.globaleaks.org at every single commit
• The pull request contains changes to the content of the documentation which should be eventually proposed separately to ensure every change is evaluated properly by topic.

[kskarthik]

Would you please clarify why you consider this changes to be helpful?

I just added a simple job to make sure that every MR or push which changes the content inside thedocumentation/ folder does not break the docs site in prod. I did not consider it as a over-engineering, but a safely check.

We suggest as well that changes and development follows first and evaluation and a proposal with a ticket, to reduce unneeded work and plan and track together all the changes.

Yes, i should have proposed this idea first, before sending the patch.

[kskarthik]

The pull request contains changes to the content of the documentation which should be eventually proposed separately to ensure every change is evaluated properly by topic.

Sure

[kskarthik]

Now this PR contains only the CI job patch

[evilaliv3]

Thank you @kskarthik , but for the moment we prefer to not include this build as we already automatically build and publish our documentation on transifex at docs.globaleaks.org