kubernetes-sigs / external-dns

Configure external DNS servers (AWS Route53, Google CloudDNS and others) for Kubernetes Ingresses and Services
Apache License 2.0
7.75k stars 2.58k forks source link

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

Open juan-vg opened 1 week ago

juan-vg commented 1 week ago

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

linux-foundation-easycla[bot] commented 1 week ago

CLA Signed

The committers listed above are authorized under a signed CLA.

k8s-ci-robot commented 1 week ago

[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: - **[OWNERS](https://github.com/kubernetes-sigs/external-dns/blob/master/OWNERS)** 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 commented 1 week ago

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. :smiley:

k8s-ci-robot commented 1 week ago

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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
mloiseleur commented 1 week ago

Thanks for this PR @juan-vg It's a good idea to provide ready-to-go examples :+1: . 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 commented 1 week ago

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 commented 1 week ago

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

juan-vg commented 3 days ago

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