Add documentation website

guidemetothemoon commented 5 months ago

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 commented 5 months ago

@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)

leonardpahlke commented 5 months ago

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

opened a servicedesk ticket 👍

leonardpahlke commented 5 months ago

PTAL @nikimanoledaki / @AntonioDiTuri / @rossf7

nikimanoledaki commented 4 months ago

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

guidemetothemoon commented 4 months ago

@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 commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

Could we move the documentation to the tag-env-sustainability repository, as discussed in https://github.com/cncf-tags/green-reviews-tooling/issues/65. As mentioned in https://github.com/cncf-tags/green-reviews-tooling/issues/65#issuecomment-2098368421 if we split websites & repositories it makes things more complicated for no good reason.

guidemetothemoon commented 4 months ago

@nikimanoledaki reverted PR #94

nikimanoledaki commented 4 months ago

Thank you @guidemetothemoon 💚

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

cncf-tags / green-reviews-tooling