Skip to content

Commit 222b95f

Browse files
authored
fix(docs): Fixing typos in docs and comments (#5995)
1 parent 2dc1b1b commit 222b95f

File tree

13 files changed

+21
-21
lines changed

13 files changed

+21
-21
lines changed

docs/20190708-external-dns-incubator.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
[ExternalDNS](https://github.com/kubernetes-sigs/external-dns) is a project that synchronizes Kubernetes' Services, Ingresses and other Kubernetes resources to DNS backends for several DNS providers.
2020

21-
The projects was started as a Kubernetes Incubator project in February 2017 and being the Kubernetes incubation initiative officially over, the maintainers want to propose the project to be moved to the kubernetes GitHub organization or to kubernetes-sigs, under the sponsorship of sig-network.
21+
The project was started as a Kubernetes Incubator project in February 2017 and being the Kubernetes incubation initiative officially over, the maintainers want to propose the project to be moved to the kubernetes GitHub organization or to kubernetes-sigs, under the sponsorship of sig-network.
2222

2323
## Motivation
2424

@@ -62,7 +62,7 @@ Given that the kubernetes-sigs organization will eventually be shut down, the po
6262

6363
- Move the project elsewhere
6464

65-
We believe that those alternatives would result in a worse outcome for the community compared to moving the project to the any of the other official Kubernetes organizations.
65+
We believe that those alternatives would result in a worse outcome for the community compared to moving the project to any of the other official Kubernetes organizations.
6666
In fact, shutting down ExternalDNS can cause:
6767

6868
- The community to rebuild the same solution as already happened multiple times before the project was launched. Currently ExternalDNS is easy to be found, referenced in many articles/tutorials and for that reason not exposed to that risk.
@@ -89,7 +89,7 @@ We have evidence that many companies are using ExternalDNS in production, but it
8989

9090
The project was quoted by a number of tutorials on the web, including the [official tutorials from AWS](https://aws.amazon.com/blogs/opensource/unified-service-discovery-ecs-kubernetes/).
9191

92-
ExternalDNS can't be consider to be "done": while the core functionality has been implemented, there is lack of integration testing and structural changes that are needed.
92+
ExternalDNS can't be considered to be "done": while the core functionality has been implemented, there is lack of integration testing and structural changes that are needed.
9393

9494
Those are identified in the project roadmap, which is roughly made of the following items:
9595

@@ -132,7 +132,7 @@ The release pipeline for the project is currently fully owned by Zalando. It run
132132

133133
The docker registry service is provided as best effort with no sort of SLA and the maintainers team openly suggests the users to build and maintain their own docker image based on the provided Dockerfiles.
134134

135-
Providing a vanity URL for the docker images was consider a non goal till now, but the community seems to be wanting official images from a GCR domain, similarly to what is available for other parts of official Kubernetes projects.
135+
Providing a vanity URL for the docker images was considered a non goal till now, but the community seems to be wanting official images from a GCR domain, similarly to what is available for other parts of official Kubernetes projects.
136136

137137
ExternalDNS does not follow a specific release cycle. Releases are made often when there are major contributions (i.e. new providers) or important bug fixes. That said, the default branch is considered stable and can be used as well to build images.
138138

docs/advanced/configuration-precedence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ flowchart TD
3737

3838
3. **Environment Variables**
3939
- May override defaults, and in some cases may take precedence over CLI flags and annotations.
40-
- Behavior depends on how the variable is mapped in the code. Where or not it replicates CLI flag or provider specific. Example: `kubectl` or `cloudflare`.
40+
- Behavior depends on how the variable is mapped in the code. Whether or not it replicates CLI flag or provider specific. Example: `kubectl` or `cloudflare`.
4141

4242
4. **Defaults**
4343
- If none of the above specify a value, ExternalDNS falls back to its defaults.

docs/advanced/fqdn-templating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ This is helpful in scenarios such as:
241241
- You must still ensure the resulting FQDN is valid and unique.
242242
- Since Go templates can be error-prone, test your template with simple examples before deploying. Mismatched field names or nil values (e.g., missing labels) will result in errors or skipped entries.
243243

244-
## FaQ
244+
## FAQ
245245

246246
### Can I specify multiple global FQDN templates?
247247

docs/contributing/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can pick which `Source` and `Provider` to use at runtime via the `--source`
1919

2020
## Adding a DNS Provider
2121

22-
A typical way to start on, e.g. a CoreDNS provider, would be to add a `coredns.go` to the providers package and implement the interface methods. Then you would have to register your provider under a name in `main.go`, e.g. `coredns`, and would be able to trigger it's functions via setting `--provider=coredns`.
22+
A typical way to start on, e.g. a CoreDNS provider, would be to add a `coredns.go` to the providers package and implement the interface methods. Then you would have to register your provider under a name in `main.go`, e.g. `coredns`, and would be able to trigger its functions via setting `--provider=coredns`.
2323

2424
Note, how your provider doesn't need to know anything about where the DNS records come from, nor does it have to figure out the difference between the current and the desired state, it merely executes the actions calculated by the plan.
2525

docs/contributing/dev-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Building and/or testing `external-dns` requires additional tooling.
1818

1919
## First Steps
2020

21-
***Configure Development Environment**
21+
***Configure Development Environment***
2222

2323
You must have a working [Go environment](https://go.dev/doc/install), compile the build, and set up testing.
2424

@@ -154,7 +154,7 @@ When building local images with ko you can't specify the registry used to create
154154
❯❯ export KO_DOCKER_REPO=ko.local
155155
❯❯ export VERSION=v1
156156
❯❯ docker context use rancher-desktop ## (optional) this command is only required when using rancher-desktop
157-
❯❯ ls -al /var/run/docker.sock ## (optional) validate tha docker runtime is configured correctly and symlink exist
157+
❯❯ ls -al /var/run/docker.sock ## (optional) validate that docker runtime is configured correctly and symlink exists
158158

159159
❯❯ ko build --tags ${VERSION}
160160
❯❯ docker images
@@ -275,7 +275,7 @@ This helm chart comes with a JSON schema generated from values with [helm schema
275275
❯❯ scripts/helm-tools.sh --docs
276276
```
277277

278-
6. Run helm unittets.
278+
6. Run helm unittests.
279279

280280
```sh
281281
❯❯ make helm-test

docs/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Under certain circumstances you want to force ExternalDNS to create CNAME record
168168
Why should I want to force ExternalDNS to create CNAME records for ELB/ALB? Some motivations of users were:
169169

170170
> "Our hosted zones records are synchronized with our enterprise DNS. The record type ALIAS is an AWS proprietary record type and AWS allows you to set a DNS record directly on AWS resources.
171-
> Since this is not a DNS RfC standard and therefore can not be transferred and created in our enterprise DNS. So we need to force CNAME creation instead."
171+
> Since this is not a DNS RFC standard and therefore can not be transferred and created in our enterprise DNS. So we need to force CNAME creation instead."
172172

173173
or
174174

@@ -251,14 +251,14 @@ If you need to search for multiple ingress classes, you can specify the flag mul
251251
`--ingress-class=internal --ingress-class=external`.
252252

253253
The `--ingress-class` flag will check both the `spec.ingressClassName` field and the deprecated `kubernetes.io/ingress.class` annotation.
254-
The `spec.ingressClassName` tasks precedence over the annotation if both are supplied.
254+
The `spec.ingressClassName` takes precedence over the annotation if both are supplied.
255255

256256
**Backward compatibility**
257257

258258
The previous `--annotation-filter` flag can still be used to restrict which objects ExternalDNS considers; for example, `--annotation-filter=kubernetes.io/ingress.class in (public,dmz)`.
259259

260260
However, beware when using annotation filters with multiple sources, e.g. `--source=service --source=ingress`, since `--annotation-filter` will filter every given source object.
261-
If you need to use annotation filters against a specific source you have to run a separated external dns service containing only the wanted `--source` and `--annotation-filter`.
261+
If you need to use annotation filters against a specific source you have to run a separated external dns service containing only the wanted `--source` and `--annotation-filter`.
262262

263263
Note: the `--ingress-class` flag cannot be used at the same time as the `--annotation-filter=kubernetes.io/ingress.class in (...)` flag; if you do this an error will be raised.
264264

docs/tutorials/cloudflare.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ By setting the TTL annotation on the service, you have to pass a valid TTL, whic
304304
This annotation is optional, if you won't set it, it will be 1 (automatic) which is 300.
305305
For Cloudflare proxied entries, set the TTL annotation to 1 (automatic), or do not set it.
306306
307-
ExternalDNS uses this annotation to determine what services should be registered with DNS. Removing the annotation
307+
ExternalDNS uses this annotation to determine what services should be registered with DNS. Removing the annotation
308308
will cause ExternalDNS to remove the corresponding DNS records.
309309
310310
Create the deployment and service:
@@ -339,7 +339,7 @@ kubectl delete -f externaldns.yaml
339339

340340
Using the `external-dns.alpha.kubernetes.io/cloudflare-proxied: "true"` annotation on your ingress, you can specify if the proxy feature of Cloudflare should be enabled for that record. This setting will override the global `--cloudflare-proxied` setting.
341341

342-
## Setting cloudlfare regional services
342+
## Setting cloudflare regional services
343343

344344
With Cloudflare regional services you can restrict which data centers can decrypt and serve HTTPS traffic.
345345

plan/conflict.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ func (s PerResource) ResolveUpdate(current *endpoint.Endpoint, candidates []*end
6666
}
6767

6868
// ResolveRecordTypes attempts to detect and resolve record type conflicts in desired
69-
// endpoints for a domain. For eample if the there is more than 1 candidate and at lease one
69+
// endpoints for a domain. For example if there is more than 1 candidate and at least one
7070
// of them is a CNAME. Per [RFC 1034 3.6.2] domains that contain a CNAME can not contain any
7171
// other record types. The default policy will prefer A and AAAA record types when a conflict is
7272
// detected (consistent with [endpoint.Targets.Less]).

plan/plan_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -711,7 +711,7 @@ func (suite *PlanTestSuite) TestCurrentWithConflictingDesired() {
711711
}
712712

713713
// TestNoCurrentWithConflictingDesired simulates where the desired records result in conflicting records types.
714-
// This could be the result of multiple sources generating conflicting records types. In this case there the
714+
// This could be the result of multiple sources generating conflicting records types. In this case, the
715715
// conflict resolver should prefer the A and AAAA record and drop the other candidate record types.
716716
func (suite *PlanTestSuite) TestNoCurrentWithConflictingDesired() {
717717
current := []*endpoint.Endpoint{}

provider/rfc2136/rfc2136_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ func TestRfc2136GetRecords(t *testing.T) {
547547
}
548548

549549
// Make sure the test version of SendMessage raises an error
550-
// if a zone update ever contains records outside of it's zone
550+
// if a zone update ever contains records outside of its zone
551551
// as the TestRfc2136ApplyChanges tests all assume this
552552
func TestRfc2136SendMessage(t *testing.T) {
553553
stub := newStub()

0 commit comments

Comments
 (0)