Merge pull request #21752 from sftim/20200614_add_task_descriptions

Revise descriptions for tasks
2020-06-15 13:11:57 -07:00
parent b5645beee0 553279ca12
commit f6cd8d0af4
18 changed files with 20 additions and 74 deletions
@@ -5,7 +5,6 @@ weight: 50
 content_type: concept
 ---

-
 <!-- overview -->

 This section of the Kubernetes documentation contains pages that
@@ -13,71 +12,8 @@ show how to do individual tasks. A task page shows how to do a
 single thing, typically by giving a short sequence of steps.


-
-<!-- body -->
-
-## Web UI (Dashboard)
-
-Deploy and access the Dashboard web user interface to help you manage and monitor containerized applications in a Kubernetes cluster.
-
-## Using the kubectl Command-line
-
-Install and setup the `kubectl` command-line tool used to directly manage Kubernetes clusters.
-
-## Configuring Pods and Containers
-
-Perform common configuration tasks for Pods and Containers.
-
-## Running Applications
-
-Perform common application management tasks, such as rolling updates, injecting information into pods, and horizontal Pod autoscaling.
-
-## Running Jobs
-
-Run Jobs using parallel processing.
-
-## Accessing Applications in a Cluster
-
-Configure load balancing, port forwarding, or setup firewall or DNS configurations to access applications in a cluster.
-
-## Monitoring, Logging, and Debugging
-
-Setup monitoring and logging to troubleshoot a cluster or debug a containerized application.
-
-## Accessing the Kubernetes API
-
-Learn various methods to directly access the Kubernetes API.
-
-## Using TLS
-
-Configure your application to trust and use the cluster root Certificate Authority (CA).
-
-## Administering a Cluster
-
-Learn common tasks for administering a cluster.
-
-## Managing Stateful Applications
-
-Perform common tasks for managing Stateful applications, including scaling, deleting, and debugging StatefulSets.
-
-## Cluster Daemons
-
-Perform common tasks for managing a DaemonSet, such as performing a rolling update.
-
-## Managing GPUs
-
-Configure and schedule NVIDIA 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.
-
-
-
 ## {{% heading "whatsnext" %}}


 If you would like to write a task page, see
 [Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/).
-
-
@@ -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
 ---

@@ -1,5 +1,6 @@
 ---
 title: "Administer a Cluster"
+description: Learn common tasks for administering a cluster.
 weight: 20
 ---

@@ -1,5 +1,6 @@
 ---
 title: "Configure Pods and Containers"
+description: Perform common configuration tasks for Pods and containers.
 weight: 20
 ---

@@ -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
 ---

@@ -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
 ---

@@ -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
 ---

@@ -1,5 +1,6 @@
 ---
 title: "Inject Data Into Applications"
+description: Specify configuration and other data for the Pods that run your workload.
 weight: 30
 ---

@@ -1,5 +1,6 @@
 ---
 title: "Run Jobs"
+description: Run Jobs using parallel processing.
 weight: 50
 ---

@@ -1,5 +1,6 @@
 ---
 title: "Manage Cluster Daemons"
+description: Perform common tasks for managing a DaemonSet, such as performing a rolling update.
 weight: 130
 ---

@@ -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.
 ---

 <!-- overview -->
@@ -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.
 ---

 <!-- overview -->
 {{< 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.
-
-
-
@@ -1,4 +1,5 @@
 ---
 title: "Manage Kubernetes Objects"
+description: Declarative and imperative paradigms for interacting with the Kubernetes API.
 weight: 25
 ---
@@ -1,5 +1,6 @@
 ---
-title: "Network"
+title: "Networking"
+description: Learn how to configure networking for your cluster.
 weight: 160
 ---

@@ -1,5 +1,6 @@
 ---
 title: "Run Applications"
+description: Run and manage both stateless and stateful applications.
 weight: 40
 ---

@@ -1,5 +1,6 @@
 ---
-title: "Install Service Catalog"
+title: "Service Catalog"
+description: Install the Service Catalog extension API.
 weight: 150
 ---

@@ -1,5 +1,6 @@
 ---
 title: "TLS"
 weight: 100
+description: Understand how to protect traffic within your cluster using Transport Layer Security (TLS).
 ---

@@ -1,5 +1,6 @@
 ---
 title: "Install Tools"
+description: Set up Kubernetes tools on your computer.
 weight: 10
 ---