Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Commit

Permalink
docs: remove TOC from individual pages
Browse files Browse the repository at this point in the history
Maintaining the TOC was a constant source of regressions with missing
or outdated entries. It's main purpose was for people browsing the
source code repo, but even there it might distract because one has to
jump over it to get to the actual text.

Users should read documentation on the docsite, and there we have the
sidebar.
  • Loading branch information
pohly committed Jun 17, 2021
1 parent a26e566 commit af24d70
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 73 deletions.
32 changes: 0 additions & 32 deletions docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,5 @@
# Develop and Contribute

- [Setup](#setup)
- [Build PMEM-CSI](#build-pmem-csi)
- [Code quality](#code-quality)
- [Coding style](#coding-style)
- [Input validation](#input-validation)
- [Release management](#release-management)
- [Branching](#branching)
- [Tagging](#tagging)
- [Release checklist](#release-checklist)
- [Release PMEM-CSI operator](#release-pmem-csi-operator)
- [APIs](#apis)
- [CSI API](#csi-api)
- [Network ports](#network-ports)
- [Local sockets](#local-sockets)
- [Command line arguments](#command-line-arguments)
- [Environment variables](#environment-variables)
- [Logging](#logging)
- [Performance and resource measurements](#performance-and-resource-measurements)
- [Switching device mode](#switching-device-mode)
- [Going from LVM device mode to direct device mode](#going-from-lvm-device-mode-to-direct-device-mode)
- [Going from direct device mode to LVM device mode](#going-from-direct-device-mode-to-lvm-device-mode)
- [Accessing system directories in a container](#accessing-system-directories-in-a-container)
- [Read-only access to /sys](#read-only-access-to-sys)
- [Access to /dev of host](#access-to-dev-of-host)
- [Repository elements that are generated or created separately](#repository-elements-which-are-generated-or-created-separately)
- [Top-level README diagrams describing LVM and Direct device modes](#top-level-readme-diagrams-describing-lvm-and-direct-device-modes)
- [Top-level README diagram describing communication channels](#top-level-readme-diagram-describing-communication-channels)
- [Diagrams describing provisioning sequence](#diagrams-describing-provisioning-sequence)
- [RegistryServer spec](#registryserver-spec)
- [Table of Contents in README and DEVELOPMENT](#table-of-contents-in-readme-and-development)
- [Edit, build, and deploy the Read the Docs site](#build-edit-and-deploy-the-read-the-docs-site)

## Setup

### Build PMEM-CSI
Expand Down
8 changes: 0 additions & 8 deletions docs/autotest.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Automated testing

- [Automated testing](#automated-testing)
- [Unit testing and code quality](#unit-testing-and-code-quality)
- [QEMU and Kubernetes](#qemu-and-kubernetes)
- [Starting and stopping a test cluster](#starting-and-stopping-a-test-cluster)
- [Running commands on test cluster nodes over ssh](#running-commands-on-test-cluster-nodes-over-ssh)
- [Configuration options](#configuration-options)
- [Running E2E tests](#running-e2e-tests)

## Unit testing and code quality

Use the `make test` command.
Expand Down
13 changes: 0 additions & 13 deletions docs/design.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,5 @@
# Design and architecture

- [Design](#design)
- [Architecture and Operation](#architecture-and-operation)
- [LVM device mode](#lvm-device-mode)
- [Direct device mode](#direct-device-mode)
- [Kata Containers support](#kata-containers-support)
- [Dynamic provisioning of local volumes](#dynamic-provisioning-of-local-volumes)
- [Communication between components](#communication-between-components)
- [Security](#security)
- [Volume Persistency](#volume-persistency)
- [Volume Size](#volume-size)
- [Capacity-aware pod scheduling](#capacity-aware-pod-scheduling)
- [PMEM-CSI operator](#pmem-csi-operator)

## Architecture and Operation

The PMEM-CSI driver can operate in two different device modes: *LVM* and
Expand Down
20 changes: 0 additions & 20 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,5 @@
# Installation and Usage

- [Prerequisites](#prerequisites)
- [Software required](#software-required)
- [Hardware required](#hardware-required)
- [Persistent memory pre-provisioning](#persistent-memory-pre-provisioning)
- [Installation and setup](#installation-and-setup)
- [Install PMEM-CSI driver](#install-pmem-csi-driver)
- [Install using the operator](#install-using-the-operator)
- [Install via YAML files](#install-via-yaml-files)
- [Volume parameters](#volume-parameters)
- [Creating volumes](#creating-volumes)
- [Troubleshooting](#troubleshooting)
- [Automatic node setup](#automatic-node-setup)
- [Kata Containers support](#kata-containers-support)
- [Ephemeral inline volumes](#ephemeral-inline-volumes)
- [Raw block volumes](#raw-block-volumes)
- [Enable scheduler extensions](#enable-scheduler-extensions)
- [Metrics support](#metrics-support)
- [PMEM-CSI Deployment CRD](#pmem-csi-deployment-crd)
- [Filing issues and contributing](#filing-issues-and-contributing)

## Overview

This section summarizes the steps that may be needed during the entire
Expand Down

0 comments on commit af24d70

Please sign in to comment.