From 35a14cda34c5949320ba1d20e6a1b184e58d71e2 Mon Sep 17 00:00:00 2001 From: devin-donnelly Date: Thu, 3 Nov 2016 15:06:08 -0700 Subject: [PATCH] WIP: New Docs Landing Page and ToC Organization. (#1468) New Docs Landing Page and ToC Organization. --- _data/concepts.yml | 1 + _data/docs-home.yml | 5 ++ _data/globals.yml | 1 + _data/guides.yml | 4 +- _data/tasks.yml | 1 + _data/tools.yml | 1 + _data/tutorials.yml | 1 + _layouts/docwithnav.html | 11 ++- docs/index.md | 156 +++++++++------------------------------ docs/user-guide/index.md | 23 +++--- 10 files changed, 61 insertions(+), 143 deletions(-) create mode 100644 _data/docs-home.yml 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 @@
{{ site.data[foundTOC].abstract }}