kubernetes/docs/devel
Eric Paris 3b7c39656c Split hack/{verify,update}-* files so we don't always go build
Right now some of the hack/* tools use `go run` and build almost every
time. There are some which expect you to have already run `go install`.
And in all cases the pre-commit hook, which runs a full build wouldn't
want to do either, since it just built!

This creates a new hack/after-build/ directory and has the scripts which
REQUIRE that the binary already be built. It doesn't test and complain.
It just fails miserably. Users should not be in this directory. Users
should just use hack/verify-* which will just do the build and then call
the "after-build" version. The pre-commit hook or anything which KNOWS
the binaries have been built can use the fast version.
2015-08-11 14:20:46 -04:00
..
developer-guides Merge pull request #11551 from a-robinson/docs 2015-07-19 08:45:54 -07:00
api_changes.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
api-conventions.md rewrite all links to issues to k8s links 2015-08-05 21:11:11 -07:00
cherry-picks.md Absolutize links that leave the docs/ tree to go anywhere other than 2015-07-20 00:25:07 -07:00
cli-roadmap.md Gut stale roadmaps. Move useful content elsewhere. 2015-07-18 00:41:06 +00:00
client-libraries.md Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
coding-conventions.md Better scary message 2015-07-17 09:28:49 -07:00
collab.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
development.md Split hack/{verify,update}-* files so we don't always go build 2015-08-11 14:20:46 -04:00
faster_reviews.md Run gendocs 2015-07-17 15:35:43 -07:00
flaky-tests.md Merge pull request #11551 from a-robinson/docs 2015-07-19 08:45:54 -07:00
getting-builds.md Absolutize links that leave the docs/ tree to go anywhere other than 2015-07-20 00:25:07 -07:00
git_workflow.png Consolidate git setup documentation. 2015-06-09 21:11:52 -04:00
instrumentation.md Better scary message 2015-07-17 09:28:49 -07:00
issues.md Better scary message 2015-07-17 09:28:49 -07:00
logging.md Better scary message 2015-07-17 09:28:49 -07:00
making-release-notes.md typofix - https://github.com/vlajos/misspell_fixer 2015-08-08 22:31:48 +01:00
profiling.md Merge pull request #11551 from a-robinson/docs 2015-07-19 08:45:54 -07:00
pull-requests.md Add post v1.0 PR merge details. 2015-08-05 14:52:46 -07:00
README.md Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
releasing.dot Move developer documentation to docs/devel/ 2014-10-15 08:30:02 -07:00
releasing.md Improve devel docs syntax highlighting. 2015-07-19 08:54:49 +00:00
releasing.png Move developer documentation to docs/devel/ 2014-10-15 08:30:02 -07:00
releasing.svg Move developer documentation to docs/devel/ 2014-10-15 08:30:02 -07:00
scheduler_algorithm.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
scheduler.md Absolutize links that leave the docs/ tree to go anywhere other than 2015-07-20 00:25:07 -07:00
writing-a-getting-started-guide.md Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00

WARNING WARNING WARNING WARNING WARNING

PLEASE NOTE: This document applies to the HEAD of the source tree

If you are using a released version of Kubernetes, you should refer to the docs that go with that version.

The latest 1.0.x release of this document can be found [here](http://releases.k8s.io/release-1.0/docs/devel/README.md).

Documentation for other releases can be found at releases.k8s.io.

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 and the Cluster Admin Guide.

The process of developing and contributing code to the Kubernetes project

  • On Collaborative Development (collab.md): Info on pull requests and code reviews.

  • GitHub Issues (issues.md): How incoming issues are reviewed and prioritized.

  • Pull Request Process (pull-requests.md): When and why pull requests are closed.

  • Faster PR reviews (faster_reviews.md): How to get faster PR reviews.

  • Getting Recent Builds (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): Setting up your development environment.

  • Hunting flaky tests (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]: Glog levels.

  • Profiling Kubernetes (profiling.md): How to plug in go pprof profiler to Kubernetes.

  • Instrumenting Kubernetes with a new metric (instrumentation.md): How to add a new metrics to the Kubernetes code base.

  • Coding Conventions (coding-conventions.md): Coding style advice for contributors.

Developing against the Kubernetes API

Writing plugins

Building releases

  • Making release notes (making-release-notes.md): Generating release nodes for a new release.

  • Releasing Kubernetes (releasing.md): How to create a Kubernetes release (as in version) and how the version information gets embedded into the built binaries.

Analytics