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

Document the Service source #3913

Merged
merged 3 commits into from
Sep 15, 2023

Conversation

johngmyers
Copy link
Contributor

Description

Adds reference documentation for the service source.

Checklist

  • Unit tests updated
  • End user documentation updated

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 4, 2023
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 4, 2023
@johngmyers
Copy link
Contributor Author

/cc @mloiseleur

docs/sources/service.md Outdated Show resolved Hide resolved
docs/sources/service.md Outdated Show resolved Hide resolved

## Domain names

The domain names of the DNS entries created from a Service are sourced from the following places:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The domain names of the DNS entries created from a Service are sourced from the following places:
The domain names of the DNS entries created from a Service are sourced following this plan:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think "plan" is quite the right word. It is an algorithm, not a proposal. It does specify the locations where the data are sourced, so "places" isn't too far off, though the items do describe the act of adding instead of the data being added.

docs/sources/service.md Outdated Show resolved Hide resolved
`external-dns.alpha.kubernetes.io/internal-hostname` annotation.
This behavior is suppressed if the `--ignore-hostname-annotation` flag was specified.

* If no DNS entries were produced for a Service by the previous steps
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* If no DNS entries were produced for a Service by the previous steps
2. If no DNS entries were produced for a Service by the previous step

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This isn't the only place where items in the list depend on previous items not producing outputs. If we're going to take this sort of order-dependency as requiring a numbered list, we should do it consistently.

docs/sources/service.md Outdated Show resolved Hide resolved
docs/sources/service.md Outdated Show resolved Hide resolved
johngmyers and others added 2 commits September 6, 2023 17:16
Co-authored-by: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
@mloiseleur
Copy link
Contributor

/lgtm

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

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: johngmyers

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:

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 15, 2023
@k8s-ci-robot k8s-ci-robot merged commit fa332e9 into kubernetes-sigs:master Sep 15, 2023
14 checks passed
@johngmyers johngmyers deleted the doc-service branch September 16, 2023 00:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. lgtm "Looks good to me", indicates that a PR is ready to be merged. 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.

None yet

3 participants