-
Notifications
You must be signed in to change notification settings - Fork 15
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
Conversation
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]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
@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?🙌 |
opened a servicedesk ticket 👍 |
Signed-off-by: Kristina Devochko <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
PTAL @nikimanoledaki / @AntonioDiTuri / @rossf7 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@guidemetothemoon would it be possible to revert this? 🥺 🥲 |
@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? |
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!!) 🙈 😄 |
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 |
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. |
@nikimanoledaki reverted PR #94 |
Thank you @guidemetothemoon 💚 @leonardpahlke yeah, I'm considering our options for how we should do that. Let's discuss this in issue #65! 😊 |
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):
website/content/docs
.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