Elimintate the need for the bodyclass: front matter field in docs.

This commit is contained in:
Martin Taillefer 2017-04-30 06:41:17 -07:00
parent 984dc7f8fc
commit e0b9750ee4
86 changed files with 17 additions and 102 deletions

View File

@ -5,7 +5,6 @@ overview: My overview
order: 42 order: 42
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ index: true
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown

View File

@ -4,7 +4,6 @@ overview: Introduces core network and authentication functionality.
order: 30 order: 30
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Explains the important notion of attributes, which is a central mechan
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Introduces the policy control mechanisms.
order: 40 order: 40
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: An overview of the key concepts used to configure Mixer.
order: 30 order: 30
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Architectural deep-dive into the design of Mixer, which provides the p
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,11 +4,9 @@ overview: Introduces the idea of systematic fault injection that can be used to
order: 40 order: 40
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---
While Envoy sidecar/proxy provides a host of While Envoy sidecar/proxy provides a host of
[failure recovery mechanisms](./handling-failures.html) to services running [failure recovery mechanisms](./handling-failures.html) to services running

View File

@ -4,7 +4,6 @@ overview: An overview of failure recovery capabilities in Envoy that can be leve
order: 30 order: 30
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Describes the various Istio features focused on traffic routing and co
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Describes how traffic is load balanced across instances of a service i
order: 25 order: 25
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Introduces the Istio-Manager, the component responsible for managing a
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Provides a conceptual overview of traffic management principles in Ist
order: 0 order: 0
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Describes how services are modeled within the Istio mesh, the notion o
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Provides a high-level overview of the domain-specific language used by
order: 50 order: 50
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Highlights Istio's core architectural structure and components.
order: 30 order: 30
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Describes the core principles that Istio's design adheres to.
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: A broad overview of the Istio system.
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Provides a broad overview of what problems Istio is designed to solve.
order: 15 order: 15
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -1,10 +1,10 @@
--- ---
title: Welcome title: Welcome
overview: Istio documentation home page.
index: true index: true
order: 0 order: 0
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Detailed information on API parameters and configuration options.
order: 21 order: 21
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Generated documentation for Mixer's Configuration Schema
order: 40 order: 40
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Generated documentation for Mixer's API Surface
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Generated documentation for the Istio Proxy's Configuration Schema
order: 60 order: 60
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Describes the base attribute vocabulary used for policy and control.
order: 30 order: 30
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Shows you how to create a GitHub pull request in order to submit your
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Lets you start editing this site's documentation.
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Learn how to contribute to improve and expand the Istio documentation.
order: 100 order: 100
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Explains the process involved in accepting documentation updates.
order: 60 order: 60
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Explains how to test your changes locally before submitting them.
order: 40 order: 40
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Explains the dos and donts of writing Istio docs.
order: 70 order: 70
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Explains the mechanics of creating new documentation pages.
order: 30 order: 30
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---
@ -91,7 +90,6 @@ chunk of front matter you should start with:
order: ORDER_TBD order: ORDER_TBD
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---
@ -102,9 +100,11 @@ matter fields are:
|Field | Description |Field | Description
|-----------|------------ |-----------|------------
|`index` | indicates whether the page should appear in the doc's top nav tabs |`title` | The short title of the page
|`order` | integer used for sort order
|`overview` | a one-line description of what the topic is about |`overview` | a one-line description of what the topic is about
|`order` | integer used for sort order
|`layout' | indicates which of the Jekyll layouts this page uses
|`index` | indicates whether the page should appear in the doc's top nav tabs
## Choosing a directory ## Choosing a directory

View File

@ -4,7 +4,6 @@ overview: A glossary of common Istio terms.
order: 40 order: 40
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ index: true
order: 40 order: 40
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: The Istioctl Command title: The Istioctl Command
overview: Options showing how to use the istioctl command. overview: Options showing how to use the istioctl command.
order: 0 order: 0
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl title: istioctl
overview: Istio control interface overview: Istio control interface
order: 6 order: 6
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl completion title: istioctl completion
overview: Generate bash completion for Istioctl overview: Generate bash completion for Istioctl
order: 1 order: 1
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl create title: istioctl create
overview: Create policies and rules overview: Create policies and rules
order: 2 order: 2
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl delete title: istioctl delete
overview: Delete policies or rules overview: Delete policies or rules
order: 3 order: 3
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl get title: istioctl get
overview: Retrieve policies and rules overview: Retrieve policies and rules
order: 4 order: 4
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl kube-inject title: istioctl kube-inject
overview: Inject Envoy sidecar into Kubernetes pod resources overview: Inject Envoy sidecar into Kubernetes pod resources
order: 5 order: 5
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl mixer title: istioctl mixer
overview: Istio Mixer configuration overview: Istio Mixer configuration
order: 7 order: 7
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl mixer rule title: istioctl mixer rule
overview: Istio Mixer Rule configuration overview: Istio Mixer Rule configuration
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl mixer rule create title: istioctl mixer rule create
overview: Create Istio Mixer rules overview: Create Istio Mixer rules
order: 8 order: 8
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl mixer rule get title: istioctl mixer rule get
overview: Get Istio Mixer rules overview: Get Istio Mixer rules
order: 9 order: 9
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl replace title: istioctl replace
overview: Replace existing policies and rules overview: Replace existing policies and rules
order: 11 order: 11
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -2,7 +2,6 @@
title: istioctl version title: istioctl version
overview: Display version information and exit overview: Display version information and exit
order: 12 order: 12
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ overview: My overview
order: 42 order: 42
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: What's been happening with Istio.
order: 50 order: 50
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: What Istio will become in the coming months.
order: 60 order: 60
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: Describes how to configure Istio's Layer 4 & 7 routing logic.
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: How to write Istio config YAML content.
order: 70 order: 70
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This sample deploys a simple application composed of four separate mic
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ index: true
order: 30 order: 30
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ overview: My overview
order: 42 order: 42
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -1,7 +1,6 @@
--- ---
title: Search Results title: Search Results
layout: search-results layout: search-results
bodyclass: search-results
--- ---
<script> <script>
(function() { (function() {

View File

@ -4,7 +4,6 @@ overview: This task shows you how to configure Mixer.
order: 110 order: 110
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -1,11 +1,9 @@
--- ---
title: Accessing a Service with Egress Envoy title: Accessing a Service with Egress Envoy
headline: Accessing a Service with Egress Envoy
overview: Describes how to configure Istio to expose an external service to a Kubernetes cluster. overview: Describes how to configure Istio to expose an external service to a Kubernetes cluster.
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows how to inject delays and test the resiliency of your a
order: 60 order: 60
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ index: true
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows you how to setup Envoy as the Kubernetes ingress contr
order: 30 order: 30
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows you how to setup the Istio service mesh.
order: 10 order: 10
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows you how to integrate your applications with the Istio
order: 20 order: 20
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows you how to setup Istio-Auth to provide mutual TLS auth
order: 70 order: 70
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows you how to configure Mixer to collect metrics and logs
order: 80 order: 80
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows you how to use Istio to dynamically limit the traffic
order: 40 order: 40
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows you how to configure dynamic request routing based on
order: 50 order: 50
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,7 +4,6 @@ overview: This task shows you how to setup request timeouts in Envoy using Istio
order: 40 order: 40
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ overview: My overview
order: 42 order: 42
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ overview: Tutorials shows you how to accomplish specific reasonably significant
order: 6 order: 6
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -5,7 +5,6 @@ overview: My overview
order: 42 order: 42
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -1,7 +1,5 @@
--- ---
title: about
layout: default layout: default
bodyclass: about
--- ---
<div class="container"> <div class="container">
<div class="row"> <div class="row">

View File

@ -1,5 +1,5 @@
--- ---
#layout: compress layout: compress
--- ---
{% assign home = "" %} {% assign home = "" %}
{% if site.github.environment == "dotcom" %} {% if site.github.environment == "dotcom" %}
@ -57,7 +57,12 @@
<![endif]--> <![endif]-->
</head> </head>
<body class={{page.bodyclass}}> {% if page.bodyclass == nil %}
<body class="{{page.layout}}">
{% else %}
<body class="{{page.bodyclass}}">
{% endif %}
<script src="{{home}}/js/navtree.js"></script> <script src="{{home}}/js/navtree.js"></script>
{{ content }} {{ content }}

View File

@ -1,7 +1,5 @@
--- ---
title: blog
layout: default layout: default
bodyclass: blog
--- ---
{% assign home = "" %} {% assign home = "" %}
{% if site.github.environment == "dotcom" %} {% if site.github.environment == "dotcom" %}

View File

@ -1,7 +1,5 @@
--- ---
title: community
layout: default layout: default
bodyclass: community
--- ---
<div class="container"> <div class="container">
<div class="row"> <div class="row">

View File

@ -1,7 +1,5 @@
--- ---
title: docs
layout: default layout: default
bodyclass: docs
--- ---
{% assign home = "" %} {% assign home = "" %}

View File

@ -1,7 +1,5 @@
--- ---
title: faq
layout: default layout: default
bodyclass: faq
--- ---
<div class="container"> <div class="container">
<div class="row"> <div class="row">

View File

@ -1,6 +1,5 @@
--- ---
layout: base layout: base
bodyclass: post
--- ---
{% include sticky-nav.html %} {% include sticky-nav.html %}

View File

@ -1,5 +1,4 @@
--- ---
title: Search Results
layout: default layout: default
--- ---

View File

@ -1,9 +1,9 @@
--- ---
layout: post
title: Istio releases Alpha, peeking under the hood. title: Istio releases Alpha, peeking under the hood.
published: true published: true
permalink: blog/alpha_release permalink: blog/alpha_release
attribution: Santa Claus, Istio Team attribution: Santa Claus, Istio Team
layout: post
--- ---
<p> <p>

View File

@ -1,10 +1,9 @@
--- ---
title: About title: About
index: true overview: About Istio.
order: 0 order: 0
bodyclass: about
layout: about layout: about
type: markdown type: markdown
--- ---

View File

@ -1,7 +1,7 @@
--- ---
title: Blog title: Blog
overview: The Istio blog.
layout: blog layout: blog
bodyclass: blog
--- ---
{% for post in paginator.posts %} {% for post in paginator.posts %}
<a href="{{home}}{{ post.url }}"><h4 id="{{post.id}}" class="post-title">{{ post.title }}</h4></a> <a href="{{home}}{{ post.url }}"><h4 id="{{post.id}}" class="post-title">{{ post.title }}</h4></a>

View File

@ -1,7 +1,7 @@
--- ---
title: Community title: Community
overview: Information on the various ways to participate and interact with the Istio community.
layout: community layout: community
bodyclass: community
--- ---
<section class="lead"> <section class="lead">

View File

@ -1,8 +1,7 @@
--- ---
title: FAQ title: FAQ
overview: Frequently Asked Questions about Istio.
layout: faq layout: faq
bodyclass: faq
type: markdown type: markdown
--- ---

View File

@ -17,7 +17,6 @@ function commandHeader() {
title: ${title} title: ${title}
overview: ${overview} overview: ${overview}
order: ${order} order: ${order}
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---
@ -31,7 +30,6 @@ function generateIndex() {
title: The Istioctl Command title: The Istioctl Command
overview: Options showing how to use the istioctl command. overview: Options showing how to use the istioctl command.
order: ${order} order: ${order}
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---

View File

@ -4,13 +4,10 @@ overview: Discusses injecting timeouts.
order: 65 order: 65
bodyclass: docs
layout: docs layout: docs
type: markdown type: markdown
--- ---
![Timeout Injection](../../img/timeout-injection.svg) ![Timeout Injection](../../img/timeout-injection.svg)
Slow or unresponsive microservices can reveal defects in other system components. Unhandled timeout Slow or unresponsive microservices can reveal defects in other system components. Unhandled timeout