From 53177b5de00f3c55f453ce6380fbdd001f43b79c Mon Sep 17 00:00:00 2001 From: Ti Zhou Date: Fri, 18 Aug 2017 02:45:12 +0800 Subject: [PATCH] Fixed several typos in markdown files. (#5005) --- docs/admin/kubelet.md | 2 +- docs/api-reference/v1.7/README.md | 4 ++-- .../v1.7/node_modules/jquery.scrollto/CHANGELOG.md | 4 ++-- docs/api-reference/v1.7/node_modules/marked/README.md | 2 +- docs/concepts/workloads/controllers/garbage-collection.md | 2 +- docs/home/contribute/style-guide.md | 4 ++-- docs/resources-reference/v1.7/README.md | 4 ++-- .../v1.7/node_modules/jquery.scrollto/CHANGELOG.md | 4 ++-- .../v1.7/node_modules/marked/README.md | 2 +- docs/setup/independent/create-cluster-kubeadm.md | 2 +- docs/tasks/debug-application-cluster/audit.md | 2 +- .../tasks/federation/set-up-cluster-federation-kubefed.md | 2 +- .../horizontal-pod-autoscale-walkthrough.md | 2 +- docs/tasks/tools/install-kubectl.md | 8 ++++---- .../declarative-object-management-configuration.md | 2 +- docs/user-guide/kubectl/v1.5/README.md | 2 +- docs/user-guide/kubectl/v1.7/README.md | 4 ++-- .../v1.7/node_modules/jquery.scrollto/CHANGELOG.md | 4 ++-- .../user-guide/kubectl/v1.7/node_modules/marked/README.md | 2 +- 19 files changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md index d4cff05478..cc762ed62b 100644 --- a/docs/admin/kubelet.md +++ b/docs/admin/kubelet.md @@ -70,7 +70,7 @@ kubelet --enable-custom-metrics Support for gathering custom metrics. --enable-debugging-handlers Enables server endpoints for log collection and local running of containers and commands (default true) --enable-server Enable the Kubelet's server (default true) - --enforce-node-allocatable stringSlice A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptible options are 'pods', 'system-reserved' & 'kube-reserved'. If the latter two options are specified, '--system-reserved-cgroup' & '--kube-reserved-cgroup' must also be set respectively. See https://git.k8s.io/community/contributors/design-proposals/node-allocatable.md for more details. (default [pods]) + --enforce-node-allocatable stringSlice A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptable options are 'pods', 'system-reserved' & 'kube-reserved'. If the latter two options are specified, '--system-reserved-cgroup' & '--kube-reserved-cgroup' must also be set respectively. See https://git.k8s.io/community/contributors/design-proposals/node-allocatable.md for more details. (default [pods]) --event-burst int32 Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0 (default 10) --event-qps int32 If > 0, limit event creations per second to this value. If 0, unlimited. (default 5) --eviction-hard string A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction. (default "memory.available<100Mi,nodefs.available<10%,nodefs.inodesFree<5%") diff --git a/docs/api-reference/v1.7/README.md b/docs/api-reference/v1.7/README.md index f6799c18b9..e8c00fe78d 100644 --- a/docs/api-reference/v1.7/README.md +++ b/docs/api-reference/v1.7/README.md @@ -6,7 +6,7 @@ Static compilation of html from markdown including processing for grouping code \> bdocs-tab:kubectl Deployment Config to run 3 nginx instances (max rollback set to 10 revisions). -bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the prefered tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting. +bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the preferred tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting. \`\`\`bdocs-tab:kubectl_yaml apiVersion: extensions/v1beta1 @@ -66,4 +66,4 @@ Apache License Version 2.0 ## FAQ Q: Why is it named brodocs? -A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. \ No newline at end of file +A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. diff --git a/docs/api-reference/v1.7/node_modules/jquery.scrollto/CHANGELOG.md b/docs/api-reference/v1.7/node_modules/jquery.scrollto/CHANGELOG.md index 874087615c..cdec0977f3 100644 --- a/docs/api-reference/v1.7/node_modules/jquery.scrollto/CHANGELOG.md +++ b/docs/api-reference/v1.7/node_modules/jquery.scrollto/CHANGELOG.md @@ -111,7 +111,7 @@ - In addition to window/document, if html or body are received, the plugin will choose the right one. ### Fix - The plugin accepts floating numbers, Thanks Ramin -- Using jQuery.nodeName where neccessary so that this works on xml+xhtml +- Using jQuery.nodeName where necessary so that this works on xml+xhtml - The max() internal function wasn't completely accurrate, now it is 98% (except for IE on quirks mode and it's not too noticeable). ## 1.4 @@ -183,4 +183,4 @@ - Two axes can be scrolled together, this is set with the option 'axis'. - In case 2 axes are chosen, the scrolling can be queued: one scrolls, and then the other. - There's an intermediary event, 'onAfterFirst' called in case the axes are queued, after the first ends. -- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value). \ No newline at end of file +- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value). diff --git a/docs/api-reference/v1.7/node_modules/marked/README.md b/docs/api-reference/v1.7/node_modules/marked/README.md index efa71aaaab..bb4b3a9652 100644 --- a/docs/api-reference/v1.7/node_modules/marked/README.md +++ b/docs/api-reference/v1.7/node_modules/marked/README.md @@ -297,7 +297,7 @@ $ cat hello.html The point of marked was to create a markdown compiler where it was possible to frequently parse huge chunks of markdown without having to worry about -caching the compiled output somehow...or blocking for an unnecesarily long time. +caching the compiled output somehow...or blocking for an unnecessarily long time. marked is very concise and still implements all markdown features. It is also now fully compatible with the client-side. diff --git a/docs/concepts/workloads/controllers/garbage-collection.md b/docs/concepts/workloads/controllers/garbage-collection.md index 26908545c9..0927ebea67 100644 --- a/docs/concepts/workloads/controllers/garbage-collection.md +++ b/docs/concepts/workloads/controllers/garbage-collection.md @@ -147,7 +147,7 @@ Here's an example that orphans the dependents of a ReplicaSet: kubectl delete replicaset my-repset --cascade=false ``` -### Addtional note on Deployments +### Additional note on Deployments When using cascading deletes with Deployments you *must* use `propagationPolicy: Foreground` to delete not only the ReplicaSets created, but also their Pods. If this type of _propagationPolicy_ diff --git a/docs/home/contribute/style-guide.md b/docs/home/contribute/style-guide.md index 594b5eb5b5..38575713be 100644 --- a/docs/home/contribute/style-guide.md +++ b/docs/home/contribute/style-guide.md @@ -221,12 +221,12 @@ Typing multiple lines does **not** work. The callout style only applies to the l **Note:** This is my note. - I didn't read the stlye guide. + I didn't read the style guide. {: .note} **Note:** This is my note. -I didn't read the stlye guide. +I didn't read the style guide. {: .note} ### Ordered Lists diff --git a/docs/resources-reference/v1.7/README.md b/docs/resources-reference/v1.7/README.md index f6799c18b9..e8c00fe78d 100644 --- a/docs/resources-reference/v1.7/README.md +++ b/docs/resources-reference/v1.7/README.md @@ -6,7 +6,7 @@ Static compilation of html from markdown including processing for grouping code \> bdocs-tab:kubectl Deployment Config to run 3 nginx instances (max rollback set to 10 revisions). -bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the prefered tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting. +bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the preferred tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting. \`\`\`bdocs-tab:kubectl_yaml apiVersion: extensions/v1beta1 @@ -66,4 +66,4 @@ Apache License Version 2.0 ## FAQ Q: Why is it named brodocs? -A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. \ No newline at end of file +A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. diff --git a/docs/resources-reference/v1.7/node_modules/jquery.scrollto/CHANGELOG.md b/docs/resources-reference/v1.7/node_modules/jquery.scrollto/CHANGELOG.md index 874087615c..cdec0977f3 100644 --- a/docs/resources-reference/v1.7/node_modules/jquery.scrollto/CHANGELOG.md +++ b/docs/resources-reference/v1.7/node_modules/jquery.scrollto/CHANGELOG.md @@ -111,7 +111,7 @@ - In addition to window/document, if html or body are received, the plugin will choose the right one. ### Fix - The plugin accepts floating numbers, Thanks Ramin -- Using jQuery.nodeName where neccessary so that this works on xml+xhtml +- Using jQuery.nodeName where necessary so that this works on xml+xhtml - The max() internal function wasn't completely accurrate, now it is 98% (except for IE on quirks mode and it's not too noticeable). ## 1.4 @@ -183,4 +183,4 @@ - Two axes can be scrolled together, this is set with the option 'axis'. - In case 2 axes are chosen, the scrolling can be queued: one scrolls, and then the other. - There's an intermediary event, 'onAfterFirst' called in case the axes are queued, after the first ends. -- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value). \ No newline at end of file +- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value). diff --git a/docs/resources-reference/v1.7/node_modules/marked/README.md b/docs/resources-reference/v1.7/node_modules/marked/README.md index efa71aaaab..bb4b3a9652 100644 --- a/docs/resources-reference/v1.7/node_modules/marked/README.md +++ b/docs/resources-reference/v1.7/node_modules/marked/README.md @@ -297,7 +297,7 @@ $ cat hello.html The point of marked was to create a markdown compiler where it was possible to frequently parse huge chunks of markdown without having to worry about -caching the compiled output somehow...or blocking for an unnecesarily long time. +caching the compiled output somehow...or blocking for an unnecessarily long time. marked is very concise and still implements all markdown features. It is also now fully compatible with the client-side. diff --git a/docs/setup/independent/create-cluster-kubeadm.md b/docs/setup/independent/create-cluster-kubeadm.md index a4577baff6..e834f06def 100644 --- a/docs/setup/independent/create-cluster-kubeadm.md +++ b/docs/setup/independent/create-cluster-kubeadm.md @@ -241,7 +241,7 @@ kubectl apply -f https://raw.githubusercontent.com/projectcalico/canal/master/k8 **Note:** - For flannel to work correctly, `--pod-network-cidr=10.244.0.0/16` has to be passed to `kubeadm init`. - flannel works on `amd64`, `arm`, `arm64` and `ppc64le`, but for it to work on an other platform than -`amd64` you have to manually download the manifest and replace `amd64` occurances with your chosen platform. +`amd64` you have to manually download the manifest and replace `amd64` occurences with your chosen platform. ```shell kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/master/Documentation/kube-flannel.yml diff --git a/docs/tasks/debug-application-cluster/audit.md b/docs/tasks/debug-application-cluster/audit.md index 7e799669c4..dab1c2e970 100644 --- a/docs/tasks/debug-application-cluster/audit.md +++ b/docs/tasks/debug-application-cluster/audit.md @@ -86,7 +86,7 @@ The known stages are: - `RequestReceived` - The stage for events generated as soon as the audit handler receives the request. - `ResponseStarted` - Once the response headers are sent, but before the response body is sent. This stage is only generated for long-running requests (e.g. watch). - `ResponseComplete` - Once the response body has been completed. -- `Panic` - Events generated when a panic occured. +- `Panic` - Events generated when a panic occurred. ### Audit Policy diff --git a/docs/tasks/federation/set-up-cluster-federation-kubefed.md b/docs/tasks/federation/set-up-cluster-federation-kubefed.md index cf74b87eef..4a5feeca17 100644 --- a/docs/tasks/federation/set-up-cluster-federation-kubefed.md +++ b/docs/tasks/federation/set-up-cluster-federation-kubefed.md @@ -262,7 +262,7 @@ kubefed init fellowship \ [service](/docs/concepts/services-networking/service/) on the host cluster. By default, this service is exposed as a [load balanced service](/docs/user-guide/services/#type-loadbalancer). -Most on-premises and bare-metal enviroments, and some cloud +Most on-premises and bare-metal environments, and some cloud environments lack support for load balanced services. `kubefed init` allows exposing the federation API server as a [`NodePort` service](/docs/user-guide/services/#type-nodeport) on diff --git a/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md b/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md index 92c9c1e0f1..3775bef981 100644 --- a/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md +++ b/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md @@ -294,7 +294,7 @@ Conditions: ---- ------ ------ ------- AbleToScale True ReadyForNewScale the last scale time was sufficiently old as to warrant a new scale ScalingActive True ValidMetricFound the HPA was able to successfully calculate a replica count from pods metric http_requests - ScalingLimited False DesiredWithinRange the desired replica count is within the acceptible range + ScalingLimited False DesiredWithinRange the desired replica count is within the acceptable range Events: ``` diff --git a/docs/tasks/tools/install-kubectl.md b/docs/tasks/tools/install-kubectl.md index 567c485397..81987f629e 100644 --- a/docs/tasks/tools/install-kubectl.md +++ b/docs/tasks/tools/install-kubectl.md @@ -92,7 +92,7 @@ kubectl can be installed as part of the Google Cloud SDK. gcloud components install kubectl -3. Run `kubectl version` to verify that the verison you've installed is sufficiently up-to-date. +3. Run `kubectl version` to verify that the version you've installed is sufficiently up-to-date. ## Install with snap on Ubuntu @@ -102,7 +102,7 @@ kubectl is available as a [snap](https://snapcraft.io/) application. sudo snap install kubectl --classic -2. Run `kubectl version` to verify that the verison you've installed is sufficiently up-to-date. +2. Run `kubectl version` to verify that the version you've installed is sufficiently up-to-date. ## Install with Homebrew on macOS @@ -110,7 +110,7 @@ kubectl is available as a [snap](https://snapcraft.io/) application. brew install kubectl -2. Run `kubectl version` to verify that the verison you've installed is sufficiently up-to-date. +2. Run `kubectl version` to verify that the version you've installed is sufficiently up-to-date. ## Install with Chocolatey on Windows @@ -118,7 +118,7 @@ kubectl is available as a [snap](https://snapcraft.io/) application. choco install kubernetes-cli -2. Run `kubectl version` to verify that the verison you've installed is sufficiently up-to-date. +2. Run `kubectl version` to verify that the version you've installed is sufficiently up-to-date. 3. Configure kubectl to use a remote Kubernetes cluster: cd C:\users\yourusername (Or wherever your %HOME% directory is) diff --git a/docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md b/docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md index d486086a75..176af388f8 100644 --- a/docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md +++ b/docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md @@ -41,7 +41,7 @@ Following are definitions for terms used in this document: values of an object, as observed by the Kubernetes cluster. These are kept in the Kubernetes cluster storage, typically etcd. - *declarative configuration writer / declarative writer*: A person or software component - that makes updates to a live object. The live writers refered to in this topic make changes + that makes updates to a live object. The live writers referred to in this topic make changes to object configuration files and run `kubectl apply` to write the changes. ## How to create objects diff --git a/docs/user-guide/kubectl/v1.5/README.md b/docs/user-guide/kubectl/v1.5/README.md index f6799c18b9..d280e192a3 100644 --- a/docs/user-guide/kubectl/v1.5/README.md +++ b/docs/user-guide/kubectl/v1.5/README.md @@ -66,4 +66,4 @@ Apache License Version 2.0 ## FAQ Q: Why is it named brodocs? -A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. \ No newline at end of file +A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. diff --git a/docs/user-guide/kubectl/v1.7/README.md b/docs/user-guide/kubectl/v1.7/README.md index f6799c18b9..e8c00fe78d 100644 --- a/docs/user-guide/kubectl/v1.7/README.md +++ b/docs/user-guide/kubectl/v1.7/README.md @@ -6,7 +6,7 @@ Static compilation of html from markdown including processing for grouping code \> bdocs-tab:kubectl Deployment Config to run 3 nginx instances (max rollback set to 10 revisions). -bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the prefered tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting. +bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the preferred tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting. \`\`\`bdocs-tab:kubectl_yaml apiVersion: extensions/v1beta1 @@ -66,4 +66,4 @@ Apache License Version 2.0 ## FAQ Q: Why is it named brodocs? -A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. \ No newline at end of file +A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. diff --git a/docs/user-guide/kubectl/v1.7/node_modules/jquery.scrollto/CHANGELOG.md b/docs/user-guide/kubectl/v1.7/node_modules/jquery.scrollto/CHANGELOG.md index 874087615c..cdec0977f3 100644 --- a/docs/user-guide/kubectl/v1.7/node_modules/jquery.scrollto/CHANGELOG.md +++ b/docs/user-guide/kubectl/v1.7/node_modules/jquery.scrollto/CHANGELOG.md @@ -111,7 +111,7 @@ - In addition to window/document, if html or body are received, the plugin will choose the right one. ### Fix - The plugin accepts floating numbers, Thanks Ramin -- Using jQuery.nodeName where neccessary so that this works on xml+xhtml +- Using jQuery.nodeName where necessary so that this works on xml+xhtml - The max() internal function wasn't completely accurrate, now it is 98% (except for IE on quirks mode and it's not too noticeable). ## 1.4 @@ -183,4 +183,4 @@ - Two axes can be scrolled together, this is set with the option 'axis'. - In case 2 axes are chosen, the scrolling can be queued: one scrolls, and then the other. - There's an intermediary event, 'onAfterFirst' called in case the axes are queued, after the first ends. -- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value). \ No newline at end of file +- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value). diff --git a/docs/user-guide/kubectl/v1.7/node_modules/marked/README.md b/docs/user-guide/kubectl/v1.7/node_modules/marked/README.md index efa71aaaab..bb4b3a9652 100644 --- a/docs/user-guide/kubectl/v1.7/node_modules/marked/README.md +++ b/docs/user-guide/kubectl/v1.7/node_modules/marked/README.md @@ -297,7 +297,7 @@ $ cat hello.html The point of marked was to create a markdown compiler where it was possible to frequently parse huge chunks of markdown without having to worry about -caching the compiled output somehow...or blocking for an unnecesarily long time. +caching the compiled output somehow...or blocking for an unnecessarily long time. marked is very concise and still implements all markdown features. It is also now fully compatible with the client-side.