Skip to content

Commit

Permalink
Revise docs home page
Browse files Browse the repository at this point in the history
Reorder and replace cards to better (I hope!) serve our readers.
  • Loading branch information
sftim committed Aug 9, 2023
1 parent 8ed514a commit 9520b96
Show file tree
Hide file tree
Showing 21 changed files with 57 additions and 32 deletions.
6 changes: 6 additions & 0 deletions content/en/docs/concepts/cluster-administration/_index.md
Expand Up @@ -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
---

<!-- overview -->
Expand Down
3 changes: 3 additions & 0 deletions content/en/docs/concepts/containers/_index.md
Expand Up @@ -6,6 +6,9 @@ reviewers:
- erictune
- thockin
content_type: concept
card:
name: concepts
weight: 50
---

<!-- overview -->
Expand Down
3 changes: 3 additions & 0 deletions content/en/docs/concepts/overview/_index.md
Expand Up @@ -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
---

Expand Down
1 change: 1 addition & 0 deletions content/en/docs/concepts/overview/components.md
Expand Up @@ -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
---
Expand Down
4 changes: 4 additions & 0 deletions content/en/docs/concepts/workloads/_index.md
Expand Up @@ -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" >}}
Expand Down
3 changes: 0 additions & 3 deletions content/en/docs/concepts/workloads/pods/_index.md
Expand Up @@ -5,9 +5,6 @@ title: Pods
content_type: concept
weight: 10
no_list: true
card:
name: concepts
weight: 60
---

<!-- overview -->
Expand Down
3 changes: 0 additions & 3 deletions content/en/docs/contribute/style/page-content-types.md
Expand Up @@ -2,9 +2,6 @@
title: Page content types
content_type: concept
weight: 80
card:
name: contribute
weight: 30
---

<!-- overview -->
Expand Down
5 changes: 4 additions & 1 deletion content/en/docs/contribute/suggesting-improvements.md
Expand Up @@ -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
---

<!-- overview -->
Expand Down
14 changes: 7 additions & 7 deletions content/en/docs/home/_index.md
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions content/en/docs/reference/kubectl/_index.md
Expand Up @@ -5,6 +5,7 @@ weight: 110
no_list: true
card:
name: reference
title: kubectl command line tool
weight: 20
---

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/reference/kubectl/cheatsheet.md
Expand Up @@ -7,8 +7,8 @@ reviewers:
content_type: concept
weight: 10 # highlight it
card:
name: reference
weight: 30
name: tasks
weight: 10
---

<!-- overview -->
Expand Down
4 changes: 4 additions & 0 deletions 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
---

<!-- overview -->
Expand Down
6 changes: 6 additions & 0 deletions content/en/docs/reference/labels-annotations-taints/_index.md
Expand Up @@ -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
---

<!-- overview -->
Expand Down
5 changes: 3 additions & 2 deletions content/en/docs/reference/setup-tools/kubeadm/_index.md
Expand Up @@ -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
---

<img src="/images/kubeadm-stacked-color.png" align="right" width="150px">Kubeadm is a tool built to provide `kubeadm init` and `kubeadm join` as best-practice "fast paths" for creating Kubernetes clusters.
Expand Down
Expand Up @@ -4,7 +4,7 @@ content_type: task
weight: 10
card:
name: setup
weight: 20
weight: 40
title: Install the kubeadm setup tool
---

Expand Down
Expand Up @@ -4,7 +4,8 @@ content_type: task
weight: 30
card:
name: tasks
weight: 40
weight: 25
title: Configure access to clusters
---

<!-- overview -->
Expand Down
4 changes: 4 additions & 0 deletions content/en/docs/tasks/debug/_index.md
Expand Up @@ -7,6 +7,10 @@ reviewers:
- davidopp
content_type: concept
no_list: true
card:
name: tasks
weight: 999
title: Getting help
---

<!-- overview -->
Expand Down
6 changes: 6 additions & 0 deletions content/en/docs/tasks/tools/_index.md
Expand Up @@ -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
Expand Down
4 changes: 0 additions & 4 deletions content/en/docs/tasks/tools/install-kubectl-linux.md
Expand Up @@ -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" %}}
Expand Down
4 changes: 0 additions & 4 deletions content/en/docs/tasks/tools/install-kubectl-macos.md
Expand Up @@ -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" %}}
Expand Down
4 changes: 0 additions & 4 deletions content/en/docs/tasks/tools/install-kubectl-windows.md
Expand Up @@ -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" %}}
Expand Down

0 comments on commit 9520b96

Please sign in to comment.