Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add the documentation CI workflow #4054

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kskarthik
Copy link
Contributor

@kskarthik kskarthik commented Apr 22, 2024

  • 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:

  • The pull request should include a description of the problem you're trying to solve
  • The pull request should include overview of the suggested solution
  • If the pull requests changes current behavior, reasons why your solution is better.
  • 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
  • All new and existing tests should pass

@kskarthik kskarthik changed the title improve the documentation improve the documentation workflow Apr 22, 2024
@evilaliv3
Copy link
Member

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
Copy link
Contributor Author

kskarthik commented Apr 22, 2024

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
Copy link
Contributor Author

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

When there are patches to the docs, This job makes sure that
the site is building as intented.
@kskarthik
Copy link
Contributor Author

Now this PR contains only the CI job patch

@kskarthik kskarthik changed the title improve the documentation workflow add the documentation CI workflow Apr 22, 2024
@evilaliv3 evilaliv3 force-pushed the main branch 2 times, most recently from bc75cdb to ec7341d Compare May 11, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants