You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Many projects host a static website for their documentation. This can be done using github pages so that the docs are contained within the project right next to the code. I'm familiar with Hugo and it'd be nice to stick with a Go SSG so less needs to be installed. There is a free theme that looks nice geekdocs but I'm not particular and we may want to customize this anyway.
k0s uses github pages and we can leverage their project structure to get everything up and running
The detailed docs should be within the docs folder of the project. Certain markdown files may need to be outside the folder so that github can find them in the github UI. Hugo should be setup to know about these
A makefile command make docs should be added to run the docs locally while working on them
A github action should be setup to publish updates to the docs when a release is made. This may be out of scope of this issue
The text was updated successfully, but these errors were encountered:
Many projects host a static website for their documentation. This can be done using github pages so that the docs are contained within the project right next to the code. I'm familiar with Hugo and it'd be nice to stick with a Go SSG so less needs to be installed. There is a free theme that looks nice geekdocs but I'm not particular and we may want to customize this anyway.
docs
folder of the project. Certain markdown files may need to be outside the folder so that github can find them in the github UI. Hugo should be setup to know about thesemake docs
should be added to run the docs locally while working on themThe text was updated successfully, but these errors were encountered: