Make k8s.io/docs/home to support i18n (#12570)
* Make k8s.io/docs/home to support i18n * Apply kbhawkey's review comment
This commit is contained in:
June Yi
committed by
Kubernetes Prow Robot
Kubernetes Prow Robot
parent
22074f5848
commit
8e5d7e4829
@@ -4,6 +4,9 @@ reviewers:
|
||||
title: Kubernetes Components
|
||||
content_template: templates/concept
|
||||
weight: 20
|
||||
card:
|
||||
name: concepts
|
||||
weight: 20
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -4,6 +4,9 @@ reviewers:
|
||||
title: The Kubernetes API
|
||||
content_template: templates/concept
|
||||
weight: 30
|
||||
card:
|
||||
name: concepts
|
||||
weight: 30
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -5,6 +5,9 @@ reviewers:
|
||||
title: What is Kubernetes?
|
||||
content_template: templates/concept
|
||||
weight: 10
|
||||
card:
|
||||
name: concepts
|
||||
weight: 10
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -2,6 +2,9 @@
|
||||
title: Understanding Kubernetes Objects
|
||||
content_template: templates/concept
|
||||
weight: 10
|
||||
card:
|
||||
name: concepts
|
||||
weight: 40
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -4,6 +4,9 @@ reviewers:
|
||||
title: Pod Overview
|
||||
content_template: templates/concept
|
||||
weight: 10
|
||||
card:
|
||||
name: concepts
|
||||
weight: 60
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Intermediate contributing
|
||||
slug: intermediate
|
||||
content_template: templates/concept
|
||||
weight: 20
|
||||
card:
|
||||
name: contribute
|
||||
weight: 50
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -5,6 +5,10 @@ approvers:
|
||||
- chenopis
|
||||
- zacharysarah
|
||||
- zparnold
|
||||
card:
|
||||
name: contribute
|
||||
weight: 30
|
||||
title: Translating the docs
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
---
|
||||
title: Participating in SIG Docs
|
||||
content_template: templates/concept
|
||||
card:
|
||||
name: contribute
|
||||
weight: 40
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -3,6 +3,9 @@ title: Start contributing
|
||||
slug: start
|
||||
content_template: templates/concept
|
||||
weight: 10
|
||||
card:
|
||||
name: contribute
|
||||
weight: 10
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -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.
|
||||
---
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -7,5 +7,9 @@ layout: glossary
|
||||
noedit: true
|
||||
default_active_tag: fundamental
|
||||
weight: 5
|
||||
card:
|
||||
name: reference
|
||||
weight: 10
|
||||
title: Glossary
|
||||
---
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ reviewers:
|
||||
- krousey
|
||||
- clove
|
||||
content_template: templates/concept
|
||||
card:
|
||||
name: reference
|
||||
weight: 30
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -5,6 +5,9 @@ reviewers:
|
||||
title: Overview of kubectl
|
||||
content_template: templates/concept
|
||||
weight: 20
|
||||
card:
|
||||
name: reference
|
||||
weight: 20
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -7,6 +7,10 @@ reviewers:
|
||||
- jbeda
|
||||
content_template: templates/concept
|
||||
weight: 10
|
||||
card:
|
||||
name: reference
|
||||
weight: 50
|
||||
title: Overview of API
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -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/).
|
||||
|
||||
@@ -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 -->
|
||||
|
||||
|
||||
@@ -2,6 +2,9 @@
|
||||
title: Configure Access to Multiple Clusters
|
||||
content_template: templates/task
|
||||
weight: 30
|
||||
card:
|
||||
name: tasks
|
||||
weight: 40
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -2,6 +2,9 @@
|
||||
title: Install Minikube
|
||||
content_template: templates/task
|
||||
weight: 20
|
||||
card:
|
||||
name: tasks
|
||||
weight: 10
|
||||
---
|
||||
|
||||
{{% capture overview %}}
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -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 %}}
|
||||
|
||||
@@ -2,144 +2,48 @@
|
||||
{{ if not .Params.notitle }}
|
||||
<h1>{{ .Title }}</h1>
|
||||
{{ end }}
|
||||
{{ if eq .Lang "en" }}
|
||||
{{ template "docs-portal-cards" . }}
|
||||
{{ end }}
|
||||
{{ template "docs-portal-content" . }}
|
||||
{{ end }}
|
||||
|
||||
{{ define "content-id" }}content{{ end }}
|
||||
|
||||
{{ define "docs-portal-cards" }}
|
||||
<section id="mainContent">
|
||||
{{ define "docs-portal-content" }}
|
||||
<section id="mainContent">
|
||||
<div class="launch-content">
|
||||
|
||||
<p>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>).</p>
|
||||
|
||||
<p>{{ .Params.overview | safeHTML }}</p>
|
||||
<br>
|
||||
<div class="launch-cards">
|
||||
|
||||
<div class="launch-card">
|
||||
<h4>Understand the basics</h4>
|
||||
|
||||
<p>Learn about Kubernetes and its fundamental concepts.</p>
|
||||
<br>
|
||||
<ul>
|
||||
<li><a href="/docs/concepts/overview/what-is-kubernetes/">What is Kubernetes?</a></li>
|
||||
<li><a href="/docs/concepts/overview/components/">Kubernetes components</a></li>
|
||||
<li><a href="/docs/concepts/overview/kubernetes-api/">The Kubernetes API</a></li>
|
||||
<li><a href="/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes objects</a></li>
|
||||
<li><a href="/docs/concepts/workloads/pods/pod-overview/">Pod overview</a></li>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
|
||||
<button id="btn-concepts" class="button" onClick="location.href='/docs/concepts/';">Learn Concepts</button>
|
||||
</div>
|
||||
|
||||
<div class="launch-card">
|
||||
<h4>Try Kubernetes</h4>
|
||||
|
||||
<p>Follow tutorials to learn how to deploy applications in Kubernetes.</p>
|
||||
<br>
|
||||
<ul>
|
||||
<li><a href="/docs/tutorials/hello-minikube/">Hello Minikube</a></li>
|
||||
<li><a href="/docs/tutorials/kubernetes-basics/">Walkthrough the basics</a></li>
|
||||
<li><a href="/docs/tutorials/stateless-application/guestbook/">Stateless Example: PHP Guestbook with Redis</a></li>
|
||||
<li><a href="/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/">Stateful Example: Wordpress with Persistent Volumes</a></li>
|
||||
</ul>
|
||||
<br><br>
|
||||
<button id="btn-concepts" class="button" onClick="location.href='/docs/tutorials/';">View Tutorials</button>
|
||||
</div>
|
||||
|
||||
<div class="launch-card">
|
||||
<h4>Set up a cluster</h4>
|
||||
|
||||
<p>Get Kubernetes running based on your resources and needs.</p>
|
||||
<br>
|
||||
<ul>
|
||||
<li><a href="/docs/setup/pick-right-solution/#hosted-solutions">Hosted Solutions</a></li>
|
||||
<li><a href="/docs/setup/pick-right-solution/#turnkey-cloud-solutions">Turnkey Cloud Solutions</a></li>
|
||||
<li><a href="/docs/setup/pick-right-solution/#on-premises-turnkey-cloud-solutions">On-Premises Solutions</a></li>
|
||||
<li><a href="/docs/setup/pick-right-solution/#custom-solutions">Custom Solutions</a></li>
|
||||
<li><a href="/docs/setup/pick-right-solution/#local-machine-solutions">Local Machine</a></li>
|
||||
<li><a href="/docs/setup/independent/install-kubeadm/">Install the kubeadm setup tool</a></li>
|
||||
</ul>
|
||||
<br><br>
|
||||
<button id="btn-concepts" class="button" onClick="location.href='/docs/setup/';">Set up Kubernetes</button>
|
||||
</div>
|
||||
|
||||
<div class="launch-card">
|
||||
<h4>Learn how to use Kubernetes</h4>
|
||||
|
||||
<p>Look up common tasks and how to perform them using a short sequence of steps.</p>
|
||||
<br>
|
||||
<ul>
|
||||
<li><a href="/docs/tasks/tools/install-minikube/">Install Minikube</a></li>
|
||||
<li><a href="/docs/tasks/tools/install-kubectl/">Install kubectl</a></li>
|
||||
<li><a href="/docs/tasks/access-application-cluster/web-ui-dashboard/">Use the Web UI Dashboard</a></li>
|
||||
<li><a href="/docs/tasks/access-application-cluster/configure-access-multiple-clusters/">Configure access to multiple clusters</a></li>
|
||||
<li><a href="/docs/tasks/configure-pod-container/configure-pod-configmap/">Configure a Pod to use a ConfigMap</a></li>
|
||||
</ul>
|
||||
<br><br>
|
||||
<button id="btn-concepts" class="button" onClick="location.href='/docs/tasks/';">View Tasks</button>
|
||||
</div>
|
||||
|
||||
<div class="launch-card">
|
||||
<h4>Look up reference information</h4>
|
||||
|
||||
<p>Browse terminology, command line syntax, API resource types, and setup tool documentation.</p>
|
||||
<br>
|
||||
<ul>
|
||||
<li><a href="/docs/reference/glossary/?fundamental=true">Glossary</a></li>
|
||||
<li><a href="/docs/reference/kubectl/overview/">Overview of kubectl</a></li>
|
||||
<li><a href="/docs/reference/kubectl/cheatsheet/">kubectl cheat sheet</a></li>
|
||||
<li><a href="/docs/reference/setup-tools/kubeadm/kubeadm/">Overview of kubeadm</a></li>
|
||||
<li><a href="/docs/reference/using-api/api-overview/">Overview of API</a></li>
|
||||
</ul>
|
||||
<br><br>
|
||||
<button id="btn-concepts" class="button" onClick="location.href='/docs/reference/';">View Reference</button>
|
||||
</div>
|
||||
|
||||
<div class="launch-card">
|
||||
<h4>Contribute to the docs</h4>
|
||||
|
||||
<p>Anyone can contribute, whether you’re new to the project or you’ve been around a long time.</p>
|
||||
<br>
|
||||
<ul>
|
||||
<li><a href="/docs/contribute/start/">Start contributing</a></li>
|
||||
<li><a href="/docs/contribute/style/style-guide">Documentation style guide</a></li>
|
||||
<li><a href="/docs/contribute/localization/">Translating the docs</a></li>
|
||||
<li><a href="/docs/contribute/participating/">Participate in SIG Docs</a></li>
|
||||
<li><a href="/docs/contribute/intermediate/">Intermediate contributing</a></li>
|
||||
</ul>
|
||||
<br><br>
|
||||
<button id="btn-concepts" class="button" onClick="location.href='/docs/contribute/';">Contribute to the docs</button>
|
||||
</div>
|
||||
|
||||
<div class="launch-card">
|
||||
<h4>Download Kubernetes</h4>
|
||||
|
||||
<p>If you are installing Kubernetes or upgrading to the newest version, refer to the current release notes.</p>
|
||||
<br>
|
||||
<ul>
|
||||
<li><a href="/docs/setup/release/notes/">Current release notes</a></li>
|
||||
<li><a href="/docs/setup/release/notes/#urgent-upgrade-notes">Urgent upgrade notes</a></li>
|
||||
<li><a href="/docs/setup/release/building-from-source/">Build from source code</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="launch-card">
|
||||
<h4>About the documentation</h4>
|
||||
|
||||
<p>This website contains documentation for the current and previous 4 versions of Kubernetes.</p>
|
||||
<br>
|
||||
<ul>
|
||||
<li><a href="/docs/home/supported-doc-versions/">Supported versions of the documentation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
{{ template "docs-portal-card" . }}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{{ end }}
|
||||
|
||||
{{ define "docs-portal-card" }}
|
||||
{{ range .Params.cards }}
|
||||
<div class="launch-card">
|
||||
<h4>{{ .title }}</h4>
|
||||
<p>{{ .description }}</p>
|
||||
<br>
|
||||
<ul>
|
||||
{{ $name := .name }}
|
||||
{{ range where ($.Site.Pages.ByParam "card.weight") ".Params.card" "!=" nil }}
|
||||
{{ if eq .Params.card.name $name }}
|
||||
{{ $p := . }}
|
||||
{{ if (isset .Params.card "anchors") }}
|
||||
{{ range .Params.card.anchors }}
|
||||
<li><a href="{{ $p.Permalink }}{{ .anchor }}">{{ .title }}</a></li>
|
||||
{{ end }}
|
||||
{{ else }}
|
||||
<li><a href={{ .Permalink }}>
|
||||
{{ if (isset .Params.card "title") }}{{ .Params.card.title }}{{ else }}{{ .LinkTitle }}{{ end }}
|
||||
</a></li>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
</ul>
|
||||
<br><br>
|
||||
<button id="btn-concepts" class="button" onClick="location.href='{{ .button_path | relLangURL }}';">{{ .button }}</button>
|
||||
</div>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
Reference in New Issue
Block a user