From d3f23c30bd3ac8549d7e11ae892f3f3339f2f725 Mon Sep 17 00:00:00 2001 From: Alan Meadows <alan.meadows@gmail.com> Date: Fri, 3 Feb 2017 11:44:12 -0800 Subject: [PATCH] Remove non-existent links in TOC As it stands, it is confusing to a viewer of the TOC on what links to actual documentation and what is a placeholder. This removes links that go no where. --- docs/README.md | 78 +++++++++++++++++++++++++------------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/README.md b/docs/README.md index 65e8ad807d..76723c1f5f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,10 +4,10 @@ ## Table of Contents ## 1. [Openstack-Helm Design Principals]() -### 1.1 [Mission](mission.md) +### 1.1 Mission ##### 1.1.1 [Resiliency](mission.md#resiliency) ##### 1.1.2 [Scaling](mission.md#scaling) -### 1.2 [Helm Overrides](helm_overrides.md) +### 1.2 Helm Overrides ##### 1.2.1 [Values Philosophy](helm_overrides#values) ##### 1.2.1 [Replicas](helm_overrides.md#replicas) ##### 1.2.1 [Labels](helm_overrides.md#labels) @@ -16,42 +16,42 @@ ##### 1.2.1 [Resource Limits](helm_overrides.md#resource limits) ##### 1.2.2 [Endpoints](#helm_overrides.md#endpoints) ##### 1.2.2 [Common Conditionals](helm_overrides.md#common conditionals) -### 1.3 [Init-Containers]() -##### 1.3.1 [Dependency Checking]() -### 1.4 [Kubernetes Jobs]() -##### 1.4.1 [Service Registration]() -##### 1.4.2 [User Registration]() -##### 1.4.3 [Database Creation]() -##### 1.4.4 [Database Migration]() -### 1.5 [Complimentary Efforts]() -#### 1.5.1 [Image-Based Project Considerations]() -### 1.6 [Kubernetes State]() -#### 1.6.1 [Third Party Resources]() -#### 1.6.2 [Add-Ons]() -## 2. [Repository Structure]() -### 2.1 [Infrastructure Components]() -### 2.2 [Openstack-Helm Core Services]() -### 2.3 [Openstack-Helm Add-Ons]() -## 3. [Operator Resources]() +### 1.3 Init-Containers +##### 1.3.1 Dependency Checking +### 1.4 Kubernetes Jobs +##### 1.4.1 Service Registration +##### 1.4.2 User Registration +##### 1.4.3 Database Creation +##### 1.4.4 Database Migration +### 1.5 Complimentary Efforts +#### 1.5.1 Image-Based Project Considerations +### 1.6 Kubernetes State +#### 1.6.1 Third Party Resources +#### 1.6.2 Add-Ons +## 2. Repository Structure +### 2.1 Infrastructure Components +### 2.2 Openstack-Helm Core Services +### 2.3 Openstack-Helm Add-Ons +## 3. Operator Resources ### 3.1 [Installation](https://github.com/att-comdev/openstack-helm/blob/master/docs/installation/getting-started.md) -### 3.2 [Openstack-Helm Chart Definition Overrides]() -### 3.2 [Openstacak-Helm Upgrades]() -## 4. [Openstack-Helm Networking]() -### 4.1 [Kubernetes Control Plane]() -#### 4.1.1 [CNI SDN Considerations]() -#### 4.1.2 [Calico Networking]() -### 4.2 [Ingress Philosophy]() -### 4.3 [Openstack Networking]() -#### 4.3.1 [Flat Networking]() -#### 4.3.1 [L2 Networking]() -## 5. [Security Guidelines]() -### 5.1 [Network Policies]() -### 5.2 [Advanced Network Policies]() -### 5.3 [Role-Based Access Controls]() -### 5.4 [Security Contexts]() -### 5.5 [Security Add-Ons]() -## 6. [Developer Resources](https://github.com/att-comdev/openstack-helm/tree/master/docs/developer) -### 6.1 [Contributions and Guidelines]() -### 6.2 [Development Tools]() +### 3.2 Openstack-Helm Chart Definition Overrides +### 3.2 Openstacak-Helm Upgrades +## 4. Openstack-Helm Networking +### 4.1 Kubernetes Control Plane +#### 4.1.1 CNI SDN Considerations +#### 4.1.2 Calico Networking +### 4.2 Ingress Philosophy +### 4.3 Openstack Networking +#### 4.3.1 Flat Networking +#### 4.3.1 L2 Networking +## 5. Security Guidelines +### 5.1 Network Policies +### 5.2 Advanced Network Policies +### 5.3 Role-Based Access Controls +### 5.4 Security Contexts +### 5.5 Security Add-Ons +## 6. Developer Resources +### 6.1 Contributions and Guidelines +### 6.2 Development Tools #### 6.2.1 [Minikube Development](https://github.com/att-comdev/openstack-helm/blob/master/docs/developer/minikube.md) -### 6.3 [Tips and Considerations]() +### 6.3 Tips and Considerations