diff options
| author | guineveresaenger <guineveresaenger@gmail.com> | 2017-11-03 15:37:08 -0700 |
|---|---|---|
| committer | guineveresaenger <guineveresaenger@gmail.com> | 2017-11-03 15:37:08 -0700 |
| commit | b41c258f983f6a0ecb49a169a61673a1017639f8 (patch) | |
| tree | d74d2eb75fa642183fb92f16e7396a5059ba5d82 | |
| parent | eca5c418e4ee763b4d6e64526331706459001122 (diff) | |
beging to remove munch tags from files, also removed deprecated content of how-to-doc in favor of link to k/website
19 files changed, 4 insertions, 232 deletions
diff --git a/contributors/design-proposals/api-machinery/client-package-structure.md b/contributors/design-proposals/api-machinery/client-package-structure.md index 9cbd6aa8..37991402 100644 --- a/contributors/design-proposals/api-machinery/client-package-structure.md +++ b/contributors/design-proposals/api-machinery/client-package-structure.md @@ -1,5 +1,3 @@ -<!-- BEGIN MUNGE: GENERATED_TOC --> - - [Client: layering and package structure](#client-layering-and-package-structure) - [Desired layers](#desired-layers) - [Transport](#transport) @@ -12,7 +10,6 @@ - [Package Structure](#package-structure) - [Client Guarantees (and testing)](#client-guarantees-and-testing) -<!-- END MUNGE: GENERATED_TOC --> # Client: layering and package structure diff --git a/contributors/design-proposals/api-machinery/synchronous-garbage-collection.md b/contributors/design-proposals/api-machinery/synchronous-garbage-collection.md index 7cc78ece..66518620 100644 --- a/contributors/design-proposals/api-machinery/synchronous-garbage-collection.md +++ b/contributors/design-proposals/api-machinery/synchronous-garbage-collection.md @@ -1,5 +1,4 @@ **Table of Contents** -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Overview](#overview) - [API Design](#api-design) @@ -14,7 +13,6 @@ - [Unhandled cases](#unhandled-cases) - [Implications to existing clients](#implications-to-existing-clients) -<!-- END MUNGE: GENERATED_TOC --> # Overview diff --git a/contributors/design-proposals/apps/deploy.md b/contributors/design-proposals/apps/deploy.md index 8185757d..0cc5dec0 100644 --- a/contributors/design-proposals/apps/deploy.md +++ b/contributors/design-proposals/apps/deploy.md @@ -1,5 +1,3 @@ -<!-- BEGIN MUNGE: GENERATED_TOC --> - - [Deploy through CLI](#deploy-through-cli) - [Motivation](#motivation) - [Requirements](#requirements) @@ -16,7 +14,6 @@ - [Pause Deployments](#pause-deployments) - [Perm-failed Deployments](#perm-failed-deployments) -<!-- END MUNGE: GENERATED_TOC --> # Deploy through CLI diff --git a/contributors/design-proposals/auth/apparmor.md b/contributors/design-proposals/auth/apparmor.md index 984286d3..825427bf 100644 --- a/contributors/design-proposals/auth/apparmor.md +++ b/contributors/design-proposals/auth/apparmor.md @@ -1,5 +1,3 @@ -<!-- BEGIN MUNGE: GENERATED_TOC --> - - [Overview](#overview) - [Motivation](#motivation) - [Related work](#related-work) @@ -22,8 +20,6 @@ - [Profile authoring](#profile-authoring) - [Appendix](#appendix) -<!-- END MUNGE: GENERATED_TOC --> - # Overview AppArmor is a [mandatory access control](https://en.wikipedia.org/wiki/Mandatory_access_control) diff --git a/contributors/design-proposals/instrumentation/core-metrics-pipeline.md b/contributors/design-proposals/instrumentation/core-metrics-pipeline.md index 0849aae4..7da3e61e 100644 --- a/contributors/design-proposals/instrumentation/core-metrics-pipeline.md +++ b/contributors/design-proposals/instrumentation/core-metrics-pipeline.md @@ -8,7 +8,6 @@ This document proposes a design for the set of metrics included in an eventual Core Metrics Pipeline. -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Core Metrics in kubelet](#core-metrics-in-kubelet) - [Introduction](#introduction) @@ -23,7 +22,6 @@ This document proposes a design for the set of metrics included in an eventual C - [On-Demand Design:](#on-demand-design) - [Future Work](#future-work) -<!-- END MUNGE: GENERATED_TOC --> ## Introduction diff --git a/contributors/design-proposals/network/external-lb-source-ip-preservation.md b/contributors/design-proposals/network/external-lb-source-ip-preservation.md index 4735c135..ac48ed5d 100644 --- a/contributors/design-proposals/network/external-lb-source-ip-preservation.md +++ b/contributors/design-proposals/network/external-lb-source-ip-preservation.md @@ -1,5 +1,3 @@ -<!-- BEGIN MUNGE: GENERATED_TOC --> - - [Overview](#overview) - [Motivation](#motivation) - [Alpha Design](#alpha-design) @@ -27,7 +25,6 @@ - [Future work](#future-work) - [Appendix](#appendix) -<!-- END MUNGE: GENERATED_TOC --> # Overview diff --git a/contributors/design-proposals/node/sysctl.md b/contributors/design-proposals/node/sysctl.md index 9a89d0f8..5c79a736 100644 --- a/contributors/design-proposals/node/sysctl.md +++ b/contributors/design-proposals/node/sysctl.md @@ -28,7 +28,6 @@ for namespaced kernel parameters (sysctls) set for each pod. ## Table of Contents -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Setting Sysctls on the Pod Level](#setting-sysctls-on-the-pod-level) - [Roadmap](#roadmap) @@ -63,7 +62,6 @@ for namespaced kernel parameters (sysctls) set for each pod. - [Use in a pod](#use-in-a-pod) - [Allowing only certain sysctls](#allowing-only-certain-sysctls) -<!-- END MUNGE: GENERATED_TOC --> ## Abstract diff --git a/contributors/design-proposals/release/release-notes.md b/contributors/design-proposals/release/release-notes.md index f602eead..41b3ac4e 100644 --- a/contributors/design-proposals/release/release-notes.md +++ b/contributors/design-proposals/release/release-notes.md @@ -4,7 +4,6 @@ [djmm@google.com](mailto:djmm@google.com)<BR> Last Updated: 2016-04-06 -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Kubernetes Release Notes](#kubernetes-release-notes) - [Objective](#objective) @@ -22,7 +21,6 @@ Last Updated: 2016-04-06 - [Work estimates](#work-estimates) - [Caveats / Considerations](#caveats--considerations) -<!-- END MUNGE: GENERATED_TOC --> ## Objective diff --git a/contributors/design-proposals/resource-management/gpu-support.md b/contributors/design-proposals/resource-management/gpu-support.md index 19aa1dac..98364414 100644 --- a/contributors/design-proposals/resource-management/gpu-support.md +++ b/contributors/design-proposals/resource-management/gpu-support.md @@ -1,5 +1,3 @@ -<!-- BEGIN MUNGE: GENERATED_TOC --> - - [GPU support](#gpu-support) - [Objective](#objective) - [Background](#background) @@ -22,7 +20,6 @@ - [Undetermined](#undetermined) - [Security considerations](#security-considerations) -<!-- END MUNGE: GENERATED_TOC --> # GPU support diff --git a/contributors/devel/api-conventions.md b/contributors/devel/api-conventions.md index 88ba902c..c76d6c61 100644 --- a/contributors/devel/api-conventions.md +++ b/contributors/devel/api-conventions.md @@ -8,7 +8,7 @@ Kubernetes API structure, and developers wanting to extend the Kubernetes API. An introduction to using resources with kubectl can be found in [the object management overview](https://kubernetes.io/docs/tutorials/object-management-kubectl/object-management/).* **Table of Contents** -<!-- BEGIN MUNGE: GENERATED_TOC --> + - [Types (Kinds)](#types-kinds) - [Resources](#resources) @@ -45,7 +45,6 @@ An introduction to using resources with kubectl can be found in [the object mana - [WebSockets and SPDY](#websockets-and-spdy) - [Validation](#validation) -<!-- END MUNGE: GENERATED_TOC --> The conventions of the [Kubernetes API](https://kubernetes.io/docs/api/) (and related APIs in the ecosystem) are intended to ease client development and ensure that configuration diff --git a/contributors/devel/api_changes.md b/contributors/devel/api_changes.md index 3f6116f2..d592feab 100644 --- a/contributors/devel/api_changes.md +++ b/contributors/devel/api_changes.md @@ -3,7 +3,6 @@ A set of API conventions, which applies to new APIs and to changes, can be found at [API Conventions](api-conventions.md). **Table of Contents** -<!-- BEGIN MUNGE: GENERATED_TOC --> - [So you want to change the API?](#so-you-want-to-change-the-api) - [Operational overview](#operational-overview) @@ -30,7 +29,6 @@ found at [API Conventions](api-conventions.md). - [Alpha, Beta, and Stable Versions](#alpha-beta-and-stable-versions) - [Adding Unstable Features to Stable Versions](#adding-unstable-features-to-stable-versions) -<!-- END MUNGE: GENERATED_TOC --> # So you want to change the API? diff --git a/contributors/devel/coding-conventions.md b/contributors/devel/coding-conventions.md index 04f58613..d15d7eb9 100644 --- a/contributors/devel/coding-conventions.md +++ b/contributors/devel/coding-conventions.md @@ -3,7 +3,6 @@ Updated: 5/3/2016 **Table of Contents** -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Coding Conventions](#coding-conventions) - [Code conventions](#code-conventions) @@ -11,7 +10,6 @@ Updated: 5/3/2016 - [Directory and file conventions](#directory-and-file-conventions) - [Coding advice](#coding-advice) -<!-- END MUNGE: GENERATED_TOC --> ## Code conventions diff --git a/contributors/devel/e2e-tests.md b/contributors/devel/e2e-tests.md index 9fdf55dd..8c9ca393 100644 --- a/contributors/devel/e2e-tests.md +++ b/contributors/devel/e2e-tests.md @@ -3,7 +3,6 @@ Updated: 5/3/2016 **Table of Contents** -<!-- BEGIN MUNGE: GENERATED_TOC --> - [End-to-End Testing in Kubernetes](#end-to-end-testing-in-kubernetes) - [Overview](#overview) @@ -40,7 +39,6 @@ Updated: 5/3/2016 - [Performance Evaluation](#performance-evaluation) - [One More Thing](#one-more-thing) -<!-- END MUNGE: GENERATED_TOC --> ## Overview diff --git a/contributors/devel/gubernator.md b/contributors/devel/gubernator.md index 96155f8d..4e9b3a07 100644 --- a/contributors/devel/gubernator.md +++ b/contributors/devel/gubernator.md @@ -2,7 +2,6 @@ *This document is oriented at developers who want to use Gubernator to debug while developing for Kubernetes.* -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Gubernator](#gubernator) - [What is Gubernator?](#what-is-gubernator) @@ -12,7 +11,6 @@ - [Gubernator for Local Tests](#gubernator-for-local-tests) - [Future Work](#future-work) -<!-- END MUNGE: GENERATED_TOC --> ## What is Gubernator? diff --git a/contributors/devel/how-to-doc.md b/contributors/devel/how-to-doc.md index d6c1dc8a..01c3fb7a 100644 --- a/contributors/devel/how-to-doc.md +++ b/contributors/devel/how-to-doc.md @@ -1,192 +1,5 @@ # Document Conventions -Updated: 11/3/2015 +Updated: 11/3/2017 -*This document is oriented at users and developers who want to write documents -for Kubernetes.* - -**Table of Contents** -<!-- BEGIN MUNGE: GENERATED_TOC --> - -- [Document Conventions](#document-conventions) - - [General Concepts](#general-concepts) - - [How to Get a Table of Contents](#how-to-get-a-table-of-contents) - - [How to Write Links](#how-to-write-links) - - [How to Include an Example](#how-to-include-an-example) - - [Misc.](#misc) - - [Code formatting](#code-formatting) - - [Syntax Highlighting](#syntax-highlighting) - - [Headings](#headings) - - [What Are Mungers?](#what-are-mungers) - - [Auto-added Mungers](#auto-added-mungers) - - [Generate Analytics](#generate-analytics) -- [Generated documentation](#generated-documentation) - -<!-- END MUNGE: GENERATED_TOC --> - -## General Concepts - -Each document needs to be munged to ensure its format is correct, links are -valid, etc. To munge a document, simply run `hack/update-munge-docs.sh`. We -verify that all documents have been munged using `hack/verify-munge-docs.sh`. -The scripts for munging documents are called mungers, see the -[mungers section](#what-are-mungers) below if you're curious about how mungers -are implemented or if you want to write one. - -## How to Write Links - -It's important to follow the rules when writing links. It helps us correctly -versionize documents for each release. - -Use inline links instead of urls at all times. When you add internal links to -`docs/` or `examples/`, use relative links; otherwise, use -`http://releases.k8s.io/HEAD/<path/to/link>`. For example, avoid using: - -``` -[Kubefed](https://github.com/kubernetes/kubernetes/blob/master/docs/admin/kubefed.md) # note that it's under docs/ -[Kubernetes package](../../pkg/) # note that it's under pkg/ -http://kubernetes.io/ # external link -``` - -Instead, use: - -``` -[Kubefed](../admin/kubefed.md) # note that it's under docs/ -[Kubernetes package](http://releases.k8s.io/HEAD/pkg/) # note that it's under pkg/ -[Kubernetes](http://kubernetes.io/) # external link -``` - -The above example generates the following links: -[Kubefed](../admin/kubefed.md), -[Kubernetes package](http://releases.k8s.io/HEAD/pkg/), and -[Kubernetes](http://kubernetes.io/). - -## How to Include an Example - -While writing examples, you may want to show the content of certain example -files (e.g. [pod.yaml](../../test/fixtures/doc-yaml/user-guide/pod.yaml)). In this case, insert the -following code in the md file: - -``` -<!-- BEGIN MUNGE: EXAMPLE path/to/file --> -<!-- END MUNGE: EXAMPLE path/to/file --> -``` - -Note that you should replace `path/to/file` with the relative path to the -example file. Then `hack/update-munge-docs.sh` will generate a code block with -the content of the specified file, and a link to download it. This way, you save -the time to do the copy-and-paste; what's better, the content won't become -out-of-date every time you update the example file. - -For example, the following: - -``` -<!-- BEGIN MUNGE: EXAMPLE ../../test/fixtures/doc-yaml/user-guide/pod.yaml --> -<!-- END MUNGE: EXAMPLE ../../test/fixtures/doc-yaml/user-guide/pod.yaml --> -``` - -generates the following after `hack/update-munge-docs.sh`: - -<!-- BEGIN MUNGE: EXAMPLE ../../test/fixtures/doc-yaml/user-guide/pod.yaml --> - -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: nginx - labels: - app: nginx -spec: - containers: - - name: nginx - image: nginx - ports: - - containerPort: 80 -``` - -[Download example](https://git.k8s.io/kubernetes/test/fixtures/doc-yaml/user-guide/pod.yaml?raw=true) -<!-- END MUNGE: EXAMPLE ../../test/fixtures/doc-yaml/user-guide/pod.yaml --> - -## Misc. - -### Code formatting - -Wrap a span of code with single backticks (`` ` ``). To format multiple lines of -code as its own code block, use triple backticks (```` ``` ````). - -### Syntax Highlighting - -Adding syntax highlighting to code blocks improves readability. To do so, in -your fenced block, add an optional language identifier. Some useful identifier -includes `yaml`, `console` (for console output), and `sh` (for shell quote -format). Note that in a console output, put `$ ` at the beginning of each -command and put nothing at the beginning of the output. Here's an example of -console code block: - -``` -```console - -$ kubectl create -f test/fixtures/doc-yaml/user-guide/pod.yaml -pod "foo" created - -``` -``` - -which renders as: - -```console -$ kubectl create -f test/fixtures/doc-yaml/user-guide/pod.yaml -pod "foo" created -``` - -### Headings - -Add a single `#` before the document title to create a title heading, and add -`##` to the next level of section title, and so on. Note that the number of `#` -will determine the size of the heading. - -## What Are Mungers? - -Mungers are like gofmt for md docs which we use to format documents. To use it, -simply place - -``` -<!-- BEGIN MUNGE: xxxx --> -<!-- END MUNGE: xxxx --> -``` - -in your md files. Note that xxxx is the placeholder for a specific munger. -Appropriate content will be generated and inserted between two brackets after -you run `hack/update-munge-docs.sh`. See -[munger document](http://releases.k8s.io/HEAD/cmd/mungedocs/) for more details. - -## Auto-added Mungers - -After running `hack/update-munge-docs.sh`, you may see some code / mungers in -your md file that are auto-added. You don't have to add them manually. It's -recommended to just read this section as a reference instead of messing up with -the following mungers. - -### Generate Analytics - -ANALYTICS munger inserts a Google Anaylytics link for this page. - -``` -<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> -<!-- END MUNGE: GENERATED_ANALYTICS --> -``` - -# Generated documentation - -Some documents can be generated automatically. Run `hack/generate-docs.sh` to -populate your repository with these generated documents, and a list of the files -it generates is placed in `.generated_docs`. To reduce merge conflicts, we do -not want to check these documents in; however, to make the link checker in the -munger happy, we check in a placeholder. `hack/update-generated-docs.sh` puts a -placeholder in the location where each generated document would go, and -`hack/verify-generated-docs.sh` verifies that the placeholder is in place. - - -<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> -[]() -<!-- END MUNGE: GENERATED_ANALYTICS --> +*Users and developers who want to write documents for Kubernetes can get started [here].(https://github.com/kubernetes/website)*
\ No newline at end of file diff --git a/contributors/devel/kubectl-conventions.md b/contributors/devel/kubectl-conventions.md index d309eab6..c1d54828 100644 --- a/contributors/devel/kubectl-conventions.md +++ b/contributors/devel/kubectl-conventions.md @@ -3,7 +3,6 @@ Updated: 3/23/2017 **Table of Contents** -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Kubectl Conventions](#kubectl-conventions) - [Principles](#principles) @@ -18,7 +17,6 @@ Updated: 3/23/2017 - [Exit code conventions](#exit-code-conventions) - [Generators](#generators) -<!-- END MUNGE: GENERATED_TOC --> ## Principles diff --git a/contributors/devel/pull-requests.md b/contributors/devel/pull-requests.md index 40a7b28a..0f370e56 100644 --- a/contributors/devel/pull-requests.md +++ b/contributors/devel/pull-requests.md @@ -2,7 +2,6 @@ This doc explains the process and best practices for submitting a PR to the [Kubernetes project](https://github.com/kubernetes/kubernetes). It should serve as a reference for all contributors, and be useful especially to new and infrequent submitters. -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Before You Submit a PR](#before-you-submit-a-pr) * [Run Local Verifications](#run-local-verifications) * [Sign the CLA](#sign-the-cla) @@ -26,7 +25,7 @@ This doc explains the process and best practices for submitting a PR to the [Kub * [7. KISS, YAGNI, MVP, etc.](#7-kiss-yagni-mvp-etc) * [8. It's OK to Push Back](#8-its-ok-to-push-back) * [9. Common Sense and Courtesy](#9-common-sense-and-courtesy) -<!-- END MUNGE: GENERATED_TOC --> + # Before You Submit a PR diff --git a/contributors/devel/testing.md b/contributors/devel/testing.md index cca06c81..17cfb812 100644 --- a/contributors/devel/testing.md +++ b/contributors/devel/testing.md @@ -1,7 +1,6 @@ # Testing guide **Table of Contents** -<!-- BEGIN MUNGE: GENERATED_TOC --> - [Testing guide](#testing-guide) - [Unit tests](#unit-tests) @@ -19,7 +18,6 @@ - [Run a specific integration test](#run-a-specific-integration-test) - [End-to-End tests](#end-to-end-tests) -<!-- END MUNGE: GENERATED_TOC --> This assumes you already read the [development guide](development.md) to install go, godeps, and configure your git client. All command examples are diff --git a/contributors/devel/update-release-docs.md b/contributors/devel/update-release-docs.md index 1e0988db..d603b17f 100644 --- a/contributors/devel/update-release-docs.md +++ b/contributors/devel/update-release-docs.md @@ -1,7 +1,5 @@ # Table of Contents -<!-- BEGIN MUNGE: GENERATED_TOC --> - - [Table of Contents](#table-of-contents) - [Overview](#overview) - [Adding a new docs collection for a release](#adding-a-new-docs-collection-for-a-release) @@ -10,7 +8,6 @@ - [Updating docs in release branch](#updating-docs-in-release-branch) - [Updating docs in gh-pages branch](#updating-docs-in-gh-pages-branch) -<!-- END MUNGE: GENERATED_TOC --> # Overview |
