From 4878956cb068d35871af5d2866f5da9c1c25c0f8 Mon Sep 17 00:00:00 2001 From: Martin Taillefer Date: Wed, 19 Apr 2017 11:15:48 -0700 Subject: [PATCH] More shuffling and cleanup. --- _includes/doc-side-concepts-nav.html | 2 +- _includes/doc-side-reference-nav.html | 2 +- docs/concepts/index.md | 17 +++++++++++++++++ docs/concepts/mixer.md | 2 +- docs/concepts/{model.md => service-model.md} | 0 docs/reference/contribute/index.md | 14 +++++++------- docs/reference/index.md | 19 +++++++++++++++++++ ...l.md => routing-and-traffic-management.md} | 2 +- docs/samples/index.md | 2 +- docs/tasks/index.md | 4 ++-- 10 files changed, 50 insertions(+), 14 deletions(-) rename docs/concepts/{model.md => service-model.md} (100%) rename docs/reference/{rule-dsl.md => routing-and-traffic-management.md} (99%) diff --git a/_includes/doc-side-concepts-nav.html b/_includes/doc-side-concepts-nav.html index b9bef6ae49..f659350169 100644 --- a/_includes/doc-side-concepts-nav.html +++ b/_includes/doc-side-concepts-nav.html @@ -2,7 +2,7 @@ {% assign current = page.url | downcase | split: '/' %}
  • Concepts
  • What is Istio?
    • -
  • Service Model
    • +
  • Service Model
  • Attributes
  • diff --git a/_includes/doc-side-reference-nav.html b/_includes/doc-side-reference-nav.html index 24b40e0528..fe70a0c404 100644 --- a/_includes/doc-side-reference-nav.html +++ b/_includes/doc-side-reference-nav.html @@ -2,7 +2,7 @@ {% assign current = page.url | downcase | split: '/' %}
  • Reference
  • The istioctl Command
    • -
  • Routing and Traffic Management
    • +
  • Routing and Traffic Management
  • Attribute Vocabulary
  • Glossary
  • Release Notes
    • diff --git a/docs/concepts/index.md b/docs/concepts/index.md index 9ebe01ef41..bb478bfd3a 100644 --- a/docs/concepts/index.md +++ b/docs/concepts/index.md @@ -11,3 +11,20 @@ type: markdown Concepts help you learn about the different parts of the Istio system and the abstractions it uses. + +- [What is Istio?](./what-is-istio.html). Provides a broad overview of what +problems Istio is designed to solve as well as presenting its high-level +architecture, + +- [Service Model](./service-model.html). Describes how services are modeled +within the Istio mesh. + +- [Attributes](./attributes.html). Explains the important notion of attributes, which +is a central mechanism for how policies and control are applied to services within the +mesh. + +- [Mixer](./mixer.html). Architectural deep-dive into the design of Mixer, which provides +the policy and control mechanisms within the service mesh. + +- [Mixer Configuration](./mixer-config.html). An overview of the key concepts used to configure +Mixer. diff --git a/docs/concepts/mixer.md b/docs/concepts/mixer.md index 01f96ac921..e779ca2257 100644 --- a/docs/concepts/mixer.md +++ b/docs/concepts/mixer.md @@ -184,7 +184,7 @@ subsequent phases. - **Attribute Processing**. The third phase takes the total set of attributes and produces a set of *adapter parameters*. Attribute processing is initially -configured through a simple declarative form as described [here]({{site.baseurl}}/docs/config.html). +configured through a simple declarative form as described [here]({{site.baseurl}}/docs/mixer-config.html). - **Adapter Dispatching**. The Resolution phase establishes the set of available aspects and the Attribute Processing phase creates a set of adapter parameters. The Adapter Dispatching phase invokes the adapters diff --git a/docs/concepts/model.md b/docs/concepts/service-model.md similarity index 100% rename from docs/concepts/model.md rename to docs/concepts/service-model.md diff --git a/docs/reference/contribute/index.md b/docs/reference/contribute/index.md index 0a09b7bf83..a3ef2b81ce 100644 --- a/docs/reference/contribute/index.md +++ b/docs/reference/contribute/index.md @@ -11,23 +11,23 @@ type: markdown This section teaches you how to contribute to the Istio documentation effort. -- [Editing Docs]({{site.baseurl}}/docs/home/contribute/editing.html). Lets you start editing this +- [Editing Docs](./editing.html). Lets you start editing this site's documentation. -- [Creating a Pull Request]({{site.baseurl}}/docs/home/contribute/creating-a-pull-request.html). Shows you +- [Creating a Pull Request](./creating-a-pull-request.html). Shows you how to create a GitHub pull request in order to submit your docs for approval. -- [Writing a New Topic]({{site.baseurl}}/docs/home/contribute/writing-a-new-topic.html). Explains the +- [Writing a New Topic](./writing-a-new-topic.html). Explains the mechanics of creating new documentation pages. -- [Staging Your Changes]({{site.baseurl}}/docs/home/contribute/staging-your-changes.html). Explains how +- [Staging Your Changes](./staging-your-changes.html). Explains how to test out your changes locally before submitting them. -- [Using Page Templates]({{site.baseurl}}/docs/home/contribute/using-page-templates.html). Presents +- [Using Page Templates](./using-page-templates.html). Presents the documentation templating model which is used to make Istio docs consistent. -- [Reviewing Doc Issues]({{site.baseurl}}/docs/home/contribute/reviewing-doc-issues.html). Explains +- [Reviewing Doc Issues](./reviewing-doc-issues.html). Explains the process involved in accepting documentation updates. -- [Style Guide]({{site.baseurl}}/docs/home/contribute/style-guide.html). Explains the dos and donts +- [Style Guide](./style-guide.html). Explains the dos and donts of writing Istio docs. diff --git a/docs/reference/index.md b/docs/reference/index.md index df6a242b96..e2c076b60e 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -12,3 +12,22 @@ type: markdown The Reference section contains detailed authoritative reference material such as command-line options, configuration options, and API calling parameters. + +- [istioctl](./istioctl.md). Describes the usage and option of the `istioctl` command-line +tool. + +- [Routing and Traffic Management](./routing-and-traffic-management.md). Describes how to +configure Istio's Layer 4 & 7 routing logic. + +- [Attribute Vocabulary](./attribute-vocabulary.md). Describes the base attribute +vocabulary used for policy and control. + +- [Glossary](./glossary.md). A glossary of common Istio term.s + +- [Release Notes](./release-notes.md). What's been happening with Istio. + +- [Roadmap](./release-roadmap.md). What Istio will become in the coming months. + +- [Writing Configuration](./writing-config.md). How to write Istio config YAML content. + +- [Contributing to the Docs](./contribute/index.md). See how you can help make these docs better. diff --git a/docs/reference/rule-dsl.md b/docs/reference/routing-and-traffic-management.md similarity index 99% rename from docs/reference/rule-dsl.md rename to docs/reference/routing-and-traffic-management.md index f9c0fe834f..8e94300ef5 100644 --- a/docs/reference/rule-dsl.md +++ b/docs/reference/routing-and-traffic-management.md @@ -12,7 +12,7 @@ sidenav: doc-side-reference-nav.html Istio provides a simple Domain-specific language (DSL) to control how API calls and layer-4 traffic flow across various microservices in the application deployment. The DSL is a -[YAML mapping](../concepts/writing-config.md) of a +[YAML mapping](../reference/writing-config.md) of a [protobuf](https://developers.google.com/protocol-buffers/docs/proto3) schema documented [here](https://github.com/istio/api/blob/master/proxy/v1/config/cfg.md). The DSL allows the operator to diff --git a/docs/samples/index.md b/docs/samples/index.md index f7f286ebc7..1c3438bd4d 100644 --- a/docs/samples/index.md +++ b/docs/samples/index.md @@ -11,5 +11,5 @@ type: markdown Samples include a variety of fully working example uses for Istio that you can experiment with. -- [BookInfo]({{site.baseurl}}/docs/samples/bookinfo.html). This sample deploys a simple app that displays information about a +- [BookInfo](./bookinfo.html). This sample deploys a simple app that displays information about a book, similar to a single catalog entry of an online book store. diff --git a/docs/tasks/index.md b/docs/tasks/index.md index 7bd65032dc..dc0222c7f2 100644 --- a/docs/tasks/index.md +++ b/docs/tasks/index.md @@ -11,7 +11,7 @@ type: markdown Tasks show you how to do a single specific targeted activity with the Istio system. -- [Getting Started]({{site.baseurl}}/docs/tasks/getting-started.html). This task shows you how to get +- [Getting Started](./getting-started.html). This task shows you how to get Istio setup. -- [Timeout Injection]({{site.baseurl}}/docs/tasks/timeout-injection.html). This task shows how to set a network timeout for all requests for a destination. +- [Timeout Injection](./timeout-injection.html). This task shows how to set a network timeout for all requests for a destination.