Restructure docs and split into versioned and unversioned #782
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
kind/documentation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: youngnick 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 |
k8s-ci-robot
added
the
approved
|
/hold To allow multiple people to review. |
k8s-ci-robot
added
the
do-not-merge/hold
k8s-ci-robot
added
the
needs-rebase
robscott
reviewed
Aug 16, 2021
added 3 commits
August 17, 2021 00:44
Signed-off-by: Nick Young <ynick@vmware.com>
Signed-off-by: Nick Young <ynick@vmware.com>
Signed-off-by: Nick Young <ynick@vmware.com>
youngnick
force-pushed
the
docs-restructure
branch
from
22bfc29 to
5dda19f
Compare
k8s-ci-robot
removed
the
needs-rebase
|
I folded in the above suggestions plus the ones from the call, ready for a final (hopefully!) look. |
|
Looks great, thanks @youngnick! /lgtm |
k8s-ci-robot
added
the
lgtm
|
I think it's probably safe to remove the hold on this since it seems like we reached consensus on this approach during the community meeting earlier today. If no one objects, I'll remove the hold in a few hours. |
|
/hold cancel |
k8s-ci-robot
removed
the
do-not-merge/hold
7 tasks
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.
Signed-off-by: Nick Young ynick@vmware.com
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This document updates the docs site structure to have less things versioned, and adds top-level navigation. Basically, only the API Types, Guides and API reference are versioned now, since I don't think we've been changing the other things along version boundaries.
I've tried to make the navigation make a bit more sense, but haven't touched the content of the files too much (although I did notice heaps of things to fix, I'll keep those for followups).
This is a first cut, intended to set us up to be in the best place we can be without substantially changing the docs flow (by adding
mikeinto the mkdocs flow, moving to Hugo, or other big change).Does this PR introduce a user-facing change?: