Commit Graph

694 Commits

Author SHA1 Message Date
Michelle Noorali 7b116eb611 refactor: isolate docs/devel for move 2016-11-30 14:41:44 -05:00
Brandon Philips fdd5fb4c16 docs: devel: point people at place for OWNERS status
All of the tracking is happening here https://github.com/kubernetes/contrib/issues/1389 point people at it.
2016-11-29 13:13:05 -08:00
Brandon Philips 593222e8c0 docs: devel: describe the current state of adding approvers
Document that we are currently holding off on adding new approvers until
the reviewers process is in place. And set a target deadline.
2016-11-29 13:13:05 -08:00
Kubernetes Submit Queue 81e80e1cb6 Merge pull request #37367 from nebril/e2e-doc-typo-falure
Automatic merge from submit-queue

Fix typo in e2e tests doc
2016-11-28 16:53:10 -08:00
Kubernetes Submit Queue 327e24c67c Merge pull request #36699 from k82cn/update_bazel
Automatic merge from submit-queue

Added comments on running update-bazel.sh in "$GOPATH/src/k8s.io/kubernetes"

**What this PR does / why we need it**:

This path made `hack/update-bazel.sh` to accept `$GOPATH` with multiple path.
2016-11-28 11:43:45 -08:00
Kubernetes Submit Queue 2dd453a558 Merge pull request #36634 from thockin/reviewable-doc
Automatic merge from submit-queue

Add reviewable notes to CONTRIBUTING

@kubernetes/contributor-experience
2016-11-28 11:43:16 -08:00
Kubernetes Submit Queue 9fb8b6a191 Merge pull request #36717 from xialonglee/update-bazel.md
Automatic merge from submit-queue

update gazel usage in bazel.md

**What this PR does / why we need it**:
Now run the newest gazel have to specify the '-root' argument to update a single BUILD file.
So updated the gazel usage.
2016-11-28 11:42:30 -08:00
Maciej Kwiek a08221e389 Fix typo in e2e tests doc 2016-11-23 10:52:04 +01:00
Yu-Ju Hong b7279dbb2e Add a known issue in the CRI doc 2016-11-22 17:56:38 -08:00
Yu-Ju Hong b682c74db5 Add a CRI doc for developers
This doc includes basic instructions to use CRI and the current status. It does
not include the formal requirements for CRI, which should be documented
separately.
2016-11-22 14:18:12 -08:00
Marcin Owsiany f9cb189988 Fix quoting of $PATH in instructions. 2016-11-18 09:21:28 +01:00
Kubernetes Submit Queue 8b07499d77 Merge pull request #36817 from skippbox/readme
Automatic merge from submit-queue

improve readme for contributor experience

**What this PR does / why we need it**:

This improves the top-level README. Removes broken links, removes links to make you bounce to another page, adds proper links to docs.
Shuffles things around a bit and improves reading.

@kubernetes/contributor-experience
2016-11-17 21:30:00 -08:00
sebgoa 062ade7009 fix munge-docs build errors 2016-11-17 16:49:00 +01:00
Klaus Ma b55f78fbe8 Added comments on running update-bazel.sh in /Users/klaus/Workspace/go-tools/src/k8s.io/kubernetes. 2016-11-17 10:48:04 +08:00
Erick Fejta 07c8d2dc40 Delete gotest-dockerized 2016-11-15 13:11:04 -08:00
Kubernetes Submit Queue 5ee19a2f16 Merge pull request #36800 from mdshuai/update-cgroups-per-qos
Automatic merge from submit-queue

[kubelet]update some --cgroups-per-qos to --experimental-cgroups-per-qos

Follow https://github.com/kubernetes/kubernetes/pull/36767, there are some fields still need update in docs or hack/local-up-cluster.sh
2016-11-15 08:54:29 -08:00
mdshuai 676cabf17b [kubelet]update --cgroups-per-qos to --experimental-cgroups-per-qos 2016-11-15 15:55:47 +08:00
xialong.lee 6272791a04 update gazel usage in bazel.md 2016-11-13 18:27:41 +08:00
Tim Hockin 8dc9c4ddcc Add reviewable notes to CONTRIBUTING 2016-11-10 23:47:13 -08:00
Brandon Philips 4462ce9599 kubectl: add less verbose version
The kubectl version output is very complex and makes it hard for users
and vendors to give actionable information. For example during the
recent Kubernetes 1.4.3 TLS security scramble I had to write a one-liner
for users to get out the version number to give to figure out if they
are vulnerable:

    $ kubectl version | grep -i Server | sed  -n 's%.*GitVersion:"\([^"]*\).*%\1%p'

Instead this patch outputs simply output with `--short`

    ./kubectl version --short
    Client Version: v1.4.3
    Server Version: v1.4.3
2016-11-10 14:07:42 -08:00
Jimmy Cuadra 76480357f5 Rename PetSet to StatefulSet in docs and examples. 2016-11-05 00:17:28 -07:00
Kubernetes Submit Queue a12debe465 Merge pull request #31546 from derekwaynecarr/systemd-pod-cgroups
Automatic merge from submit-queue

pod and qos level cgroup support

```release-note
[Kubelet] Add alpha support for `--cgroups-per-qos` using the configured `--cgroup-driver`. Disabled by default.
```
2016-11-03 03:56:56 -07:00
Saad Ali 972cbd71dc Fix typo in docs/devel/godep.md 2016-11-02 19:07:35 -07:00
derekwaynecarr 8ba3623424 pod and qos level cgroup support 2016-11-02 08:07:04 -04:00
Chao Xu 8a3536fe9b remove release_1_4
remove archived federation clientsets
update README
2016-10-31 15:05:26 -07:00
Tim Hockin 4b33176486 versionize-docs is dead 2016-10-26 00:06:59 +02:00
Tim Hockin 685bbf54c2 Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
Mike Danese e7c50a8122 rename build/ to build-tools/ 2016-10-24 14:41:56 -07:00
Clayton Coleman 1b3c1c71fc Clarify backwards and forwards compatibility in docs
We weren't necessarily clear that we consider both required.
2016-10-24 12:04:39 -04:00
Mike Danese e7c5a242ee add some docs about building with bazel 2016-10-21 17:32:33 -07:00
Kubernetes Submit Queue 2e7b09eaa8 Merge pull request #35085 from xilabao/fix-testing-against-local-clusters
Automatic merge from submit-queue

check_node_count falls out of use, clear from docs/devel/e2e-tests.md

delete "--check_node_count " for testing against local clusters
2016-10-20 00:08:05 -07:00
xilabao 7d98197e2e check_node_count falls out of use, clear from docs 2016-10-19 11:04:36 +08:00
deads2k bc658b7546 recommendations for writing controllers 2016-10-18 09:02:44 -04:00
Kubernetes Submit Queue 75b3188efc Merge pull request #34502 from fabianofranz/cli_usability_improvements
Automatic merge from submit-queue

Improvements to CLI usability and maintainability

Improves `kubectl` from an usability perspective by

1. Fixing how we handle terminal width in help. Some sections like the flags use the entire available width, while others like long descriptions breaks lines but don't follow a well established max width (screenshot below). This PR adds a new responsive writer that will adjust to terminal width and set 80, 100, or 120 columns as the max width, but not more than that given POSIX best practices and recommendations for better readability.
![terminal_width](https://cloud.githubusercontent.com/assets/158611/19253184/b23a983e-8f1f-11e6-9bae-667dd5981485.png)
2. Adds our own normalizers for long descriptions and cmd examples which allows us better control about how things like lists, paragraphs, line breaks, etc are printed. Features markdown support. Looks like `templates.LongDesc` and `templates.Examples` instead of `dedent.Dedend`.
3. Allows simple reordering and reuse of help and usage sections.
3. Adds `verify-cli-conventions.sh` which intends to run tests to make sure cmd developers are using what we propose as [kubectl conventions](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/kubectl-conventions.md). Just a couple simple tests for now but the framework is there and it's easy to extend.
4. Update [kubectl conventions](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/kubectl-conventions.md) to use our own normalizers instead of `dedent.Dedent`.

**Release note**:
<!--  Steps to write your release note:
1. Use the release-note-* labels to set the release note state (if you have access) 
2. Enter your extended release note in the below block; leaving it blank means using the PR title as the release note. If no release note is required, just write `NONE`. 
-->
```release-note
Improves how 'kubectl' uses the terminal size when printing help and usage.
```

@kubernetes/kubectl
2016-10-17 23:41:23 -07:00
Euan Kemp d86f445b5e local-up: Add option to guess binary path 2016-10-17 11:55:29 -07:00
Fabiano Franz 04122e99c6 Use our own normalizers in the conventions doc 2016-10-17 11:50:02 -02:00
Kubernetes Submit Queue 83de8a4818 Merge pull request #34239 from gnufied/update-e2e-docs
Automatic merge from submit-queue

Update documentation for running e2e tests locally

**What this PR does / why we need it**:

The docs for running e2e tests locally needs to be updated.
check_node_count option has been removed and developers usually
need to perform additional steps do get it going.
2016-10-09 17:46:10 -07:00
Hemant Kumar 2c0e8827a1 Update documentation for running e2e tests locally
The docs for running e2e tests locally needs to be updated.
check_node_count option has been removed and developers usually
need to perform additional steps do get it going.
2016-10-06 10:51:49 -04:00
Minhan Xia 7f93584615 add delete-namespace-on-failure flag 2016-10-03 17:14:51 -07:00
Brendan Burns 0bb9abbaaa Add community expectations about conduct and reviewing. 2016-09-30 15:35:15 +00:00
mbohlool c94f28aad0 Generate and verify openapi specs in source tree at api/openapi-spec 2016-09-29 17:03:31 -07:00
Doug Davis 7b171dc2bb Change minion to node
Contination of #1111

I tried to keep this PR down to just a simple search-n-replace to keep
things simple.  I may have gone too far in some spots but its easy to
roll those back if needed.

I avoided renaming `contrib/mesos/pkg/minion` because there's already
a `contrib/mesos/pkg/node` dir and fixing that will require a bit of work
due to a circular import chain that pops up. So I'm saving that for a
follow-on PR.

I rolled back some of this from a previous commit because it just got
to big/messy. Will follow up with additional PRs

Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-09-28 10:53:30 -07:00
Eric Paris 013e57360e Merge pull request #33200 from sc68cal/patch-1
Delete vagrant.md
2016-09-27 19:40:49 -04:00
Sean M. Collins 8bcaa28e2c Delete vagrant.md
The link[1] 404's and most of the documentation now suggests[2] using
minikube for running a kubernetes cluster locally

[1]: http://kubernetes.github.io/docs/getting-started-guides/vagrant/
[2]: http://kubernetes.io/docs/getting-started-guides/#local-machine-solutions
2016-09-27 17:02:14 -04:00
YuPengZTE fec46af679 The VS and dot is seprated
Signed-off-by: YuPengZTE <yu.peng36@zte.com.cn>
2016-09-26 17:05:53 +08:00
Joe Finney 3e034b6583 Make e2e.go give us JUnit results. 2016-09-22 18:40:53 -07:00
jayunit100 eb797e756d viper hierarchies, cadvisor impl 2016-09-20 15:42:22 -04:00
Davanum Srinivas 19d5af9961 Extend all to more resources
Added more things from the list here:
https://github.com/kubernetes/kubernetes/blob/master/pkg/kubectl/cmd/cmd.go#L159

Update the devel/kubectl-conventions.md with the rules mentioned by
a few folks on which resources could be added to the special 'all' alias
2016-09-19 13:01:59 -04:00
Kubernetes Submit Queue eea3d12f23 Merge pull request #32788 from philips/add-flakes-test-docs
Automatic merge from submit-queue

docs: devel: tell people how to find flake tests
2016-09-15 08:51:05 -07:00
Brandon Philips 1a17e61b5a docs: devel: tell people how to find flake tests
This doc talks about flake tests but never links to all of them. Fix
this so people can dive in.
2016-09-15 06:37:53 -07:00