Skip to content

Commit

Permalink
Drop [[toc]] until we find a better way.
Browse files Browse the repository at this point in the history
GitHub automatically generates a ToC that seems to be hidden by default, but is
accessible using the "dotted hamburger" icon in upper right-hand corner. See
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#headings

Ideally GitHub would provide a way to have an in-line auto-generated ToC or at
some point we can investigate ways to have it semi-automatically generated.

But for now having docs with this slightly hidden ToC is better than not having
them.

Signed-off-by: Marcin Owsiany <[email protected]>
  • Loading branch information
porridge committed Feb 7, 2024
1 parent a9135ac commit 2107def
Show file tree
Hide file tree
Showing 8 changed files with 0 additions and 26 deletions.
4 changes: 0 additions & 4 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

This document demonstrates how to use the KUTTL CLI

<h2>Table of Contents</h2>

[[toc]]

## Setup the KUTTL Kubectl Plugin

### Requirements
Expand Down
4 changes: 0 additions & 4 deletions docs/kuttl-test-harness.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ KUTTL is a declarative integration testing harness for testing operators, KUDO,

Whether you are developing an application, controller, operator, or deploying Kubernetes clusters the KUTTL test harness helps you easily write portable end-to-end, integration, and conformance tests for Kubernetes without needing to write any code.

<h2>Table of Contents</h2>

[[toc]]

## Installation

The test harness CLI is included in the KUTTL CLI, to install we can install the CLI using [krew](https://github.com/kubernetes-sigs/krew):
Expand Down
4 changes: 0 additions & 4 deletions docs/testing/asserts-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Test asserts are the part of a [test step](steps.md) that define the state to wait for Kubernetes to reach. It is possible to match specific objects by name as well as match any object that matches a defined state. Test errors define states that should not be reached.

<h2>Table of Contents</h2>

[[toc]]

## Format

The test assert file for a test step is found at `$index-assert.yaml`. So, if the test step index is `00`, the assert should be called `00-assert.yaml`. This file can contain any number of objects to match on. If the objects have a namespace set, it will be respected, but if a namespace is not set, then the test harness will look for the objects in the test case's namespace.
Expand Down
4 changes: 0 additions & 4 deletions docs/testing/reference.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# KUTTL Configuration Reference

<h2>Table of Contents</h2>

[[toc]]

## TestSuite

The `TestSuite` object specifies the settings for the entire test suite and should live in the test suite configuration file (`kuttl-test.yaml` by default, or `--config`):
Expand Down
4 changes: 0 additions & 4 deletions docs/testing/steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ Each test case is broken down into test steps. Test steps within a test case are

A test step can create, update, and delete objects as well as run any kubectl command.

<h2>Table of Contents</h2>

[[toc]]

## Format

A test step can include many YAML files and each YAML file can contain many Kubernetes objects. In a test case's directory, each file that begins with the same index is considered a part of the same test step. All objects inside of a test step are operated on by the test harness simultaneously, so use separate test steps to order operations.
Expand Down
2 changes: 0 additions & 2 deletions docs/testing/test-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ The KUTTL test harness can run tests against several different test environments

A default environment for the tests can be defined in `kuttl-test.yaml` allowing each test suite or project to easily use the correct environment.

[[toc]]

## Live Cluster

If no configuration is provided, the tests will run against your default cluster context using whatever Kubernetes cluster is configured in your kubeconfig.
Expand Down
2 changes: 0 additions & 2 deletions docs/testing/tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

This document contains some tips and gotchas that can be helpful when writing tests.

[[toc]]

## Loading Built Images Into KIND

When KIND clusters are started, you may want to load an image that has not been pushed into the registry. To do this, you can use the `kindContainers` setting on your `TestSuite`.
Expand Down
2 changes: 0 additions & 2 deletions docs/what-is-kuttl.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# What is KUTTL

[[toc]]

## Overview

The KUbernetes Test TooL (KUTTL) provides a declarative approach to testing production-grade Kubernetes [operators](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
Expand Down

0 comments on commit 2107def

Please sign in to comment.