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

Create a github page for the documentation #212

Closed
nwneisen opened this issue Jul 19, 2023 · 3 comments
Closed

Create a github page for the documentation #212

nwneisen opened this issue Jul 19, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nwneisen
Copy link
Collaborator

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
@nwneisen nwneisen added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 19, 2023
@afbjorklund
Copy link
Contributor

And sometimes it goes back and forth, like on https://containerd.io/docs/getting-started/

Moved to https://github.com/containerd/containerd/blob/main/docs/getting-started.md

@2rs2ts
Copy link

2rs2ts commented Oct 26, 2023

This is satisfied by #215 and #227, right?

@nwneisen
Copy link
Collaborator Author

@2rs2ts Correct. Thanks for pointing that out. This can be closed

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

No branches or pull requests

3 participants