Files

Mark Maglana fd29104ff5 Fix confusing use of "comprise"

The word "comprise" means "be composed of" or "contain" so
"applications comprised of multiple containers" would mean
"applications composed of of multiple containers" or "applications
contained of multiple containers" which is confusing.

I understand that this is nitpicking and that "comprise" has a new
meaning which is the opposite of its original definition just like
how "literally" now means "figuratively" to some people. However, I
believe that clarity is of utmost importance in technical
documentation which is why I'm proposing this change.

2015-03-25 14:55:34 -07:00

design

Fix confusing use of "comprise"

2015-03-25 14:55:34 -07:00

devel

Add a pointer to kubernetes-dev to API changes doc.

2015-03-25 18:00:52 +00:00

getting-started-guides

Update gce.md OSX instructions per issue #5852

2015-03-25 14:10:04 -04:00

man

Update spf13/cobra with recent commits.

2015-03-23 21:06:45 -07:00

proposals

auto-scaler proposal

2015-03-04 08:53:18 -05:00

accessing_the_api.md

Update ports doc.

2015-02-13 09:18:40 -08:00

accessing-the-cluster.md

Add documentation for redirect

2015-03-04 17:03:18 -08:00

annotations.md

Label documentation improvements. Add annotations documentation.

2014-10-15 22:38:00 +00:00

api-conventions.md

Update error status code documentation a little bit.

2015-03-23 21:13:11 -07:00

architecture.dia

Update architecture diagrams.

2015-03-13 17:16:39 -07:00

architecture.png

Fix architecture diagram

2015-03-15 00:56:31 -07:00

architecture.svg

Update architecture diagrams.

2015-03-13 17:16:39 -07:00

authentication.md

Doc fixes

2015-01-11 21:20:49 -05:00

authorization.md

modify policy to correctly identify resource versus kind

2015-02-04 13:36:01 -05:00

availability.md

simple typo

2015-03-09 13:38:41 +00:00

cli-roadmap.md

CLI roadmap updates.

2015-03-11 22:51:40 +00:00

client-libraries.md

add kubeclient to list of ruby client libraries

2015-03-02 17:43:01 +02:00

cluster_management.md

minor doc modification

2015-03-25 11:16:25 +00:00

cluster-admin-guide.md

Added Quota documentation for Cluster Admins.

2015-03-17 08:33:57 -07:00

container-environment.md

Update docs to reflect reality.

2015-02-02 16:34:20 -08:00

containers.md

Add docker's add/drop capabilites

2015-01-30 15:09:31 +08:00

developer-guide.md

Added Quota documentation for Cluster Admins.

2015-03-17 08:33:57 -07:00

dns.md

Fix link to the dns addon readme

2015-01-24 00:16:36 -08:00

glossary.md

Separated user, dev, and design docs.

2014-10-31 08:35:53 -07:00

identifiers.md

Clarify name must be lowercase in docs, to match code

2015-01-20 13:55:17 -05:00

images.md

update images doc to talk about GCR

2015-02-15 10:29:31 -08:00

kibana.png

Launch Elasticsearch and Kibana automatically

2015-01-09 13:41:46 -08:00

kubeconfig-file.md

Add documentation on legacy kubernetes_auth file to kubeconfig-file.md

2015-03-05 09:33:37 -08:00

kubectl-apiversions.md

Update spf13/cobra with recent commits.

2015-03-23 21:06:45 -07:00

kubectl-clusterinfo.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-config-set-cluster.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-config-set-context.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-config-set-credentials.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-config-set.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-config-unset.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-config-use-context.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-config-view.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-config.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-create.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-delete.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-describe.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-exec.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-expose.md

Update spf13/cobra with recent commits.

2015-03-23 21:06:45 -07:00

kubectl-get.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-label.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-log.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-namespace.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-port-forward.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-proxy.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-resize.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-rollingupdate.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-run-container.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-stop.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-update.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl-version.md

Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation.""

2015-03-23 21:06:45 -07:00

kubectl.md

update docs after update apis

2015-03-17 16:30:53 +00:00

labels.md

Fix confusing use of "comprise"

2015-03-25 14:55:34 -07:00

logging.md

Remove BoundPod structure

2015-03-17 10:27:41 +01:00

namespaces.md

Separated user, dev, and design docs.

2014-10-31 08:35:53 -07:00

networking.md

Add a better networking doc

2015-03-06 16:48:56 -08:00

node.md

Rename ConditionFull->ConditionTrue, ConditionNone->ConditionFalse

2015-03-24 17:28:59 -04:00

overview.md

fix sentence in overview.md

2015-03-16 09:44:13 +05:30

ovs-networking.md

ovs networking document

2014-09-08 17:06:25 -07:00

ovs-networking.png

ovs networking document

2014-09-08 17:06:25 -07:00

pod-states.md

Add a doc on pod states

2014-09-23 08:40:17 -07:00

pods.md

Clarified expectations for pods.

2015-03-12 23:18:07 +00:00

README.md

fix link to kubectl docs in docs/README.md

2015-03-16 08:44:55 +05:30

replication-controller.md

Fix confusing use of "comprise"

2015-03-25 14:55:34 -07:00

resource_quota_admin.md

Added Quota documentation for Cluster Admins.

2015-03-17 08:33:57 -07:00

resources.md

docs: fix ior to or

2015-03-03 14:17:42 -08:00

roadmap.md

Update roadmap.md

2015-02-17 23:09:45 -08:00

salt.md

Typo fix

2014-11-23 02:31:40 +01:00

services_detail.png

Better docs for Services and public IPs.

2015-03-04 22:13:57 -08:00

services_detail.svg

Better docs for Services and public IPs.

2015-03-04 22:13:57 -08:00

services_overview.png

Better docs for Services and public IPs.

2015-03-04 22:13:57 -08:00

services_overview.svg

Better docs for Services and public IPs.

2015-03-04 22:13:57 -08:00

services.md

Fix confusing use of "comprise"

2015-03-25 14:55:34 -07:00

sharing-clusters.md

Add a doc on sharing cluster access credentials via kubeconfig

2015-03-16 15:43:34 -07:00

ui.md

Fix the command in ui.md

2015-02-19 11:37:03 -08:00

user-guide.md

Add a doc on sharing cluster access credentials via kubeconfig

2015-03-16 15:43:34 -07:00

versioning.md

Kube release and API versioning policy

2015-03-16 20:37:14 -07:00

volumes.md

Now that we automatically format GCE PD, remove formatting from the e2e test.

2015-02-06 20:30:58 -08:00

README.md

Kubernetes Documentation

The User's guide is for anyone who wants to run programs and services on an exisiting Kubernetes cluster.
The Cluster Admin's guide is for anyone setting up a Kubernetes cluster or administering it.
The Developer guide is for anyone wanting to write programs that access the kubernetes API, write plugins or extensions, or modify the core code of kubernetes.
The Kubectl Command Line Interface is a detailed reference on the kubectl CLI.
The API object documentation is a detailed description of all fields found in core API objects.
An overview of the Design of Kubernetes
There are example files and walkthroughs in the examples folder.