Apply various contentual and stylish improvements to the k8s docs. #2677
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nmengin
requested changes
Jan 9, 2018
There was a problem hiding this comment.
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.
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.
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.
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.
You are right. :-)
timoreimann
force-pushed
the
kubernetes/various-doc-improvements
branch
from
f9d79ab
to
0356c0a
Compare
|
@nmengin addressed your comments. Also rebased to fix a merge conflict and re-formatted an updated table. |
nmengin
requested changes
Jan 10, 2018
|
|
||
| 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.
I forgot to mention these sentences to split too. 😉
There was a problem hiding this comment.
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.
traefiker
approved these changes
Jan 15, 2018
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.
traefiker
force-pushed
the
kubernetes/various-doc-improvements
branch
from
0356c0a
to
aa76b02
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This includes addressing a number of markdown linter violations.
Details: