-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Apply various contentual and stylish improvements to the k8s docs. #2677
Apply various contentual and stylish improvements to the k8s docs. #2677
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @timoreimann.
Many thanks for this PR.
Only few suggestions about the formatting.
|
||
Secure token will be found in `/var/run/secrets/kubernetes.io/serviceaccount/token` and SSL CA cert in `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt` | ||
The access token will be looked up in `/var/run/secrets/kubernetes.io/serviceaccount/token` and the SSL CA certificate in `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt`. Both are provided mounted automatically when deployed inside Kubernetes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you use one line per sentence?
|
||
### `labelselector` | ||
|
||
Ingress label selector to identify Ingress objects that should be processed. | ||
By default, Traefik processes all Ingress objects in the configured namespaces. A label selector can be defined to filter on specific Ingress objects only. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you use one line per sentence?
Override the default frontend PassTLSCert value. Default: `false`. | ||
- `ingress.kubernetes.io/whitelist-source-range: "1.2.3.0/24, fe80::/16"` | ||
A comma-separated list of IP ranges permitted for access. all source IPs are permitted if the list is empty or a single range is ill-formated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you use one line per sentence and begin the second sentence by an upper-case?
I'm not sure but ill-formated
shoud not be ill-formatted
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are right. :-)
f9d79ab
to
0356c0a
Compare
@nmengin addressed your comments. Also rebased to fix a merge conflict and re-formatted an updated table. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@timoreimann a last remark and it will be good to me.
|
||
If you are not familiar with Ingresses in Kubernetes you might want to read the [Kubernetes user guide](https://kubernetes.io/docs/concepts/services-networking/ingress/) | ||
|
||
The config files used in this guide can be found in the [examples directory](https://github.com/containous/traefik/tree/master/examples/k8s) | ||
|
||
## Prerequisites | ||
|
||
1. A working Kubernetes cluster. If you want to follow along with this guide, you should setup [minikube](https://kubernetes.io/docs/getting-started-guides/minikube/) | ||
on your machine, as it is the quickest way to get a local Kubernetes cluster setup for experimentation and development. | ||
1. A working Kubernetes cluster. If you want to follow along with this guide, you should setup [minikube](https://kubernetes.io/docs/getting-started-guides/minikube/) on your machine, as it is the quickest way to get a local Kubernetes cluster setup for experimentation and development. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I forgot to mention these sentences to split too. 😉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this sentence is part of a list item, splitting it means that MD032 is triggered. I'd opt for keeping it the way it is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👏 📖
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This includes addressing a number of markdown linter violations. Details: - Improve terminology. - Rephrase several sentences. - Group service-based annotations consistently. - Add note about Helm chart maintainership. - Fix headline levels. - Fix headline titles. - Fix grammar. - Improve formatting. - Remove trailing white-spaces. - Remove extra white-spaces. - Specify language on fenced code blocks. - Surround fenced clode blocks by blank line.
0356c0a
to
aa76b02
Compare
This includes addressing a number of markdown linter violations.
Details: