feat: Move README docs to GitHub pages #145
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adelbertc
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #31 !
Here it is, a semi-shiny website for kubectl-trace. I started by just moving the contents of the README to a Hugo website. A lot of the checked-in files are seeded from Hugo and the Geekdoc template I'm using which seemed to be finicky with Git submodules and was happier just dumping the files directly in the repo per the instructions on the website.
Currently the deployment process is manual, documented in the
docs/README.mdfile, it doesn't seem Hugo has an official GitHub Action or anything like that, but I figure we do that in another PR or something. In the meanwhile if/when we merge this I'll also need someone to toggle the GitHub pages setting in the repo's setting.You can preview a version of the website here.