Merge pull request #1555 from weaveworks/1546-toc-docs

Add ToC to larger doc pages
fluxcd · Nov 26, 2018 · e988196 · e988196
2 parents 58f561b + 4e01457
commit e988196
Show file tree

Hide file tree

Showing 6 changed files with 106 additions and 0 deletions.
diff --git a/site/faq.md b/site/faq.md
@@ -3,6 +3,39 @@ title: Weave Flux FAQ
 menu_order: 60
 ---
 
+- [General questions](#general-questions)
+  * [What does Flux do?](#what-does-flux-do)
+  * [How does it automate deployment?](#how-does-it-automate-deployment)
+  * [How is that different from a bash script?](#how-is-that-different-from-a-bash-script)
+  * [Why should I automate deployment?](#why-should-i-automate-deployment)
+  * [I thought Flux was about service routing?](#i-thought-flux-was-about-service-routing)
+  * [Are there nightly builds I can run?](#are-there-nightly-builds-i-can-run)
+- [Technical questions](#technical-questions)
+  * [Does it work only with one git repository?](#does-it-work-only-with-one-git-repository)
+  * [Do I have to put my application code and config in the same git repo?](#do-i-have-to-put-my-application-code-and-config-in-the-same-git-repo)
+  * [Is there any special directory layout I need in my git repo?](#is-there-any-special-directory-layout-i-need-in-my-git-repo)
+  * [Why does Flux need a git ssh key with write access?](#why-does-flux-need-a-git-ssh-key-with-write-access)
+  * [Does Flux automatically sync changes back to git?](#does-flux-automatically-sync-changes-back-to-git)
+  * [How do I give Flux access to an image registry?](#how-do-i-give-flux-access-to-an-image-registry)
+  * [How often does Flux check for new images?](#how-often-does-flux-check-for-new-images)
+  * [How often does Flux check for new git commits (and can I make it sync faster)?](#how-often-does-flux-check-for-new-git-commits-and-can-i-make-it-sync-faster)
+  * [How do I use my own deploy key?](#how-do-i-use-my-own-deploy-key)
+  * [Why are my images not showing up in the list of images?](#why-are-my-images-not-showing-up-in-the-list-of-images)
+  * [Why do my image tags appear out of order?](#why-do-my-image-tags-appear-out-of-order)
+  * [How do I use a private git host (or one that's not github.com, gitlab.com, or bitbucket.org)?](#how-do-i-use-a-private-git-host-or-one-thats-not-githubcom-gitlabcom-or-bitbucketorg)
+  * [Will Flux delete resources that are no longer in the git repository?](#will-flux-delete-resources-that-are-no-longer-in-the-git-repository)
+  * [Why does my CI pipeline keep getting triggered?](#why-does-my-ci-pipeline-keep-getting-triggered)
+  * [What is the "sync tag"; or, why do I see a `flux-sync` tag in my git repo?](#what-is-the-sync-tag-or-why-do-i-see-a-flux-sync-tag-in-my-git-repo)
+  * [Can I restrict the namespaces that Flux can see or operate on?](#can-i-restrict-the-namespaces-that-flux-can-see-or-operate-on)
+  * [Can I change the namespace Flux puts things in by default?](#can-i-change-the-namespace-flux-puts-things-in-by-default)
+  * [Can I temporarily make Flux ignore a deployment?](#can-i-temporarily-make-flux-ignore-a-deployment)
+- [Flux Helm Operator questions](#flux-helm-operator-questions)
+  * [I'm using SSL between Helm and Tiller. How can I configure Flux to use the certificate?](#im-using-ssl-between-helm-and-tiller-how-can-i-configure-flux-to-use-the-certificate)
+  * [I've deleted a FluxHelmRelease file from Git. Why is the Helm release still running on my cluster?](#ive-deleted-a-fluxhelmrelease-file-from-git-why-is-the-helm-release-still-running-on-my-cluster)
+  * [I've manually deleted a Helm release. Why is Flux not able to restore it?](#ive-manually-deleted-a-helm-release-why-is-flux-not-able-to-restore-it)
+  * [I've uninstalled Flux and all my Helm releases are gone. Why is that?](#ive-uninstalled-flux-and-all-my-helm-releases-are-gone-why-is-that)
+  * [I have a dedicated Kubernetes cluster per environment and I want to use the same Git repo for all. How can I do that?](#i-have-a-dedicated-kubernetes-cluster-per-environment-and-i-want-to-use-the-same-git-repo-for-all-how-can-i-do-that)
+
 ## General questions
 
 Also see [the introduction](/site/introduction.md).

diff --git a/site/fluxctl.md b/site/fluxctl.md
@@ -3,6 +3,36 @@ title: Using Weave Flux
 menu_order: 40
 ---
 
+- [Installing fluxctl](#installing-fluxctl)
+  * [Mac OS](#mac-os)
+  * [Linux](#linux)
+    + [Arch Linux](#arch-linux)
+  * [Binary releases](#binary-releases)
+- [Connecting fluxctl to the daemon](#connecting-fluxctl-to-the-daemon)
+  * [Flux API service](#flux-api-service)
+  * [Add an SSH deploy key to the repository](#add-an-ssh-deploy-key-to-the-repository)
+    + [1. Allow flux to generate a key for you](#1-allow-flux-to-generate-a-key-for-you)
+    + [2. Specify a key to use](#2-specify-a-key-to-use)
+- [What is a Controller](#what-is-a-controller)
+- [Viewing Controllers](#viewing-controllers)
+- [Inspecting the Version of a Container](#inspecting-the-version-of-a-container)
+- [Releasing a Controller](#releasing-a-controller)
+- [Turning on Automation](#turning-on-automation)
+- [Turning off Automation](#turning-off-automation)
+- [Rolling back a Controller](#rolling-back-a-controller)
+- [Locking a Controller](#locking-a-controller)
+- [Releasing an image to a locked controller](#releasing-an-image-to-a-locked-controller)
+- [Unlocking a Controller](#unlocking-a-controller)
+- [Recording user and message with the triggered action](#recording-user-and-message-with-the-triggered-action)
+- [Image Tag Filtering](#image-tag-filtering)
+  * [Filter pattern types](#filter-pattern-types)
+    + [Glob](#glob)
+    + [Semver](#semver)
+    + [Regexp](#regexp)
+  * [Actions triggered through `fluxctl`](#actions-triggered-through-fluxctl)
+  * [Errors due to author customization](#errors-due-to-author-customization)
+- [Using Annotations](#using-annotations)
+
 All of the features of Flux are accessible from within
 [Weave Cloud](https://cloud.weave.works).
 

diff --git a/site/get-started.md b/site/get-started.md
@@ -3,6 +3,16 @@ title: Installing Weave Flux Manually
 menu_order: 10
 ---
 
+- [Get started with Flux](#get-started-with-flux)
+  * [Prerequisites](#prerequisites)
+    + [A Note on GKE with RBAC enabled](#a-note-on-gke-with-rbac-enabled)
+  * [Set up Flux](#set-up-flux)
+  * [Deploying Flux to the cluster](#deploying-flux-to-the-cluster)
+  * [Giving write access](#giving-write-access)
+  * [Committing a small change](#committing-a-small-change)
+  * [Confirm the change landed](#confirm-the-change-landed)
+  * [Conclusion](#conclusion)
+
 # Get started with Flux
 
 This short guide shows a self-contained example of Flux and just

diff --git a/site/helm-get-started.md b/site/helm-get-started.md
@@ -3,6 +3,14 @@ title: Installing Weave Flux using Helm
 menu_order: 20
 ---
 
+- [Get started with Flux using Helm](#get-started-with-flux-using-helm)
+  * [Prerequisites](#prerequisites)
+  * [Install Weave Flux](#install-weave-flux)
+  * [Giving write access](#giving-write-access)
+  * [Committing a small change](#committing-a-small-change)
+  * [Conclusion](#conclusion)
+- [Next](#next)
+
 # Get started with Flux using Helm
 
 If you are using Helm already, this guide is for you. By the end

diff --git a/site/helm-integration.md b/site/helm-integration.md
@@ -3,6 +3,20 @@ title: Using Flux with Helm
 menu_order: 90
 ---
 
+- [Using Flux with Helm](#using-flux-with-helm)
+  * [The `HelmRelease` custom resource](#the-helmrelease-custom-resource)
+    + [Using a chart from a Git repo instead of a Helm repo](#using-a-chart-from-a-git-repo-instead-of-a-helm-repo)
+    + [What the Helm Operator does](#what-the-helm-operator-does)
+  * [Supplying values to the chart](#supplying-values-to-the-chart)
+    + [`.spec.values`](#specvalues)
+    + [`.spec.valueFileSecrets`](#specvaluefilesecrets)
+      - [Example of `spec.valueFileSecrets`](#example-of-specvaluefilesecrets)
+  * [Authentication](#authentication)
+    + [Authentication for Helm repos](#authentication-for-helm-repos)
+    + [Authentication for Git repos](#authentication-for-git-repos)
+  * [Upgrading images in a HelmRelease using Flux](#upgrading-images-in-a-helmrelease-using-flux)
+    + [Using annotations to control updates to HelmRelease resources](#using-annotations-to-control-updates-to-helmrelease-resources)
+
 # Using Flux with Helm
 
 You can release charts to your cluster via "GitOps", by combining Flux

diff --git a/site/standalone-setup.md b/site/standalone-setup.md
@@ -3,6 +3,17 @@ title: Customising the deployment
 menu_order: 20
 ---
 
+- [Customising the deployment](#customising-the-deployment)
+- [Customising the daemon configuration](#customising-the-daemon-configuration)
+  * [Connect Flux to a repository](#connect-flux-to-a-repository)
+  * [Memcache](#memcache)
+  * [Flux deployment](#flux-deployment)
+  * [Add an SSH deploy key to the repository](#add-an-ssh-deploy-key-to-the-repository)
+    + [1. Allow Flux to generate a key for you.](#1-allow-flux-to-generate-a-key-for-you)
+    + [2. Specify a key to use](#2-specify-a-key-to-use)
+    + [Note for Kubernetes >=1.6 with role-based access control (RBAC)](#note-for-kubernetes-16-with-role-based-access-control-rbac)
+  * [Using a private git host](#using-a-private-git-host)
+
 # Customising the deployment
 
 The deployment installs Flux and its dependencies. First, change to