summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Tune <etune@google.com>2015-07-15 12:52:57 -0700
committerEric Tune <etune@google.com>2015-07-15 12:52:57 -0700
commitcc1de7d336a28a4d29eb57a446654a14b7d2509d (patch)
treefcfff6c2f861c05241e0fa7286b1bba5015bea33
parentb6ca2b5bd605d4e65096d3cc2999f4d59d1f1495 (diff)
parent3a1db27f1f46e9276c6b1aa28b82d0793f1e0db2 (diff)
Merge pull request #11292 from davidopp/doc1
Move diagrams out of top-level docs/ directory and merge
-rw-r--r--README.md66
-rw-r--r--developer-guide.md62
2 files changed, 52 insertions, 76 deletions
diff --git a/README.md b/README.md
index f97c49b4..aed7276d 100644
--- a/README.md
+++ b/README.md
@@ -20,27 +20,35 @@ certainly want the docs that go with that version.</h1>
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
-# Developing Kubernetes
+# Kubernetes Developer Guide
-Docs in this directory relate to developing Kubernetes.
+The developer guide is for anyone wanting to either write code which directly accesses the
+kubernetes API, or to contribute directly to the kubernetes project.
+It assumes some familiarity with concepts in the [User Guide](../user-guide/README.md) and the [Cluster Admin
+Guide](../admin/README.md).
-* **On Collaborative Development** ([collab.md](collab.md)): info on pull requests and code reviews.
-* **Development Guide** ([development.md](development.md)): Setting up your environment tests.
+## The process of developing and contributing code to the Kubernetes project
-* **Making release notes** ([making-release-notes.md](making-release-notes.md)): Generating release nodes for a new release.
-
-* **Hunting flaky tests** ([flaky-tests.md](flaky-tests.md)): We have a goal of 99.9% flake free tests.
- Here's how to run your tests many times.
+* **On Collaborative Development** ([collab.md](collab.md)): Info on pull requests and code reviews.
* **GitHub Issues** ([issues.md](issues.md)): How incoming issues are reviewed and prioritized.
-* **Logging Conventions** ([logging.md](logging.md)]: Glog levels.
-
* **Pull Request Process** ([pull-requests.md](pull-requests.md)): When and why pull requests are closed.
-* **Releasing Kubernetes** ([releasing.md](releasing.md)): How to create a Kubernetes release (as in version)
- and how the version information gets embedded into the built binaries.
+* **Faster PR reviews** ([faster_reviews.md](faster_reviews.md)): How to get faster PR reviews.
+
+* **Getting Recent Builds** ([getting-builds.md](getting-builds.md)): How to get recent builds including the latest builds that pass CI.
+
+
+## Setting up your dev environment, coding, and debugging
+
+* **Development Guide** ([development.md](development.md)): Setting up your development environment.
+
+* **Hunting flaky tests** ([flaky-tests.md](flaky-tests.md)): We have a goal of 99.9% flake free tests.
+ Here's how to run your tests many times.
+
+* **Logging Conventions** ([logging.md](logging.md)]: Glog levels.
* **Profiling Kubernetes** ([profiling.md](profiling.md)): How to plug in go pprof profiler to Kubernetes.
@@ -51,9 +59,39 @@ Docs in this directory relate to developing Kubernetes.
* **Coding Conventions** ([coding-conventions.md](coding-conventions.md)):
Coding style advice for contributors.
-* **Faster PR reviews** ([faster_reviews.md](faster_reviews.md)): How to get faster PR reviews.
-* **Getting Recent Builds** ([getting-builds.md](getting-builds.md)): How to get recent builds including the latest builds to pass CI.
+## Developing against the Kubernetes API
+
+* API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).
+
+* **Annotations** ([docs/user-guide/annotations.md](../user-guide/annotations.md)): are for attaching arbitrary non-identifying metadata to objects.
+ Programs that automate Kubernetes objects may use annotations to store small amounts of their state.
+
+* **API Conventions** ([api-conventions.md](api-conventions.md)):
+ Defining the verbs and resources used in the Kubernetes API.
+
+* **API Client Libraries** ([client-libraries.md](client-libraries.md)):
+ A list of existing client libraries, both supported and user-contributed.
+
+
+## Writing plugins
+
+* **Authentication Plugins** ([docs/admin/authentication.md](../admin/authentication.md)):
+ The current and planned states of authentication tokens.
+
+* **Authorization Plugins** ([docs/admin/authorization.md](../admin/authorization.md)):
+ Authorization applies to all HTTP requests on the main apiserver port.
+ This doc explains the available authorization implementations.
+
+* **Admission Control Plugins** ([admission_control](../design/admission_control.md))
+
+
+## Building releases
+
+* **Making release notes** ([making-release-notes.md](making-release-notes.md)): Generating release nodes for a new release.
+
+* **Releasing Kubernetes** ([releasing.md](releasing.md)): How to create a Kubernetes release (as in version)
+ and how the version information gets embedded into the built binaries.
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
diff --git a/developer-guide.md b/developer-guide.md
deleted file mode 100644
index 8801cb3d..00000000
--- a/developer-guide.md
+++ /dev/null
@@ -1,62 +0,0 @@
-<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
-
-<!-- BEGIN STRIP_FOR_RELEASE -->
-
-![WARNING](http://kubernetes.io/img/warning.png)
-![WARNING](http://kubernetes.io/img/warning.png)
-![WARNING](http://kubernetes.io/img/warning.png)
-
-<h1>PLEASE NOTE: This document applies to the HEAD of the source
-tree only. If you are using a released version of Kubernetes, you almost
-certainly want the docs that go with that version.</h1>
-
-<strong>Documentation for specific releases can be found at
-[releases.k8s.io](http://releases.k8s.io).</strong>
-
-![WARNING](http://kubernetes.io/img/warning.png)
-![WARNING](http://kubernetes.io/img/warning.png)
-![WARNING](http://kubernetes.io/img/warning.png)
-
-<!-- END STRIP_FOR_RELEASE -->
-
-<!-- END MUNGE: UNVERSIONED_WARNING -->
-# Kubernetes Developer Guide
-
-The developer guide is for anyone wanting to either write code which directly accesses the
-kubernetes API, or to contribute directly to the kubernetes project.
-It assumes some familiarity with concepts in the [User Guide](../user-guide/README.md) and the [Cluster Admin
-Guide](../admin/README.md).
-
-
-## Developing against the Kubernetes API
-
-* API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).
-
-* **Annotations** ([docs/user-guide/annotations.md](../user-guide/annotations.md)): are for attaching arbitrary non-identifying metadata to objects.
- Programs that automate Kubernetes objects may use annotations to store small amounts of their state.
-
-* **API Conventions** ([api-conventions.md](api-conventions.md)):
- Defining the verbs and resources used in the Kubernetes API.
-
-* **API Client Libraries** ([client-libraries.md](client-libraries.md)):
- A list of existing client libraries, both supported and user-contributed.
-
-## Writing Plugins
-
-* **Authentication Plugins** ([docs/admin/authentication.md](../admin/authentication.md)):
- The current and planned states of authentication tokens.
-
-* **Authorization Plugins** ([docs/admin/authorization.md](../admin/authorization.md)):
- Authorization applies to all HTTP requests on the main apiserver port.
- This doc explains the available authorization implementations.
-
-* **Admission Control Plugins** ([admission_control](../design/admission_control.md))
-
-## Contributing to the Kubernetes Project
-
-See this [README](README.md).
-
-
-<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/devel/developer-guide.md?pixel)]()
-<!-- END MUNGE: GENERATED_ANALYTICS -->