Make k8s.io/docs/home to support i18n (#12570)

* Make k8s.io/docs/home to support i18n * Apply kbhawkey's review comment
kubernetes · Feb 21, 2019 · 8e5d7e4 · 8e5d7e4
1 parent 22074f5
commit 8e5d7e4
Show file tree

Hide file tree

Showing 31 changed files with 187 additions and 130 deletions.
diff --git a/content/en/docs/concepts/overview/components.md b/content/en/docs/concepts/overview/components.md
@@ -4,6 +4,9 @@ reviewers:
 title: Kubernetes Components
 content_template: templates/concept
 weight: 20
+card: 
+  name: concepts
+  weight: 20
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/concepts/overview/kubernetes-api.md b/content/en/docs/concepts/overview/kubernetes-api.md
@@ -4,6 +4,9 @@ reviewers:
 title: The Kubernetes API
 content_template: templates/concept
 weight: 30
+card: 
+  name: concepts
+  weight: 30
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/concepts/overview/what-is-kubernetes.md b/content/en/docs/concepts/overview/what-is-kubernetes.md
@@ -5,6 +5,9 @@ reviewers:
 title: What is Kubernetes?
 content_template: templates/concept
 weight: 10
+card: 
+  name: concepts
+  weight: 10
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/concepts/overview/working-with-objects/kubernetes-objects.md b/content/en/docs/concepts/overview/working-with-objects/kubernetes-objects.md
@@ -2,6 +2,9 @@
 title: Understanding Kubernetes Objects
 content_template: templates/concept
 weight: 10
+card: 
+  name: concepts
+  weight: 40
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/concepts/workloads/pods/pod-overview.md b/content/en/docs/concepts/workloads/pods/pod-overview.md
@@ -4,6 +4,9 @@ reviewers:
 title: Pod Overview
 content_template: templates/concept
 weight: 10
+card: 
+  name: concepts
+  weight: 60
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/contribute/intermediate.md b/content/en/docs/contribute/intermediate.md
@@ -3,6 +3,9 @@ title: Intermediate contributing
 slug: intermediate
 content_template: templates/concept
 weight: 20
+card:
+  name: contribute
+  weight: 50
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/contribute/localization.md b/content/en/docs/contribute/localization.md
@@ -5,6 +5,10 @@ approvers:
 - chenopis
 - zacharysarah
 - zparnold
+card:
+  name: contribute
+  weight: 30
+  title: Translating the docs
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/contribute/participating.md b/content/en/docs/contribute/participating.md
@@ -1,6 +1,9 @@
 ---
 title: Participating in SIG Docs
 content_template: templates/concept
+card:
+  name: contribute
+  weight: 40
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/contribute/start.md b/content/en/docs/contribute/start.md
@@ -3,6 +3,9 @@ title: Start contributing
 slug: start
 content_template: templates/concept
 weight: 10
+card:
+  name: contribute
+  weight: 10
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/contribute/style/style-guide.md b/content/en/docs/contribute/style/style-guide.md
@@ -3,6 +3,10 @@ title: Documentation Style Guide
 linktitle: Style guide
 content_template: templates/concept
 weight: 10
+card:
+  name: contribute
+  weight: 20
+  title: Documentation Style Guide
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/home/_index.md b/content/en/docs/home/_index.md
@@ -16,4 +16,43 @@ menu:
     weight: 20
     post: >
       <p>Learn how to use Kubernetes with conceptual, tutorial, and reference documentation. You can even <a href="/editdocs/" data-auto-burger-exclude>help contribute to the docs</a>!</p>
+overview: >
+  Kubernetes is an open source container orchestration engine for automating deployment, scaling, and management of containerized applications. The open source project is hosted by the Cloud Native Computing Foundation (<a href="https://www.cncf.io/about">CNCF</a>).
+cards:
+- name: concepts
+  title: "Understand the basics"
+  description: "Learn about Kubernetes and its fundamental concepts."
+  button: "Learn Concepts"
+  button_path: "/docs/concepts"
+- name: tutorials
+  title: "Try Kubernetes"
+  description: "Follow tutorials to learn how to deploy applications in Kubernetes."
+  button: "View Tutorials"
+  button_path: "/docs/tutorials"
+- name: setup
+  title: "Set up a cluster"
+  description: "Get Kubernetes running based on your resources and needs."
+  button: "Set up Kubernetes"
+  button_path: "/docs/setup"
+- name: tasks
+  title: "Learn how to use Kubernetes"
+  description: "Look up common tasks and how to perform them using a short sequence of steps."
+  button: "View Tasks"
+  button_path: "/docs/tasks"
+- 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: contribute
+  title: Contribute to the docs
+  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_path: /docs/contribute
+- name: download
+  title: Download Kubernetes
+  description: If you are installing Kubernetes or upgrading to the newest version, refer to the current release notes.
+- name: about
+  title: About the documentation
+  description: This website contains documentation for the current and previous 4 versions of Kubernetes.
 ---
diff --git a/content/en/docs/home/supported-doc-versions.md b/content/en/docs/home/supported-doc-versions.md
@@ -1,6 +1,10 @@
 ---
 title: Supported Versions of the Kubernetes Documentation
 content_template: templates/concept
+card:
+  name: about
+  weight: 10
+  title: Supported Versions of the Documentation
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/reference/glossary/index.md b/content/en/docs/reference/glossary/index.md
@@ -7,5 +7,9 @@ layout: glossary
 noedit: true
 default_active_tag: fundamental
 weight: 5
+card:
+  name: reference
+  weight: 10
+  title: Glossary
 ---
 
diff --git a/content/en/docs/reference/kubectl/cheatsheet.md b/content/en/docs/reference/kubectl/cheatsheet.md
@@ -6,6 +6,9 @@ reviewers:
 - krousey
 - clove
 content_template: templates/concept
+card:
+  name: reference
+  weight: 30
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/reference/kubectl/overview.md b/content/en/docs/reference/kubectl/overview.md
@@ -5,6 +5,9 @@ reviewers:
 title: Overview of kubectl
 content_template: templates/concept
 weight: 20
+card:
+  name: reference
+  weight: 20
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm.md
@@ -5,6 +5,9 @@ reviewers:
 - jbeda
 title: Overview of kubeadm
 weight: 10
+card:
+  name: reference
+  weight: 40
 ---
 <img src="https://raw.githubusercontent.com/cncf/artwork/master/kubernetes/certified-kubernetes/versionless/color/certified-kubernetes-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.
 

diff --git a/content/en/docs/reference/using-api/api-overview.md b/content/en/docs/reference/using-api/api-overview.md
@@ -7,6 +7,10 @@ reviewers:
 - jbeda
 content_template: templates/concept
 weight: 10
+card:
+  name: reference
+  weight: 50
+  title: Overview of API
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/setup/independent/install-kubeadm.md b/content/en/docs/setup/independent/install-kubeadm.md
@@ -2,6 +2,10 @@
 title: Installing kubeadm
 content_template: templates/task
 weight: 20
+card:
+  name: setup
+  weight: 20
+  title: Install the kubeadm setup tool
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/setup/pick-right-solution.md b/content/en/docs/setup/pick-right-solution.md
@@ -6,6 +6,20 @@ reviewers:
 title: Picking the Right Solution
 weight: 10
 content_template: templates/concept
+card:
+  name: setup
+  weight: 20
+  anchors:
+  - anchor: "#hosted-solutions"
+    title: Hosted Solutions
+  - anchor: "#turnkey-cloud-solutions"
+    title: Turnkey Cloud Solutions
+  - anchor: "#on-premises-turnkey-cloud-solutions"
+    title: On-Premises Solutions
+  - anchor: "#custom-solutions"
+    title: Custom Solutions
+  - anchor: "#local-machine-solutions"
+    title: Local Machine
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/setup/release/building-from-source.md b/content/en/docs/setup/release/building-from-source.md
@@ -3,7 +3,10 @@ reviewers:
 - david-mcmahon
 - jbeda
 title: Building a release
-content_template: templates/concept
+card:
+  name: download
+  weight: 20
+  title: Building a release
 ---
 {{% capture overview %}}
 You can either build a release from source or download a pre-built release.  If you do not plan on developing Kubernetes itself, we suggest using a pre-built version of the current release, which can be found in the [Release Notes](/docs/setup/release/notes/).

diff --git a/content/en/docs/setup/release/notes.md b/content/en/docs/setup/release/notes.md
@@ -1,5 +1,13 @@
 ---
 title: v1.13 Release Notes
+card:
+  name: download
+  weight: 10
+  anchors:
+  - anchor: "#"
+    title: Current Release Notes
+  - anchor: "#urgent-upgrade-notes"
+    title: Urgent Upgrade Notes
 ---
 <!-- NEW RELEASE NOTES ENTRY -->
 

diff --git a/.../en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md b/.../en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md
@@ -2,6 +2,9 @@
 title: Configure Access to Multiple Clusters
 content_template: templates/task
 weight: 30
+card:
+  name: tasks
+  weight: 40
 ---
 
 

diff --git a/content/en/docs/tasks/access-application-cluster/web-ui-dashboard.md b/content/en/docs/tasks/access-application-cluster/web-ui-dashboard.md
@@ -6,6 +6,10 @@ reviewers:
 title: Web UI (Dashboard)
 content_template: templates/concept
 weight: 10
+card:
+  name: tasks
+  weight: 30
+  title: Use the Web UI Dashboard
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md b/content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md
@@ -2,6 +2,9 @@
 title: Configure a Pod to Use a ConfigMap
 content_template: templates/task
 weight: 150
+card:
+  name: tasks
+  weight: 50
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/tasks/tools/install-kubectl.md b/content/en/docs/tasks/tools/install-kubectl.md
@@ -5,6 +5,10 @@ reviewers:
 title: Install and Set Up kubectl
 content_template: templates/task
 weight: 10
+card:
+  name: tasks
+  weight: 20
+  title: Install kubectl
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/tasks/tools/install-minikube.md b/content/en/docs/tasks/tools/install-minikube.md
@@ -2,6 +2,9 @@
 title: Install Minikube
 content_template: templates/task
 weight: 20
+card:
+  name: tasks
+  weight: 10
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/tutorials/hello-minikube.md b/content/en/docs/tutorials/hello-minikube.md
@@ -8,6 +8,9 @@ menu:
     weight: 10
     post: >
       <p>Ready to get your hands dirty? Build a simple Kubernetes cluster that runs "Hello World" for Node.js.</p>
+card: 
+  name: tutorials
+  weight: 10
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/tutorials/kubernetes-basics/_index.html b/content/en/docs/tutorials/kubernetes-basics/_index.html
@@ -2,6 +2,10 @@
 title: Learn Kubernetes Basics
 linkTitle: Learn Kubernetes Basics
 weight: 10
+card:
+  name: tutorials
+  weight: 20
+  title: Walkthrough the basics
 ---
 
 <!DOCTYPE html>

diff --git a/...ent/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md b/...ent/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md
@@ -4,6 +4,10 @@ reviewers:
 - ahmetb
 content_template: templates/tutorial
 weight: 20
+card: 
+  name: tutorials
+  weight: 40
+  title: "Stateful Example: Wordpress with Persistent Volumes"
 ---
 
 {{% capture overview %}}

diff --git a/content/en/docs/tutorials/stateless-application/guestbook.md b/content/en/docs/tutorials/stateless-application/guestbook.md
@@ -4,6 +4,10 @@ reviewers:
 - ahmetb
 content_template: templates/tutorial
 weight: 20
+card:
+  name: tutorials
+  weight: 30
+  title: "Stateless Example: PHP Guestbook with Redis"
 ---
 
 {{% capture overview %}}