Add docs publishing script and improve documentation #161
Conversation
This file contains 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
k8s-ci-robot
added
release-note-none
k8s-ci-robot
added
the
approved
|
/assign @andrewsykim |
k8s-ci-robot
added
size/L
nckturner
force-pushed
the
docs-v1
branch
7 times, most recently
from
4a03b82
to
bd934a2
Compare
nckturner
changed the title
nckturner
force-pushed
the
docs-v1
branch
2 times, most recently
from
66deb6d
to
589bafe
Compare
- Docs script for publishing to github pages - Split existing readme into docs sections - Logos :D
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: M00nF1sh, nckturner The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
thanks @nckturner, FYI @nicolehanjing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR includes a script (./hack/publish-docs.sh) that can be called from the command line or ideally in a github action to publish the docs to the github pages branch. This allows the docs to be hosted on github (see an example published from my fork).
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: