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 documentation website #89

Merged
merged 8 commits into from
Apr 23, 2024
Merged

Add documentation website #89

merged 8 commits into from
Apr 23, 2024

Conversation

guidemetothemoon
Copy link
Contributor

@guidemetothemoon guidemetothemoon commented Apr 19, 2024

What type of PR is this?

kind/documentation

What this PR does / why we need it:

Moved documentation for the Green Reviews WG into a dedicated website, based on Doks theme for Hugo that will be deployed and hosted by Netlify.

Which issue(s) this PR fixes:

Fixes #65

Special notes for your reviewer (optional):

  • Removed docs folder.
  • Moved documentation to website/content/docs.
  • Deployed website Doks theme, as per official documentation with enabled search and website light/dark theme toggle.
  • Updated default configuration where applicable to adapt to our use case. Some of default configuration is kept in case we want to utilize it in the future.
  • Added configuration for deployment via Netlify.
  • Updated README.md in the root of the repository with information on the website, how to update documentation and how to run the website locally.

Disclaimer: I haven't gone in-depth through the content of the documentation itselft. I believe that it will be improved continuously. Versioning of the documentation is currently not enabled, but it is possible to do in case we want it.

Fun fact: authors behind the theme care about environmental impact, which is also visible in the documentation: https://getdoks.org/docs/start-here/environmental-impact

guidemetothemoon and others added 7 commits April 17, 2024 21:32
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
@guidemetothemoon guidemetothemoon added the kind/documentation Improvements or additions to documentation label Apr 19, 2024
@guidemetothemoon guidemetothemoon marked this pull request as ready for review April 19, 2024 13:33
@guidemetothemoon guidemetothemoon requested review from a team as code owners April 19, 2024 13:33
@guidemetothemoon
Copy link
Contributor Author

guidemetothemoon commented Apr 19, 2024

@leonardpahlke we need help with setting up deployment site in Netlify and getting the domain ready. I've configured it in the source code so it should work, but I don't have access to the CNCF Netlify to actually test this. Local testing was performed and it all looks good. Who can help us with getting this part in place?🙌
(We may also want to do it after this PR is merged to master)

website/LICENSE Outdated Show resolved Hide resolved
website/content/docs/cncf-projects/falco.md Show resolved Hide resolved
@leonardpahlke
Copy link
Member

@leonardpahlke we need help with setting up deployment site in Netlify and getting the domain ready.

opened a servicedesk ticket 👍

Signed-off-by: Kristina Devochko <[email protected]>
Copy link
Member

@leonardpahlke leonardpahlke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@leonardpahlke
Copy link
Member

PTAL @nikimanoledaki / @AntonioDiTuri / @rossf7

Copy link
Contributor

@rossf7 rossf7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@guidemetothemoon guidemetothemoon merged commit 35af5a7 into main Apr 23, 2024
1 check passed
@guidemetothemoon guidemetothemoon deleted the add-docs-website branch April 23, 2024 06:27
@nikimanoledaki
Copy link
Contributor

@guidemetothemoon would it be possible to revert this? 🥺 🥲

@guidemetothemoon
Copy link
Contributor Author

@nikimanoledaki sure, I can revert it. Where should the docs be now? Should I just revert exactly to the way it was or shall we move it out/modify the folder structure as well?

@nikimanoledaki
Copy link
Contributor

Yes, let's revert this at first, since it won't be served. 🙁 The dir structure makes the docs a bit difficult to read unfortunately too. I'm trying to link people to them (a good thing!!) 🙈 😄

@nikimanoledaki
Copy link
Contributor

nikimanoledaki commented May 16, 2024

And then we can look for a way to point to this repo's dir from the TAG repo - I'm sure there's a way. Could open a new issue and see if anyone would like to contribute this! Otherwise I could look into it at some point

@leonardpahlke
Copy link
Member

Could we move the documentation to the tag-env-sustainability repository, as discussed in #65. As mentioned in #65 (comment) if we split websites & repositories it makes things more complicated for no good reason.

@guidemetothemoon
Copy link
Contributor Author

@nikimanoledaki reverted PR #94

@nikimanoledaki
Copy link
Contributor

Thank you @guidemetothemoon 💚

@leonardpahlke yeah, I'm considering our options for how we should do that. Let's discuss this in issue #65! 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ACTION] Move documentation to a dedicated docs website
4 participants