From eee3a97b35049bfc4b832f7eb54652cf309341df Mon Sep 17 00:00:00 2001 From: tvshc Date: Tue, 21 Aug 2018 13:21:33 -0400 Subject: [PATCH 1/9] Added title case capitalization to the page title (#9998) --- .../tasks/access-kubernetes-api/setup-extension-api-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md b/content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md index b96cd02e0a7..f1fdc298d6e 100644 --- a/content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md +++ b/content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md @@ -1,5 +1,5 @@ --- -title: Setup an extension API server +title: Setup an Extension API Server reviewers: - lavalamp - cheftako From 8a0fcb1716a309531f8cd96b7d2f809e198c1963 Mon Sep 17 00:00:00 2001 From: JuleeB1 <42522858+JuleeB1@users.noreply.github.com> Date: Tue, 21 Aug 2018 12:24:06 -0500 Subject: [PATCH 2/9] Moved the closing note tag (#9979) Included the "where" statement in the note --- .../docs/tasks/federation/set-up-cluster-federation-kubefed.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md b/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md index 22388f0bf5a..bd29c9af2f5 100644 --- a/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md +++ b/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md @@ -206,9 +206,9 @@ newly deployed federation. You can set the current context manually by running: ```shell kubectl config use-context fellowship ``` -{{< /note >}} where `fellowship` is the name of your federation. +{{< /note >}} ### Basic and token authentication support From d81c0c3cd594ac0ed8514b0e8fcb79f729aa6611 Mon Sep 17 00:00:00 2001 From: tvshc Date: Tue, 21 Aug 2018 13:26:39 -0400 Subject: [PATCH 3/9] Removed gerund from page title (#9993) Page titles are in the verb's infinitive form throughout the d11n. Changed the title from the gerund form to infinitive to align it with the other page titles. --- content/en/docs/tasks/manage-daemon/rollback-daemon-set.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/manage-daemon/rollback-daemon-set.md b/content/en/docs/tasks/manage-daemon/rollback-daemon-set.md index fe220c1a6b8..1acc25ace0c 100644 --- a/content/en/docs/tasks/manage-daemon/rollback-daemon-set.md +++ b/content/en/docs/tasks/manage-daemon/rollback-daemon-set.md @@ -1,7 +1,7 @@ --- reviewers: - janetkuo -title: Performing a Rollback on a DaemonSet +title: Perform a Rollback on a DaemonSet content_template: templates/task --- From 0ff0d79243b9bd801c606ef60c5aae46fbc88bbd Mon Sep 17 00:00:00 2001 From: tvshc Date: Tue, 21 Aug 2018 13:29:16 -0400 Subject: [PATCH 4/9] Format security note with proper highlighting (#9942) * Format security note with proper callout The information about security of ssh keys might benefit from standing out more. Thus included it in a caution shortcode. Formatting is now more aligned with the style guide. * close caution tag --- content/en/docs/concepts/configuration/secret.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/docs/concepts/configuration/secret.md b/content/en/docs/concepts/configuration/secret.md index e2469c1c83f..722d0217e1d 100644 --- a/content/en/docs/concepts/configuration/secret.md +++ b/content/en/docs/concepts/configuration/secret.md @@ -482,7 +482,9 @@ Create a secret containing some ssh keys: $ kubectl create secret generic ssh-key-secret --from-file=ssh-privatekey=/path/to/.ssh/id_rsa --from-file=ssh-publickey=/path/to/.ssh/id_rsa.pub ``` -**Security Note:** Think carefully before sending your own ssh keys: other users of the cluster may have access to the secret. Use a service account which you want to be accessible to all the users with whom you share the Kubernetes cluster, and can revoke if they are compromised. +{{< caution >}} +**Caution:** Think carefully before sending your own ssh keys: other users of the cluster may have access to the secret. Use a service account which you want to be accessible to all the users with whom you share the Kubernetes cluster, and can revoke if they are compromised. +{{< /caution >}} Now we can create a pod which references the secret with the ssh key and From ec889579609468b99fab2cca05f96982d3b3e2f0 Mon Sep 17 00:00:00 2001 From: tvshc Date: Tue, 21 Aug 2018 13:31:45 -0400 Subject: [PATCH 5/9] Added title case capitalization to the page title (#9997) --- .../tasks/access-kubernetes-api/configure-aggregation-layer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/access-kubernetes-api/configure-aggregation-layer.md b/content/en/docs/tasks/access-kubernetes-api/configure-aggregation-layer.md index 59bcc29ac3e..36d798fd64a 100644 --- a/content/en/docs/tasks/access-kubernetes-api/configure-aggregation-layer.md +++ b/content/en/docs/tasks/access-kubernetes-api/configure-aggregation-layer.md @@ -1,5 +1,5 @@ --- -title: Configure the aggregation layer +title: Configure the Aggregation Layer reviewers: - lavalamp - cheftako From 121501c540dbebf26159e448ecbb7a5199e10c73 Mon Sep 17 00:00:00 2001 From: JuleeB1 <42522858+JuleeB1@users.noreply.github.com> Date: Tue, 21 Aug 2018 12:36:25 -0500 Subject: [PATCH 6/9] Added Note Formatting and Removed Contractions (#9983) Added the note tag to the text and revised text to remove contractions --- content/en/docs/tasks/manage-daemon/update-daemon-set.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/content/en/docs/tasks/manage-daemon/update-daemon-set.md b/content/en/docs/tasks/manage-daemon/update-daemon-set.md index 564f8a8fbb9..a8a256c4829 100644 --- a/content/en/docs/tasks/manage-daemon/update-daemon-set.md +++ b/content/en/docs/tasks/manage-daemon/update-daemon-set.md @@ -159,11 +159,12 @@ kubectl get pods -l = -o wide ``` Once you've found those nodes, delete some non-DaemonSet pods from the node to -make room for new DaemonSet pods. Note that this will cause service disruption -if the deleted pods are not controlled by any controllers, or if the pods aren't -replicated. This doesn't respect -[PodDisruptionBudget](/docs/tasks/configure-pod-container/configure-pod-disruption-budget/) +make room for new DaemonSet pods. +{{< note >}} +**Note:** This will cause service disruption when deleted pods are not controlled by any controllers or pods are not +replicated. This does not respect [PodDisruptionBudget](/docs/tasks/configure-pod-container/configure-pod-disruption-budget/) either. +{{< /note >}} #### Broken rollout From 76d992a452a37fdd9a6b684071fe7a96820abf5d Mon Sep 17 00:00:00 2001 From: JuleeB1 <42522858+JuleeB1@users.noreply.github.com> Date: Tue, 21 Aug 2018 12:41:03 -0500 Subject: [PATCH 7/9] Added Note Formatting (#9984) Added note tags to the text. --- content/en/docs/tasks/manage-daemon/rollback-daemon-set.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/en/docs/tasks/manage-daemon/rollback-daemon-set.md b/content/en/docs/tasks/manage-daemon/rollback-daemon-set.md index 1acc25ace0c..fbd57b98c05 100644 --- a/content/en/docs/tasks/manage-daemon/rollback-daemon-set.md +++ b/content/en/docs/tasks/manage-daemon/rollback-daemon-set.md @@ -139,11 +139,13 @@ DaemonSet template with the template stored in the `ControllerRevision`. previous revision through other commands, such as `kubectl edit` or `kubectl apply`. -Note that DaemonSet revisions only roll forward. That is to say, after a -rollback is complete, the revision number (`.revision` field) of the +{{< note >}} +**Note:** DaemonSet revisions only roll forward. That is to say, after a +rollback completes, the revision number (`.revision` field) of the `ControllerRevision` being rolled back to will advance. For example, if you have revision 1 and 2 in the system, and roll back from revision 2 to revision 1, the `ControllerRevision` with `.revision: 1` will become `.revision: 3`. +{{< /note >}} ## Troubleshooting From 2919058ac829e1b25b9f5056a2fb0fdf1f28fded Mon Sep 17 00:00:00 2001 From: JuleeB1 <42522858+JuleeB1@users.noreply.github.com> Date: Tue, 21 Aug 2018 12:50:21 -0500 Subject: [PATCH 8/9] Added Note Formatting (#9985) * Added Note Formatting Added note tags to the text. * Add minor copyedit --- content/en/docs/tasks/administer-federation/configmap.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/en/docs/tasks/administer-federation/configmap.md b/content/en/docs/tasks/administer-federation/configmap.md index 0b597d3fddf..f9c36049a9f 100644 --- a/content/en/docs/tasks/administer-federation/configmap.md +++ b/content/en/docs/tasks/administer-federation/configmap.md @@ -78,10 +78,9 @@ For example, you can do that using kubectl by running: kubectl --context=federation-cluster delete configmap ``` -Note that at this point, deleting a Federated ConfigMap will not delete the -corresponding ConfigMaps from underlying clusters. -You must delete the underlying ConfigMaps manually. -We intend to fix this in the future. +{{< note >}} +**Note:** Deleting a Federated ConfigMap does not delete the corresponding ConfigMaps from underlying clusters. You must delete the underlying ConfigMaps manually. +{{< /note >}} {{% /capture %}} From b28981e7ab81aeee928a1b815e13fd18aa31989e Mon Sep 17 00:00:00 2001 From: JuleeB1 <42522858+JuleeB1@users.noreply.github.com> Date: Tue, 21 Aug 2018 12:52:58 -0500 Subject: [PATCH 9/9] Added Note Formatting (#9986) Added note tags to the text. --- content/en/docs/tasks/administer-federation/hpa.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/tasks/administer-federation/hpa.md b/content/en/docs/tasks/administer-federation/hpa.md index 839b4d04d39..f33294cfcef 100644 --- a/content/en/docs/tasks/administer-federation/hpa.md +++ b/content/en/docs/tasks/administer-federation/hpa.md @@ -122,10 +122,10 @@ in the previous section. You can delete a federated HPA as you would delete a Kubernetes HPA; however, for a federated HPA, you must send the request to -the federation API server instead of sending it to a specific Kubernetes cluster. -It should also be noted that for the federated resource to be deleted from -all underlying clusters, [cascading deletion](/docs/concepts/cluster-administration/federation/#cascading-deletion) -should be used. +the federation API server instead of to a specific Kubernetes cluster. +{{< note >}} +**Note:** For the federated resource to be deleted from all underlying clusters, [cascading deletion](/docs/concepts/cluster-administration/federation/#cascading-deletion) should be used. +{{< /note >}} For example, you can do that using `kubectl` by running: