diff --git a/_data/concepts.yml b/_data/concepts.yml index a69276201e..f9422daa98 100644 --- a/_data/concepts.yml +++ b/_data/concepts.yml @@ -1,4 +1,5 @@ bigheader: "Concepts" +abstract: "Detailed explanations of Kubernetes system concepts and abstractions." toc: - title: Concepts path: /docs/concepts/ diff --git a/_data/docs-home.yml b/_data/docs-home.yml new file mode 100644 index 0000000000..1cb8c9b05a --- /dev/null +++ b/_data/docs-home.yml @@ -0,0 +1,5 @@ +bigheader: "Kubernetes Documentation" +abstract: "Documentation for using and learning about Kubernetes." +toc: +- title: Kubernetes Documentation + path: /docs/ diff --git a/_data/globals.yml b/_data/globals.yml index 73978ea750..2994e8b519 100644 --- a/_data/globals.yml +++ b/_data/globals.yml @@ -1,4 +1,5 @@ tocs: +- docs-home - guides - tutorials - tasks diff --git a/_data/guides.yml b/_data/guides.yml index e31411ea48..85c5dd4103 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -1,8 +1,8 @@ bigheader: "Guides" -abstract: "How to get started, and achieve tasks, using Kubernetes" +abstract: "How to get started, and accomplish tasks, using Kubernetes." toc: - title: Guides - path: /docs/ + path: /docs/user-guide/ - title: Getting Started section: diff --git a/_data/tasks.yml b/_data/tasks.yml index 38e1a89c68..4c6cd1b709 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -1,4 +1,5 @@ bigheader: "Tasks" +abstract: "Step-by-step instructions for performing operations with Kuberentes." toc: - title: Tasks path: /docs/tasks/ diff --git a/_data/tools.yml b/_data/tools.yml index 8993e091bb..cf2afca34c 100644 --- a/_data/tools.yml +++ b/_data/tools.yml @@ -1,4 +1,5 @@ bigheader: "Tools" +abstract: "Tools to help you use and enhance Kubernetes." toc: - title: Tools path: /docs/tools/ diff --git a/_data/tutorials.yml b/_data/tutorials.yml index 01440b09d7..ae9401c918 100644 --- a/_data/tutorials.yml +++ b/_data/tutorials.yml @@ -1,4 +1,5 @@ bigheader: "Tutorials" +abstract: "Detailed walkthroughs of common Kubernetes operations and workflows." toc: - title: Tutorials path: /docs/tutorials/ diff --git a/_layouts/docwithnav.html b/_layouts/docwithnav.html index c2f74c1bb4..877ccc4e63 100755 --- a/_layouts/docwithnav.html +++ b/_layouts/docwithnav.html @@ -11,13 +11,14 @@
Kubernetes is an open-source platform for automating deployment, scaling, and operations of application containers across clusters of hosts. Learn more about what this means for your app.
- Read the Overview -The Kubernetes Basics interactive tutorials let you try out Kubernetes features using Minikube right out of your web browser in a virtual terminal. Learn about the Kubernetes system and deploy, expose, scale, and upgrade a containerized application in just a few minutes.
- Try the Interactive Tutorials -This quickstart will show you how to install a secure Kubernetes cluster on any computers running Linux, using a tool called kubeadm
. It'll work with local VMs, physical servers and/or cloud servers, either manually or as a part of your own automation. It is currently in alpha but please try it out and give us feedback!
If you are looking for a fully automated solution, note that kubeadm is intended as a building block. Tools such as GKE and kops build on kubeadm to provision a complete cluster.
- Install Kubernetes with kubeadm -This quickstart will show you how to bring up a complete Kubernetes cluster on AWS, using a tool called kops
.
If you’ve completed one of the quickstarts, a great next step is Kubernetes 101. You will follow a path through the various features of Kubernetes, with code examples along the way, learning all of the core concepts. There's also a Kubernetes 201!
- Kubernetes 101 -The Kubernetes documentation can help you set up Kubernetes, learn about the system, or get your applications and workloads running on Kubernetes.
- + --
+
The docs for Kubernetes are open-source, just like the code for Kubernetes itself. The docs are on GitHub Pages, so you can fork it and it will auto-stage on username.github.io, previewing your changes!
- Write Docs for K8s -Try consulting our troubleshooting guides, or our FAQ. Kubernetes is also supported by a great community of contributors and experts who hang out in our Slack channel, our Google Group and Stack Overflow.
- Get Support -The Kubernetes Basics interactive tutorial lets you try out Kubernetes right out of your web browser, using a virtual terminal. Learn about the Kubernetes system and deploy, expose, scale, and upgrade a containerized application in just a few minutes.
+ +Picking the Right Solution can help you get a Kubernetes cluster up and running, either for local development, or on your cloud provider of choice.
+ +Other/newer ways to set up a Kubernetes cluster include:
+kops
.kubeadm
tool.The Kubernetes documentation contains a number of resources to help you understand and work with Kubernetes.
+The reference documentation provides complete information on the Kubernetes APIs and the kubectl
command-line interface.
The tools page contains a list of native and third-party tools for Kubernetes.
\ No newline at end of file diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md index 70bcb5be6d..027d9c879a 100644 --- a/docs/user-guide/index.md +++ b/docs/user-guide/index.md @@ -4,22 +4,15 @@ assignees: --- -* TOC -{:toc} +The Kubernetes **Guides** can help you work with various aspects of the Kubernetes system. +* The Kubernetes [User Guide](#user-guide-internal) can help you run programs and services on an existing Kubernetes cluster. +* The [Cluster Admin Guide](/docs/admin/) can help you set up and administrate your own Kubernetes cluster. +* The [Developer Guide](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel) can help you either write code to directly access the Kubernetes API, or to contribute directly to the Kubernetes project. -The user guide is intended for anyone who wants to run programs and services on an existing Kubernetes cluster. Setup and administration of a Kubernetes cluster is described in the [Cluster Admin Guide](/docs/admin/). The [Developer Guide](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel) is for anyone wanting to either write code which directly accesses the Kubernetes API, or to contribute directly to the Kubernetes project. +## Kuberentes User Guide -Please ensure you have completed the [prerequisites for running examples from the user guide](/docs/user-guide/prereqs/). - -## Quick walkthrough - -1. [Kubernetes 101](/docs/user-guide/walkthrough/) -1. [Kubernetes 201](/docs/user-guide/walkthrough/k8s201/) - -## Thorough walkthrough - -If you don't have any familiarity with Kubernetes, we recommend you read the following sections in order: +The following topics in the Kubernets User Guide can help you run applications and services on a Kubernetes cluster: 1. [Quick start: launch and expose an application](/docs/user-guide/quick-start/) 1. [Configuring and launching containers: configuring common container parameters](/docs/user-guide/configuring-containers/) @@ -35,7 +28,9 @@ If you don't have any familiarity with Kubernetes, we recommend you read the fol 1. [Connecting to containers via proxies](/docs/user-guide/connecting-to-applications-proxy/) 1. [Connecting to containers via port forwarding](/docs/user-guide/connecting-to-applications-port-forward/) -## Concept guide +Before running examples in the user guides, please ensure you have completed the [prerequisites](/docs/user-guide/prereqs/). + +## Kubernetes Concepts [**Cluster**](/docs/admin/) : A cluster is a set of physical or virtual machines and other infrastructure resources used by Kubernetes to run your applications.