[ACTION] Move documentation to a dedicated docs website

[guidemetothemoon]

With the deprecation of the design doc all the documentation for the work that's being done in Green Reviews WG is being moved to GitHub. To make it easier to digest all the information, onboard new contributors and in general make the overall documentation more visible and accessible we would like to create a dedicated website where the documentation can live.

The website will be linked to the doc files in this GitHub repo and will populate content accordingly.
We're already using Hugo as a static site generator for the TAG ENV website and we can do the same in this case as well. It's easy to set up and we can use the same folder structure and Netlify hosting configuration as we do for the TAG. There are also many templates available that are easily set up and adjusted as we need to.

Below are some suggestions for the docs templates we can use. Please note that things like menu sections and such are adjustable, preview website is just to give you an impression of how the website will look like, but we will adjust as needed content-wise.

• Doks (my personal favorite😁): https://doks.netlify.app
• Docsy (the one used by the TAG): https://example.docsy.dev
• Learn: https://learn.netlify.app/en
• docDock: https://docdock.vjeantet.fr
• Geekdoc: https://geekdocs.de/

[guidemetothemoon]

@nikimanoledaki FYI😊

[nikimanoledaki]

Thank you for these suggestions! Doks does look awesome - let's go for it!! 😄

[guidemetothemoon]

Great, I will start looking into this in the coming days☺️

[nikimanoledaki]

@guidemetothemoon will you need a domain for the docs website? We can request this as well as the one for the Grafana dashboard cc @leonardpahlke

[guidemetothemoon]

@nikimanoledaki yes, we will definitely need a domain. Which one would you like? One of the suggestions was to have a subdomain under tag-env-sustainability.cncf.io.
We also need to have Netlify hosting set up - from what I understand CNCF owns this so what should the process in this case be, @leonardpahlke ?

[leonardpahlke]

fyi @cjyabraham

[leonardpahlke]

@guidemetothemoon @nikimanoledaki did we explored the option of integrating it into our current website tag-env-sustainability.cncf.io with just sub pages? The templates has these capabilities (cc @cjyabraham). I am thinking a bit a long the lines of https://glossary.cncf.io/, as a sub page for WG Green Reviews part of the TAG website.

[cjyabraham]

I guess whether to integrate it into tag-env-sustainability.cncf.io or set it up as its own website will depend on its requirements. How many pages is it? Does it require versioning so that people can review the docs according to which version of the software they are using? If we integrate it into tag-env-sustainability.cncf.io, could the pages be hosted in the same repo or do they have to stay in this repo (both are possible but the latter adds complexity)? Does it require its own branding?

[guidemetothemoon]

Here I think that Green Reviews leads should have an opinion: @nikimanoledaki @AntonioDiTuri @rossf7

To me it makes sense to keep documentation in this repo for consistency and in order to gather everything related to the working group's activities in the same place. If we take TAG App Delivery as an example, they do also have separate websites for things related to the TAG itself and f.ex. for OpenGitOps project.
This is a bigger project than any other we have in the TAG, and if it will be used by all CNCF projects then maybe it will require its own branding as well.

I'm not against putting it under the main website either, but in that case I think it's best to keep documentation in this repo to avoid confusion and repo switching for contributors.

[nikimanoledaki]

I agree with @guidemetothemoon's points! We should definitely keep the Green Reviews WG docs in this repository.

+1 - given the project Roadmap, it may require its own branding at some point, but we have not discussed this yet. We could add this to the Roadmap around Q3 when we reassess the direction of the project.

I wanted to add that the TAG App Delivery/GitOps WG initiative OpenGitOps is a CNCF Project in itself (fun fact! 😄). However, this is not something that we are considering for the Green Reviews WG project at the moment.

I am also not opposed to starting with the documentation as part of the main website as long as the files can remain in this repository. We can always split this later if needed. :) I am not familiar with how to push from two separate repos with any of the docs templates - is there an easy way to do this?