diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index 161239b80..3588f47b2 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -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 diff --git a/docs/autotest.md b/docs/autotest.md index f93045ef6..8f4966257 100644 --- a/docs/autotest.md +++ b/docs/autotest.md @@ -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. diff --git a/docs/design.md b/docs/design.md index 8d003dbc1..8ac056d5b 100644 --- a/docs/design.md +++ b/docs/design.md @@ -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 diff --git a/docs/install.md b/docs/install.md index 88c06d069..390678dde 100644 --- a/docs/install.md +++ b/docs/install.md @@ -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