Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add FAQ from kubectl.docs.kubernetes.io #5774

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

ashnehete
Copy link

@ashnehete ashnehete commented Sep 29, 2024

Add the following to docs:

  1. FAQ
  2. Eschewed Features at /contribute/features/eschewedfeatures/
  3. Versioning Policy at /docs/reference/versioningpolicy/

Links to glossary items are broken because the page isn't populated yet.

Part of #4338

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ashnehete
Once this PR has been reviewed and has the lgtm label, please assign ncapps for approval. For more information see the Kubernetes Code Review Process.

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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 29, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @ashnehete!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@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 Sep 29, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @ashnehete. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Sep 29, 2024
@ashnehete
Copy link
Author

/ok-to-test

@k8s-ci-robot
Copy link
Contributor

@ashnehete: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/ok-to-test

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-sigs/prow repository.

@k8s-ci-robot
Copy link
Contributor

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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-sigs/prow repository.

@ashnehete
Copy link
Author

Also adds the following:

  1. Set sidebar_menu_compact=true. This improves readability of the big sidebar menu. Also how it is currently on kubectl.docs.kubernetes.io.
  2. Add Kustomize Enhancement Proposal title to Contributing Features to improve clarity.

@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 Sep 29, 2024
@ashnehete
Copy link
Author

Also adds the following:

  1. Glossary
  2. Fix broken links

@ChristianCiach
Copy link

About the Removal directives: Kustomize offers the $delete operation for strategic merge patches and they are officially supported: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#basic-patch-format

I feel like stating that Kustomize does not offer "removal directives" seems a bit misleading.

Copy link
Member

@stormqueen1990 stormqueen1990 left a comment

Choose a reason for hiding this comment

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

Hi there, @ashnehete!

Thank you very much for your contribution! I found some small textual issues that I believe were already in the original doc, but would be nice to fix before we merge this one. Other than that, this looks good to me!

site/content/en/contribute/features/eschewedfeatures.md Outdated Show resolved Hide resolved
site/content/en/contribute/features/eschewedfeatures.md Outdated Show resolved Hide resolved
site/content/en/contribute/features/eschewedfeatures.md Outdated Show resolved Hide resolved
ashnehete and others added 3 commits November 9, 2024 16:13
Co-authored-by: Mauren <698465+stormqueen1990@users.noreply.github.com>
Co-authored-by: Mauren <698465+stormqueen1990@users.noreply.github.com>
Co-authored-by: Mauren <698465+stormqueen1990@users.noreply.github.com>
@eddiezane
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 14, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants