Skip to content
This repository has been archived by the owner on Dec 21, 2019. It is now read-only.

Commit

Permalink
docs: Add tables of content to all documentation files
Browse files Browse the repository at this point in the history
  • Loading branch information
tazjin committed Aug 4, 2017
1 parent 4adc8f2 commit d7569ab
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 1 deletion.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,22 @@ In my experience this is often enough and more complex solutions such as

Check out a Kontemplate setup example and the feature list below!

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**

- [Kontemplate - A simple Kubernetes templater](#kontemplate---a-simple-kubernetes-templater)
- [Features](#features)
- [Example](#example)
- [Installation](#installation)
- [Homebrew](#homebrew)
- [Arch Linux](#arch-linux)
- [Building repeatably from source](#building-repeatably-from-source)
- [Building from source](#building-from-source)
- [Usage](#usage)
- [Contributing](#contributing)

<!-- markdown-toc end -->

## Features

* [Simple, yet powerful templates](docs/templates.md)
Expand Down
13 changes: 13 additions & 0 deletions docs/cluster-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,19 @@ include:
- name: pub-service
```
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**
- [Cluster configuration](#cluster-configuration)
- [Fields](#fields)
- [`context`](#context)
- [`global`](#global)
- [`import`](#import)
- [`include`](#include)
- [External variables](#external-variables)

<!-- markdown-toc end -->

## Fields

This is documentation for the individual fields in a cluster context file.
Expand Down
17 changes: 17 additions & 0 deletions docs/resource-sets.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@ Resource sets are collections of Kubernetes resources that should be passed to `

Technically a resource set is simply a folder with a few YAML and/or JSON templates in it.

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**

- [Resource Sets](#resource-sets)
- [Creating resource sets](#creating-resource-sets)
- [Default variables](#default-variables)
- [Including resource sets](#including-resource-sets)
- [Fields](#fields)
- [`name`](#name)
- [`path`](#path)
- [`values`](#values)
- [`include`](#include)
- [Multiple includes](#multiple-includes)
- [Nesting resource sets](#nesting-resource-sets)
- [Caveats](#caveats)

<!-- markdown-toc end -->

# Creating resource sets

Expand Down
13 changes: 13 additions & 0 deletions docs/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,19 @@ or in which conditionals are evaluated for more complex template logic.
It is recommended that you check out the Golang [documentation][] for the templating
engine in addition to the cherry-picked features listed here.

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**

- [Kontemplate templates](#kontemplate-templates)
- [Basic variable interpolation](#basic-variable-interpolation)
- [Example:](#example)
- [Template functions](#template-functions)
- [Examples:](#examples)
- [Conditionals & ranges](#conditionals--ranges)
- [Caveats](#caveats)

<!-- markdown-toc end -->

## Basic variable interpolation

The basic template format uses `{{ .variableName }}` as the interpolation format.
Expand Down
10 changes: 9 additions & 1 deletion docs/tips-and-tricks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Kontemplate tips & tricks
=========================

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**

- [Kontemplate tips & tricks](#kontemplate-tips--tricks)
- [Update Deployments when ConfigMaps change](#update-deployments-when-configmaps-change)
- [direnv & pass](#direnv--pass)

<!-- markdown-toc end -->

## Update Deployments when ConfigMaps change

Expand Down Expand Up @@ -64,4 +72,4 @@ per project, it is easy to use [direnv][] to switch to the correct
`PASSWORD_STORE_DIR` variable when entering the folder.

[not currently]: https://github.com/kubernetes/kubernetes/issues/22368
[direnv]: https://direnv.net/
[direnv]: https://direnv.net/

0 comments on commit d7569ab

Please sign in to comment.