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.

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

Proposal for minikube tips #11696

Merged
merged 2 commits into from
Jun 21, 2021
Merged

Proposal for minikube tips #11696

merged 2 commits into from
Jun 21, 2021

Conversation

dinever
Copy link
Contributor

@dinever dinever commented Jun 18, 2021

Hi,

This is a proposal for #11207. Would like to collect some feedback before submitting any PRs.

Thanks!

@dinever
Add proposal for tips
d5d5529 
Signed-off-by: Peixuan Ding <dingpeixuan911@gmail.com>
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 18, 2021
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 18, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @dinever. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 18, 2021
@minikube-bot
Copy link
Collaborator

Can one of the admins verify this patch?

andriyDev
andriyDev approved these changes Jun 18, 2021
View reviewed changes
Copy link
Contributor

@andriyDev andriyDev left a comment

Choose a reason for hiding this comment

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

I like this proposal - simple, clean, good. Very well done!

enhancements/proposed/20210618-tips/tips.md

1. Is there a more preferred file format to YAML?

2. Maybe we just want to sync the tips to the `FAQ` page list instead of creating a new page?
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the original plan was to sync with FAQ but I think new page is the way to go, FAQ should be specifically for answering questions to common problems, tips should be interesting features people might want to try out.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback @andriyDev! Yep it's kind of hard to fit these tips with the current FAQ items. Will bring this up in office hour and see what everyone thinks.

enhancements/proposed/20210618-tips/tips.md Outdated
```
```

On the docs side we should both questions and answers. On the CLI side
Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting idea! I think wording that correctly can be very tricky though, so it makes sense as a tip and as an answer. I'm a much bigger fan of just a set of tips.

enhancements/proposed/20210618-tips/tips.md

## Alternatives Considered

1. Is there a more preferred file format to YAML?
Copy link
Contributor

Choose a reason for hiding this comment

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

The only other file format we might use is JSON, and while I do like the JSON structure, it has a big flaw which is that new lines must be replaced with \n which can get messy, and make it hard to see how the tip actually looks. I'm pretty happy with YAML for the file format because it makes it very clear how it looks.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: andriyDev, dinever
To complete the pull request process, please assign sharifelgamal after the PR has been reviewed.
You can assign the PR to them by writing /assign @sharifelgamal in a comment when ready.

The full list of commands accepted by this bot can be found 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

@dinever dinever mentioned this pull request Jun 21, 2021
Merged
@medyagh medyagh merged commit 0c39714 into kubernetes:master Jun 21, 2021
@dinever dinever deleted the tips-of-the-day branch June 21, 2021 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andriyDev andriyDev andriyDev approved these changes

@spowelljr spowelljr Awaiting requested review from spowelljr

@tstromberg tstromberg Awaiting requested review from tstromberg

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dinever @k8s-ci-robot @minikube-bot @andriyDev @medyagh