-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
馃摉 Restructure ClusterClass documentation #5841
馃摉 Restructure ClusterClass documentation #5841
Conversation
docs/book/src/tasks/experimental-features/cluster-class-operations.md
Outdated
Show resolved
Hide resolved
@@ -0,0 +1,3 @@ | |||
# How to write a ClusterClass |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit:
should we move everything related to ClusterClass under ./tasks/experimental-features/cluster-class/, so we can drop cluster class prefix from the files (cluster-classes.md could be renamed in overview.md or something similar)
Also, wondering if we have a clear definition of what is an "how-to" and what are "operations". A thing that we can do is to just drop the distinction and have focused pages on each topic
2e4eec6
to
8e606ff
Compare
@fabriziopandini I moved the ClusterClass docs into a sub-folder and restructured it as suggested. Please take another look |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
A couple very minor things pointed out, but nothing that I think is of real concern.
docs/book/src/tasks/experimental-features/cluster-class/change-clusterclass.md
Outdated
Show resolved
Hide resolved
docs/book/src/tasks/experimental-features/cluster-class/upgrade-cluster.md
Show resolved
Hide resolved
Signed-off-by: Stefan B眉ringer buringerst@vmware.com
8e606ff
to
a659deb
Compare
@stmcginnis Thank you! Should be fixed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/approve
/lgtm
Great work here, thank you! |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vincepri 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 |
Signed-off-by: Stefan B眉ringer buringerst@vmware.com
What this PR does / why we need it:
The goal of this PR is to create a structure for our ClusterClass documentation so we can added more documentation incrementally. The idea is also to essentially just "move up" the ClusterClass tree in the sidebar once the feature is not experimental anymore.
Changes:
How to write a ClusterClass
page (which will be written in a follow-up PR)Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close the issue(s) when PR gets merged):Fixes #