From 9c64c3ff7f56ddc0624b0bf2dc7b592b82129b00 Mon Sep 17 00:00:00 2001 From: Devin Donnelly Date: Thu, 5 Jan 2017 14:21:48 -0800 Subject: [PATCH] Adds missing TOC entries for docs that fail the new Travis check in PR #2007. Skips the checks for certain inaccessible or deprecated files and removes unused README.md files. --- _data/guides.yml | 36 +++++++++++++++++-- _data/reference.yml | 18 +--------- _data/tasks.yml | 1 + _data/tutorials.yml | 3 ++ docs/api-reference/README.md | 16 --------- .../labels-annotations-taints.md | 2 +- .../environment-guide/containers/README.md | 23 ------------ 7 files changed, 39 insertions(+), 60 deletions(-) delete mode 100644 docs/api-reference/README.md delete mode 100644 docs/user-guide/environment-guide/containers/README.md diff --git a/_data/guides.yml b/_data/guides.yml index bb271a6183..d9c70159eb 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -45,6 +45,7 @@ toc: - docs/getting-started-guides/network-policy/walkthrough.md - docs/getting-started-guides/network-policy/calico.md - docs/getting-started-guides/network-policy/romana.md + - docs/getting-started-guides/network-policy/weave.md - title: Batch Jobs section: @@ -67,7 +68,9 @@ toc: - docs/user-guide/simple-nginx.md - docs/user-guide/pods/single-container.md - docs/user-guide/pods/multi-container.md + - docs/user-guide/pods/init-container.md - docs/user-guide/configuring-containers.md + - docs/user-guide/pod-templates.md - docs/user-guide/production-pods.md - docs/user-guide/containers.md - docs/user-guide/environment-guide/index.md @@ -149,7 +152,12 @@ toc: - docs/getting-started-guides/fedora/flannel_multi_node_cluster.md - docs/getting-started-guides/centos/centos_manual_config.md - docs/getting-started-guides/coreos/index.md - - /docs/getting-started-guides/ubuntu/ + - title: Ubuntu + section: + - /docs/getting-started-guides/ubuntu/ + - /docs/getting-started-guides/ubuntu/automated.md + - /docs/getting-started-guides/ubuntu/calico.md + - /docs/getting-started-guides/ubuntu/manual.md - docs/getting-started-guides/windows/index.md - docs/admin/node-conformance.md - docs/getting-started-guides/docker-multinode.md @@ -163,11 +171,16 @@ toc: - docs/admin/cluster-management.md - docs/admin/kubeadm.md - docs/admin/addons.md + - docs/admin/audit.md + - docs/admin/ha-master-gce.md - docs/admin/namespaces/index.md - docs/admin/namespaces/walkthrough.md - docs/admin/limitrange/index.md + - docs/admin/disruptions.md - docs/admin/resourcequota/index.md - docs/admin/resourcequota/walkthrough.md + - docs/admin/rescheduler.md + - docs/admin/sysctls.md - docs/admin/cluster-components.md - docs/admin/etcd.md - docs/admin/multi-cluster.md @@ -189,5 +202,22 @@ toc: - title: Administering Federation section: - - /docs/admin/federation/kubfed/ - - docs/admin/federation/index.md + - title: Setting Up Federation with kubefed + path: - /docs/admin/federation/kubefed.md + title: Federated Kubernetes Objects + section: + - docs/user-guide/federation/index.md + - docs/user-guide/federation/configmap.md + - docs/user-guide/federation/daemonsets.md + - docs/user-guide/federation/deployment.md + - docs/user-guide/federation/events.md + - docs/user-guide/federation/federated-ingress.md + - docs/user-guide/federation/namespaces.md + - docs/user-guide/federation/replicasets.md + - docs/user-guide/federation/secrets.md + - docs/federation/api-reference/README.md + - title: Federation Components + section: + - docs/admin/federation-apiserver.md + - title : federation-controller-mananger + path: /docs/admin/federation-controller-manager diff --git a/_data/reference.yml b/_data/reference.yml index 475d87d10c..d848036c33 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -15,6 +15,7 @@ toc: - docs/admin/service-accounts-admin.md - docs/api-reference/v1/operations.html - docs/api-reference/v1/definitions.html + - docs/api-reference/labels-annotations-taints.md - kubernetes/third_party/swagger-ui/index.md - title: Autoscaling API @@ -183,20 +184,3 @@ toc: - title: Security in Kubernetes path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/security.md -- title: Federation - section: - - docs/user-guide/federation/index.md - - docs/user-guide/federation/configmap.md - - docs/user-guide/federation/daemonsets.md - - docs/user-guide/federation/deployment.md - - docs/user-guide/federation/events.md - - docs/user-guide/federation/federated-ingress.md - - docs/user-guide/federation/namespaces.md - - docs/user-guide/federation/replicasets.md - - docs/user-guide/federation/secrets.md - - docs/federation/api-reference/README.md - - title: Federation Components - section: - - docs/admin/federation-apiserver.md - - title : federation-controller-mananger - path: /docs/admin/federation-controller-manager diff --git a/_data/tasks.yml b/_data/tasks.yml index 05a880637a..b7a72024a8 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -14,6 +14,7 @@ toc: - title: Accessing Applications in a Cluster section: - docs/tasks/access-application-cluster/port-forward-access-application-cluster.md + - docs/tasks/access-application-cluster/load-balance-access-application-cluster.md - title: Debugging Applications in a Cluster section: diff --git a/_data/tutorials.yml b/_data/tutorials.yml index 08e8b0b46a..954d0841a1 100644 --- a/_data/tutorials.yml +++ b/_data/tutorials.yml @@ -41,3 +41,6 @@ toc: - docs/tutorials/stateful-application/run-stateful-application.md - docs/tutorials/stateful-application/run-replicated-stateful-application.md - docs/tutorials/stateful-application/zookeeper.md +- title: Services + section: + - docs/tutorials/services/source-ip.md diff --git a/docs/api-reference/README.md b/docs/api-reference/README.md deleted file mode 100644 index d0040388c8..0000000000 --- a/docs/api-reference/README.md +++ /dev/null @@ -1,16 +0,0 @@ ---- ---- -# API Reference - -Use the following reference docs to understand the Kubernetes REST API for various API group versions: - -* v1: [operations](/docs/api-reference/v1/operations.html), [model definitions](/docs/api-reference/v1/definitions.html) -* extensions/v1beta1: [operations](/docs/api-reference/extensions/v1beta1/operations.html), [model definitions](/docs/api-reference/extensions/v1beta1/definitions.html) -* batch/v1: [operations](/docs/api-reference/batch/v1/operations.html), [model definitions](/docs/api-reference/batch/v1/definitions.html) -* autoscaling/v1: [operations](/docs/api-reference/autoscaling/v1/operations.html), [model definitions](/docs/api-reference/autoscaling/v1/definitions.html) -* apps/v1beta1: [operations](/docs/api-reference/apps/v1beta1/operations.html), [model definitions](/docs/api-reference/apps/v1beta1/definitions.html) - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/api-reference/README.md?pixel)]() - diff --git a/docs/api-reference/labels-annotations-taints.md b/docs/api-reference/labels-annotations-taints.md index 8ed53d763e..e159fbf818 100644 --- a/docs/api-reference/labels-annotations-taints.md +++ b/docs/api-reference/labels-annotations-taints.md @@ -1,6 +1,6 @@ --- +title: Well-Known Labels, Annotations and Taints --- -# Well-Known Labels, Annotations and Taints Kubernetes reserves all labels and annotations in the kubernetes.io namespace. This document describes the well-known kubernetes.io labels and annotations. diff --git a/docs/user-guide/environment-guide/containers/README.md b/docs/user-guide/environment-guide/containers/README.md deleted file mode 100644 index 06fa5778bc..0000000000 --- a/docs/user-guide/environment-guide/containers/README.md +++ /dev/null @@ -1,23 +0,0 @@ -## Building - -For each container, the build steps are the same. The examples below -are for the `show` container. Replace `show` with `backend` for the -backend container. - -## Google Container Registry ([GCR](https://cloud.google.com/tools/container-registry/)) - - docker build -t gcr.io//show . - gcloud docker push gcr.io//show - -## Docker Hub - - docker build -t /show . - docker push /show - -## Change Pod Definitions - -Edit both `show-rc.yaml` and `backend-rc.yaml` and replace the -specified `image:` with the one that you built. - - -