Add TOC to configuration and quick start docs

This commit is contained in:
Andreas Sommer
2020-10-18 08:17:34 +02:00
parent bfa5295fce
commit bcae4c13b9
22 changed files with 16 additions and 31 deletions

View File

@@ -6,7 +6,6 @@ menu:
identifier: "1.0-roadmap" identifier: "1.0-roadmap"
weight: 3 weight: 3
--- ---
# Roadmap 🗺️
New year, new roadmap 🎉 New year, new roadmap 🎉

View File

@@ -6,7 +6,6 @@ menu:
identifier: "getting started" identifier: "getting started"
weight: 1 weight: 1
--- ---
# Getting Started
Welcome! This guide covers how to get started contributing to kind. Welcome! This guide covers how to get started contributing to kind.

View File

@@ -6,7 +6,6 @@ menu:
identifier: "project-scope" identifier: "project-scope"
weight: 2 weight: 2
--- ---
# Project Scope
This document outlines some scoping and major priorities for kind. This document outlines some scoping and major priorities for kind.

View File

@@ -5,7 +5,6 @@ menu:
parent: "contributing" parent: "contributing"
identifier: "project-structure" identifier: "project-structure"
--- ---
# Project Structure
🚧 This is a work-in-progress 🚧 🚧 This is a work-in-progress 🚧

View File

@@ -5,7 +5,6 @@ menu:
parent: "design" parent: "design"
identifier: "base-image" identifier: "base-image"
--- ---
# The Base Image
**NOTE**: This may not completely cover the current implementation. **NOTE**: This may not completely cover the current implementation.

View File

@@ -1,12 +1,11 @@
--- ---
title: "Initial" title: "Initial design"
menu: menu:
main: main:
parent: "design" parent: "design"
identifier: "design-initial" identifier: "design-initial"
weight: 2 weight: 2
--- ---
# Design
This document covers some of the initial design for `kind`. This document covers some of the initial design for `kind`.

View File

@@ -5,8 +5,6 @@ menu:
parent: "design" parent: "design"
identifier: "node-image" identifier: "node-image"
--- ---
# The Node Image
**NOTE**: This may not completely cover the current implementation. **NOTE**: This may not completely cover the current implementation.

View File

@@ -6,7 +6,6 @@ menu:
identifier: "design-principles" identifier: "design-principles"
weight: 1 weight: 1
--- ---
# Principles
While developing kind the following principles should be considered. While developing kind the following principles should be considered.

View File

@@ -5,18 +5,13 @@ menu:
parent: "user" parent: "user"
identifier: "user-configuration" identifier: "user-configuration"
weight: 3 weight: 3
toc: true
--- ---
<h1>⚠️ This page is a stub! We're working on it! ⚠️ </h1>
# Configuration
This guide covers how to configure KIND cluster creation. This guide covers how to configure KIND cluster creation.
We know this is currently a bit lacking right now and will expand it over time - PRs welcome! We know this is currently a bit lacking right now and will expand it over time - PRs welcome!
<!--TODO: TOC?-->
## Getting Started ## Getting Started
To configure kind cluster creation, you will need to create a [YAML] config file. To configure kind cluster creation, you will need to create a [YAML] config file.

View File

@@ -7,8 +7,6 @@ menu:
weight: 3 weight: 3
--- ---
# Ingress
This guide covers setting up [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) This guide covers setting up [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/)
on a kind cluster. on a kind cluster.

View File

@@ -6,7 +6,6 @@ menu:
identifier: "known-issues" identifier: "known-issues"
weight: 2 weight: 2
--- ---
# Known Issues
Having problems with kind? This guide is covers some known problems and solutions / workarounds. Having problems with kind? This guide is covers some known problems and solutions / workarounds.

View File

@@ -6,7 +6,6 @@ menu:
identifier: "user-local-registry" identifier: "user-local-registry"
weight: 3 weight: 3
--- ---
# Local Registry
With kind v0.6.0 there is a new config feature `containerdConfigPatches` that can With kind v0.6.0 there is a new config feature `containerdConfigPatches` that can
be leveraged to configure insecure registries. be leveraged to configure insecure registries.

View File

@@ -6,7 +6,6 @@ menu:
identifier: "user-private-registries" identifier: "user-private-registries"
weight: 3 weight: 3
--- ---
# Private Registries
Some users may want to test applications on kind that require pulling images Some users may want to test applications on kind that require pulling images
from authenticated private registries, there are multiple ways to do this. from authenticated private registries, there are multiple ways to do this.

View File

@@ -5,8 +5,8 @@ menu:
parent: "user" parent: "user"
identifier: "user-quick-start" identifier: "user-quick-start"
weight: 1 weight: 1
toc: true
--- ---
# Quick Start
This guide covers getting started with the `kind` command. This guide covers getting started with the `kind` command.

View File

@@ -7,8 +7,6 @@ menu:
weight: 4 weight: 4
--- ---
# Additional Resources
Here are some additional resources for learning about KIND and how to use it. Here are some additional resources for learning about KIND and how to use it.
## KubeCon Talks ## KubeCon Talks

View File

@@ -6,7 +6,6 @@ menu:
identifier: "using-wsl2" identifier: "using-wsl2"
weight: 3 weight: 3
--- ---
# Using WSL2
Kind can run using Windows Subsystem for Linux 2 (WSL2) on Windows 10 May 2020 Update (build 19041). All the tools needed to build or run kind work in WSL2, but some extra steps are needed to switch to WSL2. This page covers these steps in brief but also links to the official documentation if you would like more details. Kind can run using Windows Subsystem for Linux 2 (WSL2) on Windows 10 May 2020 Update (build 19041). All the tools needed to build or run kind work in WSL2, but some extra steps are needed to switch to WSL2. This page covers these steps in brief but also links to the official documentation if you would like more details.

View File

@@ -6,7 +6,6 @@ menu:
identifier: "working-offline" identifier: "working-offline"
weight: 3 weight: 3
--- ---
# Working Offline
Some users may work in an offline environment, Some users may work in an offline environment,
let's talk about how to create a cluster using kind in this environment. let's talk about how to create a cluster using kind in this environment.

View File

@@ -5,7 +5,7 @@
{{ partial "sidebar.html" . }} {{ partial "sidebar.html" . }}
<div id="wrapper">{{ partial "navbar.html" . }} <div id="wrapper">{{ partial "navbar.html" . }}
<!-- render the content as markdown, using a regex to add heading links--> <!-- render the content as markdown, using a regex to add heading links-->
<div id="content">{{ partial "fancymarkdown.html" .Content }}</div> <div id="content">{{ partial "fancymarkdown.html" . }}</div>
{{ partial "footer.html" . }} {{ partial "footer.html" . }}
</div> </div>
</body> </body>

View File

@@ -5,7 +5,7 @@
{{ partial "sidebar.html" . }} {{ partial "sidebar.html" . }}
<div id="wrapper">{{ partial "navbar.html" . }} <div id="wrapper">{{ partial "navbar.html" . }}
<!-- render the content as markdown, using a regex to add heading links--> <!-- render the content as markdown, using a regex to add heading links-->
<div id="content">{{ partial "fancymarkdown.html" .Content }}</div> <div id="content">{{ partial "fancymarkdown.html" . }}</div>
{{ partial "footer.html" . }} {{ partial "footer.html" . }}
</div> </div>
</body> </body>

View File

@@ -5,7 +5,7 @@
{{ partial "sidebar.html" . }} {{ partial "sidebar.html" . }}
<div id="wrapper">{{ partial "navbar.html" . }} <div id="wrapper">{{ partial "navbar.html" . }}
<!-- render the content as markdown, using a regex to add heading links--> <!-- render the content as markdown, using a regex to add heading links-->
<div id="content">{{ partial "fancymarkdown.html" .Content }}</div> <div id="content">{{ partial "fancymarkdown.html" . }}</div>
{{ partial "footer.html" . }} {{ partial "footer.html" . }}
</div> </div>
</body> </body>

View File

@@ -5,7 +5,7 @@
{{ partial "sidebar.html" . }} {{ partial "sidebar.html" . }}
<div id="wrapper">{{ partial "navbar.html" . }} <div id="wrapper">{{ partial "navbar.html" . }}
<!-- render the content as markdown, using a regex to add heading links--> <!-- render the content as markdown, using a regex to add heading links-->
<div id="content">{{ partial "fancymarkdown.html" .Content }}</div> <div id="content">{{ partial "fancymarkdown.html" . }}</div>
{{ partial "footer.html" . }} {{ partial "footer.html" . }}
</div> </div>
</body> </body>

View File

@@ -1 +1,9 @@
{{ . | replaceRE "(<h[1-9] id=\"([^\"]+)\".+)(</h[1-9]+>)" `${1}<a href="#${2}" class="hanchor" ariaLabel="Anchor"> 🔗&#xFE0E;</a> ${3}` | safeHTML }} <h1>{{ .Params.title }}</h1>
{{ if .Params.toc }}
<aside>
{{.TableOfContents}}
</aside>
{{ end }}
{{ .Content | replaceRE "(<h[1-9] id=\"([^\"]+)\".+)(</h[1-9]+>)" `${1}<a href="#${2}" class="hanchor" ariaLabel="Anchor"> 🔗&#xFE0E;</a> ${3}` | safeHTML }}