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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摉 Restructure ClusterClass documentation #5841

Conversation

sbueringer
Copy link
Member

@sbueringer sbueringer commented Dec 9, 2021

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:

  • Dropped ClusterClass quickstart in favor of the "main" Quick start
  • Moved ClusterClass upgrades into the operations guide
  • Added a new How to write a ClusterClass page (which will be written in a follow-up PR)
  • Added a list with useful links to the "starting page" of the experimental ClusterClass feature

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 #

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 9, 2021
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Dec 9, 2021
@@ -0,0 +1,3 @@
# How to write a ClusterClass
Copy link
Member

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

@sbueringer sbueringer force-pushed the pr-restructure-clusterclass-documentation branch from 2e4eec6 to 8e606ff Compare January 5, 2022 16:19
@sbueringer
Copy link
Member Author

@fabriziopandini I moved the ClusterClass docs into a sub-folder and restructured it as suggested. Please take another look

Copy link
Contributor

@stmcginnis stmcginnis left a 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.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 7, 2022
Signed-off-by: Stefan B眉ringer buringerst@vmware.com
@sbueringer sbueringer force-pushed the pr-restructure-clusterclass-documentation branch from 8e606ff to a659deb Compare January 7, 2022 17:20
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 7, 2022
@sbueringer
Copy link
Member Author

@stmcginnis Thank you! Should be fixed

Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve
/lgtm

@vincepri
Copy link
Member

vincepri commented Jan 7, 2022

Great work here, thank you!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 7, 2022
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 7, 2022
@k8s-ci-robot k8s-ci-robot merged commit 71094f5 into kubernetes-sigs:main Jan 7, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.1 milestone Jan 7, 2022
@sbueringer sbueringer deleted the pr-restructure-clusterclass-documentation branch January 10, 2022 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants