Skip to content

📖 Improve and Simplify the Getting Started Guide #4094

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 3, 2024
Merged

📖 Improve and Simplify the Getting Started Guide #4094

merged 1 commit into from
Sep 3, 2024

Conversation

@camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Aug 23, 2024 •
edited
Loading

  • Refined the sample code implementation to keep it minimal, helping users better understand the core concepts.
  • Properly implement automation to generate the sample
  • Streamlined the guide by focusing on the main information and removing extraneous details.
  • Ensured that the code and samples in the guide are consistent with the generated project.
  • Simplified navigation by hiding the full code, making it easier for users to follow along.
  • Replaced the use of the deploy image plugin with direct commands to provide more comprehensive and straightforward information.

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Aug 23, 2024

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 23, 2024
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 23, 2024
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch 2 times, most recently from e3dccda to 9153231 Compare August 24, 2024 02:16
@camilamacedo86 camilamacedo86 changed the title TEST - WIP Improve and Simplify the Getting Started Guide Aug 24, 2024
@camilamacedo86 camilamacedo86 marked this pull request as ready for review August 24, 2024 02:18
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 24, 2024
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch from 9153231 to 50e16d5 Compare August 24, 2024 02:22
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch from 50e16d5 to 747146a Compare August 24, 2024 02:24
@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Aug 24, 2024

c/c @TAM360

@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch 2 times, most recently from 093bbdc to be4ee4a Compare August 24, 2024 10:44
@camilamacedo86 camilamacedo86 changed the title Improve and Simplify the Getting Started Guide 📖 Improve and Simplify the Getting Started Guide Aug 24, 2024
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch from be4ee4a to 965c8d1 Compare August 24, 2024 11:19
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 24, 2024
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch 4 times, most recently from 4e4177e to 26ea6f0 Compare August 24, 2024 11:57
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch 2 times, most recently from 9b82671 to 27bda98 Compare August 25, 2024 06:32
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 26, 2024
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch from 27bda98 to 477abdb Compare August 26, 2024 17:47
@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Aug 27, 2024
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch from 477abdb to 5457a5a Compare August 31, 2024 17:50
@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Aug 31, 2024
varshaprasad96
varshaprasad96 approved these changes Sep 3, 2024
View reviewed changes
Copy link
Member

@varshaprasad96 varshaprasad96 left a comment

Choose a reason for hiding this comment

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

Looks good from my end.
/lgtm
/approve

Adding in /hold, so that the PR doesn't get auto merged and @TAM360 gets a chance for review.

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

k8s-ci-robot commented Sep 3, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, varshaprasad96

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:
  • OWNERS [camilamacedo86,varshaprasad96]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@varshaprasad96
Copy link
Member

varshaprasad96 commented Sep 3, 2024

Looks like the PR needs to be rebased.

@varshaprasad96 varshaprasad96 added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 3, 2024
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch from 5457a5a to 43690b1 Compare September 3, 2024 05:52
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 3, 2024
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Sep 3, 2024

New changes are detected. LGTM label has been removed.

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 3, 2024
@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Sep 3, 2024

@TAM360 I know that you are checking the docs and seen how you can help out.
So, if you see here (or in any place) something that can be fixed or improved
Please, do not hesitate in raise a PR with your suggestions !!!

So, I am moving here with this one, we have many open prs and we can push improvements in follow up always !

@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Sep 3, 2024

/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 3, 2024
@camilamacedo86 camilamacedo86 added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 3, 2024
@camilamacedo86
Improve and Simplify the Getting Started Guide
25d87e2 
- Refined the sample code implementation to keep it minimal, helping users better understand the core concepts.
- Streamlined the guide by focusing on the main information and removing extraneous details.
- Ensured that the code and samples in the guide are consistent with the generated project.
- Simplified navigation by hiding the full code, making it easier for users to follow along.
- Replaced the use of the deploy image plugin with direct commands to provide more comprehensive and straightforward information.
@camilamacedo86 camilamacedo86 force-pushed the getting-started-use-sample branch from 43690b1 to 25d87e2 Compare September 3, 2024 06:01
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 3, 2024
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Sep 3, 2024

New changes are detected. LGTM label has been removed.

@camilamacedo86 camilamacedo86 merged commit b7b009d into kubernetes-sigs:master Sep 3, 2024
@camilamacedo86 camilamacedo86 deleted the getting-started-use-sample branch September 3, 2024 06:02
@camilamacedo86 camilamacedo86 mentioned this pull request Oct 10, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@varshaprasad96 varshaprasad96 varshaprasad96 approved these changes

@everettraven everettraven Awaiting requested review from everettraven

@Kavinjsir Kavinjsir Awaiting requested review from Kavinjsir

@rashmigottipati rashmigottipati Awaiting requested review from rashmigottipati

@stmcginnis stmcginnis Awaiting requested review from stmcginnis

Assignees

@varshaprasad96 varshaprasad96

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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@camilamacedo86 @k8s-ci-robot @varshaprasad96