From 9520b96a6162d4af841da63227d2a8710596b975 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Wed, 12 Jul 2023 01:25:31 +0100 Subject: [PATCH] Revise docs home page Reorder and replace cards to better (I hope!) serve our readers. --- .../docs/concepts/cluster-administration/_index.md | 6 ++++++ content/en/docs/concepts/containers/_index.md | 3 +++ content/en/docs/concepts/overview/_index.md | 3 +++ content/en/docs/concepts/overview/components.md | 1 + content/en/docs/concepts/workloads/_index.md | 4 ++++ content/en/docs/concepts/workloads/pods/_index.md | 3 --- .../en/docs/contribute/style/page-content-types.md | 3 --- .../en/docs/contribute/suggesting-improvements.md | 5 ++++- content/en/docs/home/_index.md | 14 +++++++------- content/en/docs/reference/kubectl/_index.md | 1 + content/en/docs/reference/kubectl/cheatsheet.md | 4 ++-- content/en/docs/reference/kubernetes-api/_index.md | 4 ++++ .../reference/labels-annotations-taints/_index.md | 6 ++++++ .../docs/reference/setup-tools/kubeadm/_index.md | 5 +++-- .../tools/kubeadm/install-kubeadm.md | 2 +- .../configure-access-multiple-clusters.md | 3 ++- content/en/docs/tasks/debug/_index.md | 4 ++++ content/en/docs/tasks/tools/_index.md | 6 ++++++ .../en/docs/tasks/tools/install-kubectl-linux.md | 4 ---- .../en/docs/tasks/tools/install-kubectl-macos.md | 4 ---- .../en/docs/tasks/tools/install-kubectl-windows.md | 4 ---- 21 files changed, 57 insertions(+), 32 deletions(-) diff --git a/content/en/docs/concepts/cluster-administration/_index.md b/content/en/docs/concepts/cluster-administration/_index.md index d5d6a273e23af..2c7baf1d9871e 100644 --- a/content/en/docs/concepts/cluster-administration/_index.md +++ b/content/en/docs/concepts/cluster-administration/_index.md @@ -8,6 +8,12 @@ content_type: concept description: > Lower-level detail relevant to creating or administering a Kubernetes cluster. no_list: true +card: + name: setup + weight: 60 + anchors: + - anchor: "#securing-a-cluster" + title: Securing a cluster --- diff --git a/content/en/docs/concepts/containers/_index.md b/content/en/docs/concepts/containers/_index.md index 8c4316cd64741..bb98df7aca32a 100644 --- a/content/en/docs/concepts/containers/_index.md +++ b/content/en/docs/concepts/containers/_index.md @@ -6,6 +6,9 @@ reviewers: - erictune - thockin content_type: concept +card: + name: concepts + weight: 50 --- diff --git a/content/en/docs/concepts/overview/_index.md b/content/en/docs/concepts/overview/_index.md index f5952d39b7482..200b3e2ea337e 100644 --- a/content/en/docs/concepts/overview/_index.md +++ b/content/en/docs/concepts/overview/_index.md @@ -10,6 +10,9 @@ weight: 20 card: name: concepts weight: 10 + anchors: + - anchor: "#why-you-need-kubernetes-and-what-can-it-do" + title: Why Kubernetes? no_list: true --- diff --git a/content/en/docs/concepts/overview/components.md b/content/en/docs/concepts/overview/components.md index 2c422fcdaacc1..659592cc6cf4d 100644 --- a/content/en/docs/concepts/overview/components.md +++ b/content/en/docs/concepts/overview/components.md @@ -8,6 +8,7 @@ description: > plane and a set of machines called nodes. weight: 30 card: + title: Components of a cluster name: concepts weight: 20 --- diff --git a/content/en/docs/concepts/workloads/_index.md b/content/en/docs/concepts/workloads/_index.md index 8ae7df3fdb9ed..3fd2a86fc5ea0 100644 --- a/content/en/docs/concepts/workloads/_index.md +++ b/content/en/docs/concepts/workloads/_index.md @@ -4,6 +4,10 @@ weight: 55 description: > Understand Pods, the smallest deployable compute object in Kubernetes, and the higher-level abstractions that help you to run them. no_list: true +card: + title: Workloads and Pods + name: concepts + weight: 60 --- {{< glossary_definition term_id="workload" length="short" >}} diff --git a/content/en/docs/concepts/workloads/pods/_index.md b/content/en/docs/concepts/workloads/pods/_index.md index ba4b9d47fc01d..09daed5c25510 100644 --- a/content/en/docs/concepts/workloads/pods/_index.md +++ b/content/en/docs/concepts/workloads/pods/_index.md @@ -5,9 +5,6 @@ title: Pods content_type: concept weight: 10 no_list: true -card: - name: concepts - weight: 60 --- diff --git a/content/en/docs/contribute/style/page-content-types.md b/content/en/docs/contribute/style/page-content-types.md index bc44c655d1f72..ada2274d99747 100644 --- a/content/en/docs/contribute/style/page-content-types.md +++ b/content/en/docs/contribute/style/page-content-types.md @@ -2,9 +2,6 @@ title: Page content types content_type: concept weight: 80 -card: - name: contribute - weight: 30 --- diff --git a/content/en/docs/contribute/suggesting-improvements.md b/content/en/docs/contribute/suggesting-improvements.md index d79df11476419..aac6ce1c13519 100644 --- a/content/en/docs/contribute/suggesting-improvements.md +++ b/content/en/docs/contribute/suggesting-improvements.md @@ -4,7 +4,10 @@ content_type: concept weight: 10 card: name: contribute - weight: 20 + weight: 15 + anchors: + - anchor: "#opening-an-issue" + title: Suggest content improvements --- diff --git a/content/en/docs/home/_index.md b/content/en/docs/home/_index.md index a580c9aeadb09..c22ec2e8dced4 100644 --- a/content/en/docs/home/_index.md +++ b/content/en/docs/home/_index.md @@ -41,20 +41,20 @@ cards: description: "Look up common tasks and how to perform them using a short sequence of steps." button: "View Tasks" button_path: "/docs/tasks" -- name: training - title: "Training" - description: "Get certified in Kubernetes and make your cloud native projects successful!" - button: "View training" - button_path: "/training" - name: reference title: Look up reference information description: Browse terminology, command line syntax, API resource types, and setup tool documentation. button: View Reference button_path: /docs/reference +- name: training + title: "Training" + description: "Get certified in Kubernetes and make your cloud native projects successful!" + button: "View training" + button_path: "/training" - name: contribute - title: Contribute to the docs + title: Contribute to Kubernetes description: Anyone can contribute, whether you're new to the project or you've been around a long time. - button: Contribute to the docs + button: Find out how to help button_path: /docs/contribute - name: Download title: Download Kubernetes diff --git a/content/en/docs/reference/kubectl/_index.md b/content/en/docs/reference/kubectl/_index.md index 6d72bd0579cdf..6f71573ea0a49 100644 --- a/content/en/docs/reference/kubectl/_index.md +++ b/content/en/docs/reference/kubectl/_index.md @@ -5,6 +5,7 @@ weight: 110 no_list: true card: name: reference + title: kubectl command line tool weight: 20 --- diff --git a/content/en/docs/reference/kubectl/cheatsheet.md b/content/en/docs/reference/kubectl/cheatsheet.md index bbea74d46ad1e..c8bd0ec8f109e 100644 --- a/content/en/docs/reference/kubectl/cheatsheet.md +++ b/content/en/docs/reference/kubectl/cheatsheet.md @@ -7,8 +7,8 @@ reviewers: content_type: concept weight: 10 # highlight it card: - name: reference - weight: 30 + name: tasks + weight: 10 --- diff --git a/content/en/docs/reference/kubernetes-api/_index.md b/content/en/docs/reference/kubernetes-api/_index.md index 3fd611b1cfa6e..be3b46b9a4dc8 100644 --- a/content/en/docs/reference/kubernetes-api/_index.md +++ b/content/en/docs/reference/kubernetes-api/_index.md @@ -1,6 +1,10 @@ --- title: "Kubernetes API" weight: 50 +card: + title: Kubernetes API reference + name: reference + weight: 40 --- diff --git a/content/en/docs/reference/labels-annotations-taints/_index.md b/content/en/docs/reference/labels-annotations-taints/_index.md index b2c0ec9aec086..797fc601b9f42 100644 --- a/content/en/docs/reference/labels-annotations-taints/_index.md +++ b/content/en/docs/reference/labels-annotations-taints/_index.md @@ -3,6 +3,12 @@ title: Well-Known Labels, Annotations and Taints content_type: concept weight: 40 no_list: true +card: + name: reference + weight: 30 + anchors: + - anchor: "#labels-annotations-and-taints-used-on-api-objects" + title: Labels, annotations and taints --- diff --git a/content/en/docs/reference/setup-tools/kubeadm/_index.md b/content/en/docs/reference/setup-tools/kubeadm/_index.md index 00120e3d9d140..f19559f7c680d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/_index.md +++ b/content/en/docs/reference/setup-tools/kubeadm/_index.md @@ -4,8 +4,9 @@ weight: 10 no_list: true content_type: concept card: - name: reference - weight: 40 + title: kubeadm command reference + name: setup + weight: 80 --- Kubeadm is a tool built to provide `kubeadm init` and `kubeadm join` as best-practice "fast paths" for creating Kubernetes clusters. diff --git a/content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md b/content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md index 50f7f6557e882..98c004e38dd40 100644 --- a/content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md +++ b/content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md @@ -4,7 +4,7 @@ content_type: task weight: 10 card: name: setup - weight: 20 + weight: 40 title: Install the kubeadm setup tool --- diff --git a/content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md b/content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md index 2340278514922..cca5d49d6e83c 100644 --- a/content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md +++ b/content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md @@ -4,7 +4,8 @@ content_type: task weight: 30 card: name: tasks - weight: 40 + weight: 25 + title: Configure access to clusters --- diff --git a/content/en/docs/tasks/debug/_index.md b/content/en/docs/tasks/debug/_index.md index 1adde2a7c4c36..f5a643affe22f 100644 --- a/content/en/docs/tasks/debug/_index.md +++ b/content/en/docs/tasks/debug/_index.md @@ -7,6 +7,10 @@ reviewers: - davidopp content_type: concept no_list: true +card: + name: tasks + weight: 999 + title: Getting help --- diff --git a/content/en/docs/tasks/tools/_index.md b/content/en/docs/tasks/tools/_index.md index f928931c0103c..679b7a1e35016 100644 --- a/content/en/docs/tasks/tools/_index.md +++ b/content/en/docs/tasks/tools/_index.md @@ -3,6 +3,12 @@ title: "Install Tools" description: Set up Kubernetes tools on your computer. weight: 10 no_list: true +card: + name: tasks + weight: 20 + anchors: + - anchor: "#kubectl" + title: Install kubectl --- ## kubectl diff --git a/content/en/docs/tasks/tools/install-kubectl-linux.md b/content/en/docs/tasks/tools/install-kubectl-linux.md index 4c2e1deebf6fa..d6eeee14e5005 100644 --- a/content/en/docs/tasks/tools/install-kubectl-linux.md +++ b/content/en/docs/tasks/tools/install-kubectl-linux.md @@ -4,10 +4,6 @@ reviewers: title: Install and Set Up kubectl on Linux content_type: task weight: 10 -card: - name: tasks - weight: 20 - title: Install kubectl on Linux --- ## {{% heading "prerequisites" %}} diff --git a/content/en/docs/tasks/tools/install-kubectl-macos.md b/content/en/docs/tasks/tools/install-kubectl-macos.md index aa1071bbd1d27..4e37bbbb2913f 100644 --- a/content/en/docs/tasks/tools/install-kubectl-macos.md +++ b/content/en/docs/tasks/tools/install-kubectl-macos.md @@ -4,10 +4,6 @@ reviewers: title: Install and Set Up kubectl on macOS content_type: task weight: 10 -card: - name: tasks - weight: 20 - title: Install kubectl on macOS --- ## {{% heading "prerequisites" %}} diff --git a/content/en/docs/tasks/tools/install-kubectl-windows.md b/content/en/docs/tasks/tools/install-kubectl-windows.md index 8a1c65fcade16..ca18ff702665a 100644 --- a/content/en/docs/tasks/tools/install-kubectl-windows.md +++ b/content/en/docs/tasks/tools/install-kubectl-windows.md @@ -4,10 +4,6 @@ reviewers: title: Install and Set Up kubectl on Windows content_type: task weight: 10 -card: - name: tasks - weight: 20 - title: Install kubectl on Windows --- ## {{% heading "prerequisites" %}}