Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Import kubernetes/community docs #6863

Merged
merged 19 commits into from
Jan 11, 2018
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,4 @@ tocs:
- reference
- samples
- search
- imported
1 change: 1 addition & 0 deletions _data/globals.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ tocs:
- reference
- samples
- support
- imported
11 changes: 11 additions & 0 deletions _data/imported.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
bigheader: "Imported Docs"
abstract: "Docs imported from other Kubernetes SIGs and repos."
toc:
- docs/imported/index.md

- title: Community
section:
- docs/imported/community/guide.md
- docs/imported/community/devel.md
- docs/imported/community/mentoring.md
- docs/imported/community/keps.md
80 changes: 80 additions & 0 deletions docs/imported/community/devel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: 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](http://kubernetes.io/docs/user-guide/) and the [Cluster Admin
Guide](http://kubernetes.io/docs/admin/).


## The process of developing and contributing code to the Kubernetes project

* **Contributor Guide**
([Please start here](/contributors/guide/README.md)) to learn about how to contribute to Kubernetes

* **GitHub Issues** ([issues.md](issues.md)): How incoming issues are triaged.

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

* **Getting Recent Builds** ([getting-builds.md](getting-builds.md)): How to get recent builds including the latest builds that pass CI.

* **Automated Tools** ([automation.md](automation.md)): Descriptions of the automation that is running on our github repository.


## Setting up your dev environment, coding, and debugging

* **Development Guide** ([development.md](development.md)): Setting up your development environment.

* **Testing** ([testing.md](testing.md)): How to run unit, integration, and end-to-end tests in your development sandbox.

* **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.

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

* **Coding Conventions** ([coding-conventions.md](coding-conventions.md)):
Coding style advice for contributors.

* **Document Conventions** ([how-to-doc.md](how-to-doc.md))
Document style advice for contributors.

* **Running a cluster locally** ([running-locally.md](running-locally.md)):
A fast and lightweight local cluster deployment for development.

## Developing against the Kubernetes API

* The [REST API documentation](http://kubernetes.io/docs/reference/) explains the REST
API exposed by apiserver.

* **Annotations** ([Annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)): 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** ([Authentication](http://kubernetes.io/docs/admin/authentication/)):
The current and planned states of authentication tokens.

* **Authorization Plugins** ([Authorization](http://kubernetes.io/docs/admin/authorization/)):
Authorization applies to all HTTP requests on the main apiserver port.
This doc explains the available authorization implementations.

* **Admission Control Plugins** ([admission_control](/contributors/design-proposals/api-machinery/admission_control.md))


## Building releases

See the [kubernetes/release](https://github.com/kubernetes/release) repository for details on creating releases and related tools and helper scripts.
248 changes: 248 additions & 0 deletions docs/imported/community/guide.md

Large diffs are not rendered by default.

Loading