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

Improve sources' docs to mention '--managed-record-types' #4882

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

Conversation

juan-vg
Copy link

@juan-vg juan-vg commented Nov 18, 2024

Description

Docs are lacking info about the --managed-record-types flag, especially for the record types that are not managed by default. This change improves the sources' docs to mention this flag and also adds some CRD examples for AWS and Cloudflare (other providers should be addressed also) while warning users that some record types must be explicitly allowed to be managed.

Fixes #4831

Checklist

  • Unit tests updated
  • End user documentation updated

* Also add some CRD examples for AWS and Cloudflare
Copy link

linux-foundation-easycla bot commented Nov 18, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign raffo 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: no Indicates the PR's author has not signed the CNCF CLA. label Nov 18, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @juan-vg!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. 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/external-dns 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
Copy link
Contributor

Hi @juan-vg. 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 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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 18, 2024
@mloiseleur
Copy link
Contributor

Thanks for this PR @juan-vg
It's a good idea to provide ready-to-go examples 👍 .
Wdyt of:

  1. Move "Contribution>CRD Source" to "Sources>CRD"
  2. Insert example in this moved page
  3. Put a link to this moved page instead of copy pasting three times the same doc block

@juan-vg
Copy link
Author

juan-vg commented Nov 18, 2024

Thanks for this PR @juan-vg It's a good idea to provide ready-to-go examples 👍 . Wdyt of:

1. Move "Contribution>CRD Source" to "Sources>CRD"

2. Insert example in this moved page

3. Put a link to this moved page instead of copy pasting three times the same doc block

That's definitely a good idea to stay DRY. However, when you refer to "Contribution>CRD Source" do you mean the tutorials?

@mloiseleur
Copy link
Contributor

I mean this: https://kubernetes-sigs.github.io/external-dns/latest/docs/contributing/crd-source/

@juan-vg
Copy link
Author

juan-vg commented Nov 26, 2024

@mloiseleur done! Please let me know if there's something else I could do to improve the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

NS record not being created via CRD
3 participants