From 5c0ddb2956d210394aecf7b2d5a53e2e60be8083 Mon Sep 17 00:00:00 2001 From: Martin Taillefer Date: Fri, 7 Apr 2017 10:18:26 -0700 Subject: [PATCH] Various content fixes. --- _includes/doc-side-tasks-nav.html | 1 + docs/concepts/index.md | 4 +++ docs/home/contribute/using-page-templates.md | 10 +++--- docs/index.md | 5 +-- docs/reference/index.md | 6 ++++ docs/samples/index.md | 5 +-- docs/tasks/getting-started.md | 37 ++++++++++++++++++++ docs/tasks/index.md | 6 ++-- docs/tutorials/index.md | 10 ++---- faq/index.html | 13 ++++--- 10 files changed, 73 insertions(+), 24 deletions(-) create mode 100644 docs/tasks/getting-started.md diff --git a/_includes/doc-side-tasks-nav.html b/_includes/doc-side-tasks-nav.html index d32446938b..9dac580359 100644 --- a/_includes/doc-side-tasks-nav.html +++ b/_includes/doc-side-tasks-nav.html @@ -1,4 +1,5 @@ diff --git a/docs/concepts/index.md b/docs/concepts/index.md index ca1bec5948..673880a39c 100644 --- a/docs/concepts/index.md +++ b/docs/concepts/index.md @@ -7,3 +7,7 @@ type: markdown sidenav: doc-side-concepts-nav.html --- +# Concepts + +The Concepts section helps you learn about the different parts +of the Istio system and the abstractions it uses. diff --git a/docs/home/contribute/using-page-templates.md b/docs/home/contribute/using-page-templates.md index 21f681c3d0..267aa8c294 100644 --- a/docs/home/contribute/using-page-templates.md +++ b/docs/home/contribute/using-page-templates.md @@ -7,12 +7,14 @@ layout: docs type: markdown --- +Individual topics are built using page templates which provide some consistent +formatting and style to all pages within Istio documentation. These page templates are available for writers who would like to contribute new topics to the Istio docs: -- [Concept](#concept_template) -- [Task](#task_tempplate) -- [Tutorial](#tutorial_template) -- [Sample](#sample-template) +- [Concept template](#concept-template) +- [Task template](#task-tempplate) +- [Tutorial template](#tutorial-template) +- [Sample template](#sample-template) The page templates are in the [_include/templates](https://github.com/istio/istio.github.io/tree/master/_includes/templates) directory of the [istio.github.io](https://github.com/istio/istio.github.io) repository. diff --git a/docs/index.md b/docs/index.md index 4dccf6ff8b..3d651e628b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,19 +6,16 @@ bodyclass: docs layout: docs type: markdown --- + Welcome to Istio's documentation home page. From here you can learn all about Istio by following the links below: - [Concepts]({{site.bareurl}}/docs/concepts). Concepts explain some significant aspect of Istio. This is where you can learn about what Istio does and how it does it. - - [Tasks]({{site.bareurl}}/docs/tasks). Tasks show you how to do a single directed activity with Istio. - - [Tutorials]({{site.bareurl}}/docs/tutorials). Tutorials are more involved, composing many individual tasks together to show you how to perform more complex activities. - - [Samples]({{site.bareurl}}/docs/samples). Samples are fully working stand-alone examples intended to highlight a particular set of Istio's features. - - [Reference]({{site.bareurl}}/docs/reference). Detailed exhaustive list of command-line options, configuration options, and API definitions. diff --git a/docs/reference/index.md b/docs/reference/index.md index 1e730bbd85..a54e95b7f7 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -6,3 +6,9 @@ title: Reference type: markdown sidenav: doc-side-reference-nav.html --- + +# Reference + +The Reference section contains detailed authoritative reference +material such as command-line options, configuration options, +and API calling parameters. diff --git a/docs/samples/index.md b/docs/samples/index.md index f8aa97ddb6..cd87a248b6 100644 --- a/docs/samples/index.md +++ b/docs/samples/index.md @@ -6,6 +6,7 @@ bodyclass: docs layout: docs type: markdown --- +# Samples -Take the walkthroughs in this section to get a high-level idea of Istio's features. The samples are currently targeted towards -Kubernetes users. We are working on adding support for other platforms. +The Samples section contains pages that present a variety of fully working +example uses for Istio that you can experiment with. diff --git a/docs/tasks/getting-started.md b/docs/tasks/getting-started.md new file mode 100644 index 0000000000..cbf07ead4c --- /dev/null +++ b/docs/tasks/getting-started.md @@ -0,0 +1,37 @@ +--- +title: Getting Started +headline: Getting Started with Istio +sidenav: doc-side-tasks-nav.html +bodyclass: docs +layout: docs +type: markdown +--- +{% capture overview %} +This page shows how to get started using Istio in a Kubernetes cluster. You'll learn +how to install Istio and get it initially configured and running. +{% endcapture %} + +{% capture prerequisites %} +* Do this. +* Do this too. +{% endcapture %} + +{% capture steps %} +## Doing ... + +1. Do this. +1. Do this next. Possibly read this [related explanation](...). +{% endcapture %} + +{% capture discussion %} +## Understanding ... + +Here's an interesting thing to know about the steps you just did. +{% endcapture %} + +{% capture whatsnext %} +* Learn more about [this](...). +* See this [related task](...). +{% endcapture %} + +{% include templates/task.md %} diff --git a/docs/tasks/index.md b/docs/tasks/index.md index 0b5084b026..4fae1e6e6b 100644 --- a/docs/tasks/index.md +++ b/docs/tasks/index.md @@ -2,9 +2,11 @@ title: Tasks headline: Tasks sidenav: doc-side-tasks-nav.html -Fbodyclass: docs +bodyclass: docs layout: docs type: markdown --- +# Tasks -TBD \ No newline at end of file +The Tasks section contains pages that each show how to do a single specific and reasonably targeted +activity with the Istio system. diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 0f949f9c9d..bf4a31771b 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -6,12 +6,8 @@ bodyclass: docs layout: docs type: markdown --- -

-Get started with Istio -

-
- -These pages show you how to get up and running as quickly as possible with Istio, -including installing all the tools you’ll need. +# Tutorials +The Tutorials section contains pages that show how to accomplish specific reasonably significant goals within Istio. +Typically a tutorial has several sections, each of which has a sequence of steps. diff --git a/faq/index.html b/faq/index.html index 9bf91b3d59..bf6962ca78 100644 --- a/faq/index.html +++ b/faq/index.html @@ -1,9 +1,9 @@ --- +title: FAQ +headline: 'Frequently Asked Questions' layout: default group: 'navigation' -title: FAQ bodyclass: faq -headline: 'Frequently Asked Questions' ---
@@ -49,20 +49,23 @@ headline: 'Frequently Asked Questions'
  • How can I contribute?
    -

    Contributors are highly welcome and the repositories are hosted on GitHub. We look forward to community feedback, additions and bugs. Both individual contributors and corporate contributors need to sign our CLA. If you have ideas for a project around gRPC, please read guidelines and submit here.

    +

    Contributors are highly welcome and the repositories are hosted on GitHub. + We look forward to community feedback, additions and bugs. + Please see our Contribution Guidelines + to learn how to contribute.

  • Where is the documentation?
    -

    Check out the documentation right here on istio.io.

    +

    Check out the documentation right here on istio.io.

  • What is the roadmap?
    -

    The roadmap is being tracked in GitHub milestones. Please refer to the respective milestones in the manager and mixer repositories under the GitHub Istio org.

    +

    See here for info on our release roadmap.