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

📖 Minor Documentation Improvements: Add Links, Fix Typos, and Clarify Instructions #4093

Merged
merged 6 commits into from
Aug 23, 2024

Conversation

camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Aug 23, 2024

This pull request includes several small but important improvements to the documentation, aimed at enhancing clarity and providing additional resources:

  • Added a link to the CronJob Tutorial in the "Next Steps" section of the Getting Started guide.
  • Fixed minor issues with documentation headings and improved consistency in the Quick Start guide.
  • Clarified the need to push images in the Running guide with an added note.
  • Recommended using Kind for testing in the Getting Started guide.
  • Corrected a typo in the link to the Kind guide.
  • Added a brief note in the "Next Steps" section about the Deploy Image plugin to offer further guidance.

…ext Steps

- Corrected the heading from "Registry permission" to "Registry Permission" for consistency.
- Improved the readability of the "Next Step" section by removing redundant lines and ensuring consistent formatting.
- Include additonal note to clarify Rehistry permissions
- Included additional information on RBAC errors with a reference to prerequisites for Kubernetes RBAC on GKE clusters.

 Registry Permission and recommend Kind usage
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 23, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 23, 2024
Add info to let users be aware that the plugin can generate a similar code and help them out acelerate the development
@camilamacedo86 camilamacedo86 changed the title Docs nits 📖 Minor Documentation Improvements: Add Links, Fix Typos, and Clarify Instructions Aug 23, 2024
@camilamacedo86
Copy link
Member Author

Those are minor changes.
I will not make nobody waste time on reviews.
I am moving forward here.

@camilamacedo86 camilamacedo86 merged commit f3f07ae into kubernetes-sigs:master Aug 23, 2024
13 of 20 checks passed
@camilamacedo86 camilamacedo86 deleted the docs-nits branch August 23, 2024 19:12
sarthaksarthak9 pushed a commit to sarthaksarthak9/kubebuilder that referenced this pull request Sep 9, 2024
… Instructions (kubernetes-sigs#4093)

This pull request includes several small but important improvements to the documentation, aimed at enhancing clarity and providing additional resources:

- Added a link to the CronJob Tutorial in the "Next Steps" section of the Getting Started guide.
- Fixed minor issues with documentation headings and improved consistency in the Quick Start guide.
- Clarified the need to push images in the Running guide with an added note.
- Recommended using Kind for testing in the Getting Started guide.
- Corrected a typo in the link to the Kind guide.
- Added a brief note in the "Next Steps" section about the Deploy Image plugin to offer further guidance.
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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants