Switch to native kramdown in-page TOCs instead of proprietary

2016-02-17 18:32:18 -08:00
parent 15ca4aab1e
commit f249edaed0
68 changed files with 139 additions and 76 deletions
@@ -1,7 +1,8 @@
 ---
 title: "Kubernetes User Guide: Managing Applications"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 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](/{{page.version}}/docs/admin/README). The [Developer Guide](/{{page.version}}/docs/devel/README) is for anyone wanting to either write code which directly accesses the Kubernetes API, or to contribute directly to the Kubernetes project.

@@ -1,7 +1,8 @@
 ---
 title: "Accessing Clusters"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Accessing the cluster API

@@ -5,7 +5,8 @@ This guide is to help users debug applications that are deployed into Kubernetes
 This is *not* a guide for people who want to debug their cluster.  For that you should check out
 [this guide](../admin/cluster-troubleshooting)

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## FAQ

@@ -1,7 +1,8 @@
 ---
 title: "Compute Resources"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 When specifying a [pod](pods), you can optionally specify how much CPU and memory (RAM) each
 container needs.  When containers have their resource requests specified, the scheduler is
@@ -1,7 +1,8 @@
 ---
 title: "Kubernetes User Guide: Managing Applications: Configuring and launching containers"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Configuration in Kubernetes

@@ -1,7 +1,8 @@
 ---
 title: "Kubernetes User Guide: Managing Applications: Connecting applications"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 # The Kubernetes model for connecting containers

@@ -10,7 +10,8 @@ Another important part of the container environment is the file system that is a

 The following sections describe both the cluster information provided to containers, as well as the hooks and life-cycle that allows containers to interact with the management system.

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Cluster Information

@@ -1,7 +1,8 @@
 ---
 title: "Containers with Kubernetes"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Containers and commands

@@ -6,7 +6,8 @@ that `Services` are not working properly.  You've run all your `Pod`s and
 `ReplicationController`s, but you get no response when you try to access them.
 This document will hopefully help you to figure out what's going wrong.

-{% include pagetoc.html %}
+* TOC
+{:toc}


 ## Conventions
@@ -3,7 +3,8 @@ title: "Kubernetes User Guide: Managing Applications: Deploying continuously run
 ---
 You previously read about how to quickly deploy a simple replicated application using [`kubectl run`](quick-start) and how to configure and launch single-run containers using pods ([Configuring containers](configuring-containers)). Here you'll use the configuration-based approach to deploy a continuously running, replicated application.

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Launching a set of replicas using a configuration file

@@ -1,7 +1,8 @@
 ---
 title: "Deployments"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## What is a _Deployment_?

@@ -3,7 +3,8 @@ title: "kubectl for docker users"
 ---
 In this doc, we introduce the Kubernetes command line for interacting with the api to docker-cli users. The tool, kubectl, is designed to be familiar to docker-cli users but there are a few necessary differences. Each section of this doc highlights a docker subcommand explains the kubectl equivalent.

-{% include pagetoc.html %}
+* TOC
+{:toc}

 #### docker run

@@ -7,7 +7,8 @@ You create your Docker image and push it to a registry before referring to it in

 The `image` property of a container supports the same syntax as the `docker` command does, including private registries and tags.

-{% include pagetoc.html %}
+* TOC
+{:toc}


 ## Updating Images
@@ -1,7 +1,8 @@
 ---
 title: "Kubernetes User Guide: Managing Applications"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 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](/{{page.version}}/docs/admin/README). The [Developer Guide](/{{page.version}}/docs/devel/README) is for anyone wanting to either write code which directly accesses the Kubernetes API, or to contribute directly to the Kubernetes project.

@@ -1,7 +1,8 @@
 ---
 title: "Ingress"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 __Terminology__

@@ -5,7 +5,8 @@ Once your application is running, you'll inevitably need to debug problems with
 Earlier we described how you can use `kubectl get pods` to retrieve simple status information about
 your pods. But there are a number of ways to get even more information about your application.

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Using `kubectl describe pod` to fetch details about pods

@@ -1,7 +1,8 @@
 ---
 title: "Jobs"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## What is a _job_?

@@ -15,7 +15,8 @@ Each object can have a set of key/value labels defined.  Each Key must be unique

 We'll eventually index and reverse-index labels for efficient queries and watches, use them to sort and group in UIs and CLIs, etc. We don't want to pollute labels with non-identifying, especially large and/or structured, data. Non-identifying information should be recorded using [annotations](annotations).

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Motivation

@@ -3,7 +3,8 @@ title: "Kubernetes User Guide: Managing Applications: Managing deployments"
 ---
 You've deployed your application and exposed it via a service. Now what? Kubernetes provides a number of tools to help you manage your application deployment, including scaling and updating. Among the features we'll discuss in more depth are [configuration files](configuring-containers.html#configuration-in-kubernetes) and [labels](deploying-applications.html#labels).

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Organizing resource configurations

@@ -3,7 +3,8 @@ title: "Persistent Volumes and Claims"
 ---
 This document describes the current state of `PersistentVolumes` in Kubernetes.  Familiarity with [volumes](volumes) is suggested.

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Introduction

@@ -1,7 +1,8 @@
 ---
 title: "Pods"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 In Kubernetes, rather than individual application containers, _pods_ are the smallest deployable units that can be created, scheduled, and managed.

@@ -3,7 +3,8 @@ title: "Kubernetes User Guide: Managing Applications: Working with pods and cont
 ---
 You've seen [how to configure and deploy pods and containers](configuring-containers), using some of the most common configuration parameters. This section dives into additional features that are especially useful for running applications in production.

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Persistent storage

@@ -3,7 +3,8 @@ title: "Kubernetes User Guide: Managing Applications: Quick start"
 ---
 This guide will help you get oriented to Kubernetes and running your first containers on the cluster. If you are already familiar with the docker-cli, you can also checkout the docker-cli to kubectl migration guide [here](docker-cli-to-kubectl).

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Launching a simple application

@@ -1,7 +1,8 @@
 ---
 title: "Replication Controller"
 ---
-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## What is a _replication controller_?

@@ -74,7 +75,4 @@ For instance, a service might target all pods with `tier in (frontend), environm

 Replication controller is a top-level resource in the kubernetes REST API. More details about the
 API object can be found at: [ReplicationController API
-object](http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_replicationcontroller).
-
-
-
+object](http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_replicationcontroller).
@@ -6,7 +6,8 @@ passwords, OAuth tokens, and ssh keys.  Putting this information in a `secret`
 is safer and more flexible than putting it verbatim in a `pod` definition or in
 a docker image. See [Secrets design document](../design/secrets) for more information.

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Overview of Secrets

@@ -30,7 +30,8 @@ that is updated whenever the set of `Pods` in a `Service` changes.  For
 non-native applications, Kubernetes offers a virtual-IP-based bridge to Services
 which redirects to the backend `Pods`.

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Defining a service

@@ -10,7 +10,8 @@ Kubernetes `Volume` abstraction solves both of these problems.

 Familiarity with [pods](pods) is suggested.

-{% include pagetoc.html %}
+* TOC
+{:toc}


 ## Background
@@ -8,7 +8,8 @@ In order for the kubectl usage examples to work, make sure you have an examples



-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Kubectl CLI

@@ -5,7 +5,8 @@ For Kubernetes 101, we will cover kubectl, pods, volumes, and multiple container

 In order for the kubectl usage examples to work, make sure you have an examples directory locally, either from [a release](https://github.com/kubernetes/kubernetes/releases) or [the source](https://github.com/kubernetes/kubernetes).

-{% include pagetoc.html %}
+* TOC
+{:toc}


 ## Kubectl CLI
@@ -8,7 +8,8 @@ scaling.

 In order for the kubectl usage examples to work, make sure you have an examples directory locally, either from [a release](https://github.com/kubernetes/kubernetes/releases) or [the source](https://github.com/kubernetes/kubernetes).

-{% include pagetoc.html %}
+* TOC
+{:toc}

 ## Labels