From 74360fa8ee365c0b439aeb707aac65ddd5eafd0c Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Sun, 14 Jun 2020 20:35:48 +0100 Subject: [PATCH] Add descriptions for tasks Add description metadata for each task section (English localization). For sections that only have one page, make sure that that sole page has description metadata set. This change helps prepare for the migration to the Docsy theme. --- content/en/docs/tasks/_index.md | 6 +++--- .../en/docs/tasks/access-application-cluster/_index.md | 1 + content/en/docs/tasks/administer-cluster/_index.md | 1 + content/en/docs/tasks/configure-pod-container/_index.md | 1 + .../en/docs/tasks/debug-application-cluster/_index.md | 1 + content/en/docs/tasks/extend-kubectl/kubectl-plugins.md | 2 +- content/en/docs/tasks/extend-kubernetes/_index.md | 1 + content/en/docs/tasks/inject-data-application/_index.md | 1 + content/en/docs/tasks/job/_index.md | 1 + content/en/docs/tasks/manage-daemon/_index.md | 1 + content/en/docs/tasks/manage-gpus/scheduling-gpus.md | 1 + .../docs/tasks/manage-hugepages/scheduling-hugepages.md | 9 ++------- .../en/docs/tasks/manage-kubernetes-objects/_index.md | 1 + content/en/docs/tasks/network/_index.md | 3 ++- content/en/docs/tasks/run-application/_index.md | 1 + content/en/docs/tasks/service-catalog/_index.md | 3 ++- content/en/docs/tasks/tls/_index.md | 1 + content/en/docs/tasks/tools/_index.md | 1 + 18 files changed, 23 insertions(+), 13 deletions(-) diff --git a/content/en/docs/tasks/_index.md b/content/en/docs/tasks/_index.md index 16e57e1ca4..411171bb39 100644 --- a/content/en/docs/tasks/_index.md +++ b/content/en/docs/tasks/_index.md @@ -50,7 +50,7 @@ Learn various methods to directly access the Kubernetes API. ## Using TLS -Configure your application to trust and use the cluster root Certificate Authority (CA). +Understand how to protect traffic within your cluster using Transport Layer Security (TLS). ## Administering a Cluster @@ -66,11 +66,11 @@ Perform common tasks for managing a DaemonSet, such as performing a rolling upda ## Managing GPUs -Configure and schedule NVIDIA GPUs for use as a resource by nodes in a cluster. +Configure and schedule GPUs for use as a resource by nodes in a cluster. ## Managing HugePages -Configure and schedule huge pages as a schedulable resource in a cluster. +Configure and manage huge pages as a schedulable resource in a cluster. diff --git a/content/en/docs/tasks/access-application-cluster/_index.md b/content/en/docs/tasks/access-application-cluster/_index.md index e829d22b29..4d7af48310 100755 --- a/content/en/docs/tasks/access-application-cluster/_index.md +++ b/content/en/docs/tasks/access-application-cluster/_index.md @@ -1,5 +1,6 @@ --- title: "Access Applications in a Cluster" +description: Configure load balancing, port forwarding, or setup firewall or DNS configurations to access applications in a cluster. weight: 60 --- diff --git a/content/en/docs/tasks/administer-cluster/_index.md b/content/en/docs/tasks/administer-cluster/_index.md index 55154406fe..6d869da354 100755 --- a/content/en/docs/tasks/administer-cluster/_index.md +++ b/content/en/docs/tasks/administer-cluster/_index.md @@ -1,5 +1,6 @@ --- title: "Administer a Cluster" +description: Learn common tasks for administering a cluster. weight: 20 --- diff --git a/content/en/docs/tasks/configure-pod-container/_index.md b/content/en/docs/tasks/configure-pod-container/_index.md index ea8d5a89d5..462b19e4e9 100755 --- a/content/en/docs/tasks/configure-pod-container/_index.md +++ b/content/en/docs/tasks/configure-pod-container/_index.md @@ -1,5 +1,6 @@ --- title: "Configure Pods and Containers" +description: Perform common configuration tasks for Pods and containers. weight: 20 --- diff --git a/content/en/docs/tasks/debug-application-cluster/_index.md b/content/en/docs/tasks/debug-application-cluster/_index.md index edce58d23a..0aa5f76478 100755 --- a/content/en/docs/tasks/debug-application-cluster/_index.md +++ b/content/en/docs/tasks/debug-application-cluster/_index.md @@ -1,5 +1,6 @@ --- title: "Monitoring, Logging, and Debugging" +description: Set up monitoring and logging to troubleshoot a cluster, or debug a containerized application. weight: 80 --- diff --git a/content/en/docs/tasks/extend-kubectl/kubectl-plugins.md b/content/en/docs/tasks/extend-kubectl/kubectl-plugins.md index 7d14b86f24..6052bff9af 100644 --- a/content/en/docs/tasks/extend-kubectl/kubectl-plugins.md +++ b/content/en/docs/tasks/extend-kubectl/kubectl-plugins.md @@ -3,7 +3,7 @@ title: Extend kubectl with plugins reviewers: - juanvallejo - soltysh -description: With kubectl plugins, you can extend the functionality of the kubectl command by adding new subcommands. +description: Extend kubectl by creating and installing kubectl plugins. content_type: task --- diff --git a/content/en/docs/tasks/extend-kubernetes/_index.md b/content/en/docs/tasks/extend-kubernetes/_index.md index f883cdee9d..7109fddde0 100644 --- a/content/en/docs/tasks/extend-kubernetes/_index.md +++ b/content/en/docs/tasks/extend-kubernetes/_index.md @@ -1,5 +1,6 @@ --- title: "Extend Kubernetes" +description: Understand advanced ways to adapt your Kubernetes cluster to the needs of your work environment. weight: 90 --- diff --git a/content/en/docs/tasks/inject-data-application/_index.md b/content/en/docs/tasks/inject-data-application/_index.md index f7f765f259..af98de866d 100755 --- a/content/en/docs/tasks/inject-data-application/_index.md +++ b/content/en/docs/tasks/inject-data-application/_index.md @@ -1,5 +1,6 @@ --- title: "Inject Data Into Applications" +description: Specify configuration and other data for the Pods that run your workload. weight: 30 --- diff --git a/content/en/docs/tasks/job/_index.md b/content/en/docs/tasks/job/_index.md index 1948d33fc5..9e41e241c1 100644 --- a/content/en/docs/tasks/job/_index.md +++ b/content/en/docs/tasks/job/_index.md @@ -1,5 +1,6 @@ --- title: "Run Jobs" +description: Run Jobs using parallel processing. weight: 50 --- diff --git a/content/en/docs/tasks/manage-daemon/_index.md b/content/en/docs/tasks/manage-daemon/_index.md index 1cdbf06368..2b63e873ba 100755 --- a/content/en/docs/tasks/manage-daemon/_index.md +++ b/content/en/docs/tasks/manage-daemon/_index.md @@ -1,5 +1,6 @@ --- title: "Manage Cluster Daemons" +description: Perform common tasks for managing a DaemonSet, such as performing a rolling update. weight: 130 --- diff --git a/content/en/docs/tasks/manage-gpus/scheduling-gpus.md b/content/en/docs/tasks/manage-gpus/scheduling-gpus.md index dce3db810b..4f8fc434f9 100644 --- a/content/en/docs/tasks/manage-gpus/scheduling-gpus.md +++ b/content/en/docs/tasks/manage-gpus/scheduling-gpus.md @@ -3,6 +3,7 @@ reviewers: - vishh content_type: concept title: Schedule GPUs +description: Configure and schedule GPUs for use as a resource by nodes in a cluster. --- diff --git a/content/en/docs/tasks/manage-hugepages/scheduling-hugepages.md b/content/en/docs/tasks/manage-hugepages/scheduling-hugepages.md index b01ae06df2..7036710d13 100644 --- a/content/en/docs/tasks/manage-hugepages/scheduling-hugepages.md +++ b/content/en/docs/tasks/manage-hugepages/scheduling-hugepages.md @@ -3,16 +3,14 @@ reviewers: - derekwaynecarr title: Manage HugePages content_type: task +description: Configure and manage huge pages as a schedulable resource in a cluster. --- {{< feature-state state="stable" >}} Kubernetes supports the allocation and consumption of pre-allocated huge pages -by applications in a Pod as a **GA** feature. This page describes how users -can consume huge pages and the current limitations. - - +by applications in a Pod. This page describes how users can consume huge pages. ## {{% heading "prerequisites" %}} @@ -125,6 +123,3 @@ term_id="kube-apiserver" >}} (`--feature-gates=HugePageStorageMediumSize=true`). - NUMA locality guarantees as a feature of quality of service. - LimitRange support. - - - diff --git a/content/en/docs/tasks/manage-kubernetes-objects/_index.md b/content/en/docs/tasks/manage-kubernetes-objects/_index.md index b7bbecf75d..541ca58c0c 100644 --- a/content/en/docs/tasks/manage-kubernetes-objects/_index.md +++ b/content/en/docs/tasks/manage-kubernetes-objects/_index.md @@ -1,4 +1,5 @@ --- title: "Manage Kubernetes Objects" +description: Declarative and imperative paradigms for interacting with the Kubernetes API. weight: 25 --- \ No newline at end of file diff --git a/content/en/docs/tasks/network/_index.md b/content/en/docs/tasks/network/_index.md index 86dbbc1284..0dad8191a0 100755 --- a/content/en/docs/tasks/network/_index.md +++ b/content/en/docs/tasks/network/_index.md @@ -1,5 +1,6 @@ --- -title: "Network" +title: "Networking" +description: Learn how to configure networking for your cluster. weight: 160 --- diff --git a/content/en/docs/tasks/run-application/_index.md b/content/en/docs/tasks/run-application/_index.md index c9d64ac3fe..920df4098c 100755 --- a/content/en/docs/tasks/run-application/_index.md +++ b/content/en/docs/tasks/run-application/_index.md @@ -1,5 +1,6 @@ --- title: "Run Applications" +description: Run and manage both stateless and stateful applications. weight: 40 --- diff --git a/content/en/docs/tasks/service-catalog/_index.md b/content/en/docs/tasks/service-catalog/_index.md index 17bbaec3e9..77e5fa25e4 100755 --- a/content/en/docs/tasks/service-catalog/_index.md +++ b/content/en/docs/tasks/service-catalog/_index.md @@ -1,5 +1,6 @@ --- -title: "Install Service Catalog" +title: "Service Catalog" +description: Install the Service Catalog extension API. weight: 150 --- diff --git a/content/en/docs/tasks/tls/_index.md b/content/en/docs/tasks/tls/_index.md index 8607aa28d2..6fb6923847 100755 --- a/content/en/docs/tasks/tls/_index.md +++ b/content/en/docs/tasks/tls/_index.md @@ -1,5 +1,6 @@ --- title: "TLS" weight: 100 +description: Understand how to protect traffic within your cluster using Transport Layer Security (TLS). --- diff --git a/content/en/docs/tasks/tools/_index.md b/content/en/docs/tasks/tools/_index.md index 78a5ead6cd..cabf9a3c7b 100755 --- a/content/en/docs/tasks/tools/_index.md +++ b/content/en/docs/tasks/tools/_index.md @@ -1,5 +1,6 @@ --- title: "Install Tools" +description: Set up Kubernetes tools on your computer. weight: 10 ---