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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Refactor provider's implementers guide #11195

Merged

Conversation

fabriziopandini
Copy link
Member

What this PR does / why we need it:
Provider's implementers guide have some good content, but the current book structure and page order doesn't surface what it is.

This refactor:

  • Renames "Developer Guide\Provider Implementers" into a less opaque "Developer Guide\Developing providers"
  • Renames provider's "implementers guide" into "getting started", because this is what the content is about
  • Change the order of pages of the "getting started" to have have a better flow in the explanation
  • Introduces a few minor changes to help users to understand what this guide is about, and slightly improve the flow of the guide

PS. most probably, the easiest way to look at this is by using the preview of the web site

/area documentation

@k8s-ci-robot k8s-ci-robot added the area/documentation Issues or PRs related to documentation label Sep 18, 2024
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 18, 2024
@richardcase
Copy link
Member

I like the layout changes and the edits. This is a definite improvement. Great work @fabriziopandini 👍

Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

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

Thx, huge improvement!

@fabriziopandini
Copy link
Member Author

All comment addressed
/hold for squash before merge

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 19, 2024
@sbueringer
Copy link
Member

sbueringer commented Sep 19, 2024

Thx!

/lgtm
/approve

(you can also just add the squash label and let tide do the work/squash)

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

LGTM label has been added.

Git tree hash: 713ff77ad033fe27c6eb5b1d43aa9b987775e9c8

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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 Sep 19, 2024
@fabriziopandini fabriziopandini force-pushed the refactor-implementers-guide branch 2 times, most recently from 2c51281 to 8a13748 Compare September 19, 2024 13:35
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 19, 2024
@fabriziopandini
Copy link
Member Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 19, 2024
Copy link
Member

@chrischdi chrischdi left a comment

Choose a reason for hiding this comment

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

/lgtm

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

LGTM label has been added.

Git tree hash: 90db2dab7c8ebc480aba42ddfbd52efaa5079cc9

@k8s-ci-robot k8s-ci-robot merged commit c1c8833 into kubernetes-sigs:main Sep 19, 2024
15 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.9 milestone Sep 19, 2024
@fabriziopandini fabriziopandini deleted the refactor-implementers-guide branch September 21, 2024 12:24
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. area/documentation Issues or PRs related to documentation 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.

5 participants