kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #1840 from devin-donnelly/release-1.5 

Merge latest from Master to Release 1.5
reviewable/pr1757/r7
devin-donnelly 2016-12-01 15:52:44 -08:00 committed by GitHub
parent c7bead191d c9d4f9a29f
commit e511d881f9
6 changed files with 62 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_includes/head-header.html
View File

@ -13,6 +13,7 @@
<script src="/js/jquery-ui.min.js"></script>
<script src="/js/script.js"></script>
<script src="/js/sweetalert.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<title>Kubernetes - {{ title }}</title>
</head>
<body>

55
docs/contribute/style-guide.md
View File

@ -14,20 +14,31 @@ docs, follow the instructions on
{% capture body %}
## Documentation formatting standards
### Documentation formatting standards
### Capitalize API objects
#### Use Camel Case for API objects
Capitalize the names of API objects. Refer to API objects without saying
"object."
When you refer to an API object, use the same uppercase and lowercase letters
that are used in the actual object name. Typically, the names of API
objects use
[camel case](https://en.wikipedia.org/wiki/Camel_case).
Don't split the API object name into separate words. For example, use
PodTemplateList, not Pod Template List.
Refer to API objects without saying "object," unless omitting "object"
leads to an awkward construction.
<table>
<tr><th>Do</th><th>Don't</th></tr>
<tr><td>The Pod has two Containers.</td><td>The pod has two containers.</td></tr>
<tr><td>The Deployment is responsible for ...</td><td>The Deployment object is responsible for ...</td></tr>
<tr><td>A PodList is a list of Pods.</td><td>A Pod List is a list of pods.</td></tr>
<tr><td>The two ContainerPorts ...</td><td>The two ContainerPort objects ...</td></tr>
<tr><td>The two ContainerStateTerminated objects ...</td><td>The two ContainerStateTerminateds ...</td></tr>
</table>
### Use angle brackets for placeholders
#### Use angle brackets for placeholders
Use angle brackets for placeholders. Tell the reader what a placeholder
represents.
@ -38,7 +49,7 @@ represents.
where `<pod-name>` is the name of one of your pods.
### Use bold for user interface elements
#### Use bold for user interface elements
<table>
<tr><th>Do</th><th>Don't</th></tr>
@ -46,7 +57,7 @@ represents.
<tr><td>Select <b>Other</b>.</td><td>Select 'Other'.</td></tr>
</table>
### Use italics to define or introduce new terms
#### Use italics to define or introduce new terms
<table>
<tr><th>Do</th><th>Don't</th></tr>
@ -54,7 +65,7 @@ represents.
<tr><td>These components form the <i>control plane.</i></td><td>These components form the <b>control plane.</b></td></tr>
</table>
### Use code style for filenames, directories, and paths
#### Use code style for filenames, directories, and paths
<table>
<tr><th>Do</th><th>Don't</th></tr>
@ -63,9 +74,9 @@ represents.
<tr><td>Open the <code>/_data/concepts.yaml</code> file.</td><td>Open the /_data/concepts.yaml file.</td></tr>
</table>
## Code snippet formatting
### Code snippet formatting
### Use code style for inline code and commands
#### Use code style for inline code and commands
For inline code in an HTML document, use the `<code>` tag. In a Markdown
document, use the backtick (`).
@ -76,14 +87,14 @@ document, use the backtick (`).
<tr><td>The <code>kubectl run</code> command creates a Deployment.</td><td>The "kubectl run" command creates a Deployment.</td></tr>
</table>
### Don't include the command prompt
#### Don't include the command prompt
<table>
<tr><th>Do</th><th>Don't</th></tr>
<tr><td>kubectl get pods</td><td>$ kubectl get pods</td></tr>
</table>
### Separate commands from output
#### Separate commands from output
Verify that the pod is running on your chosen node:
@ -105,11 +116,11 @@ A list of Kubernetes-specific terms and words to be used consistently across the
</table>{% endcomment %}
## Content best practices
### Content best practices
This section contains suggested best practices for clear, concise, and consistent content.
### Use present tense
#### Use present tense
<table>
<tr><th>Do</th><th>Don't</th></tr>
@ -119,7 +130,7 @@ This section contains suggested best practices for clear, concise, and consisten
Exception: Use future or past tense if it is required to convey the correct
meaning.
### Use active voice
#### Use active voice
<table>
<tr><th>Do</th><th>Don't</th></tr>
@ -129,7 +140,7 @@ meaning.
Exception: Use passive voice if active voice leads to an awkward construction.
### Use simple and direct language
#### Use simple and direct language
Use simple and direct language. Avoid using unnecessary phrases, such as saying "please."
@ -141,7 +152,7 @@ Use simple and direct language. Avoid using unnecessary phrases, such as saying
</table>
### Address the reader as "you"
#### Address the reader as "you"
<table>
<tr><th>Do</th><th>Don't</th></tr>
@ -149,9 +160,9 @@ Use simple and direct language. Avoid using unnecessary phrases, such as saying
<tr><td>In the preceding output, you can see...</td><td>In the preceding output, we can see ...</td></tr>
</table>
## Patterns to avoid
### Patterns to avoid
### Avoid using "we"
#### Avoid using "we"
Using "we" in a sentence can be confusing, because the reader might not know
whether they're part of the "we" you're describing.
@ -163,7 +174,7 @@ whether they're part of the "we" you're describing.
<tr><td>This page teaches you how to use pods.</td><td>In this page, we are going to learn about pods.</td></tr>
</table>
### Avoid jargon and idioms
#### Avoid jargon and idioms
Some readers speak English as a second language. Avoid jargon and idioms to help make their understanding easier.
@ -173,13 +184,13 @@ Some readers speak English as a second language. Avoid jargon and idioms to help
<tr><td>Create a new cluster.</td><td>Turn up a new cluster.</td></tr>
</table>
### Avoid statements about the future
#### Avoid statements about the future
Avoid making promises or giving hints about the future. If you need to talk about
an alpha feature, put the text under a heading that identifies it as alpha
information.
### Avoid statements that will soon be out of date
#### Avoid statements that will soon be out of date
Avoid words like "currently" and "new." A feature that is new today might not be
considered new in a few months.

7
docs/troubleshooting.md
View File

@ -59,6 +59,13 @@ interest. For example, people new to Kubernetes may also want to join the
`#kubernetes-novice` channel. As another example, developers should join the
`#kubernetes-dev` channel.
There are also many country specific/local language channels. Feel free to join
these channels for localized support and info:
- France: `#fr-users`, `#fr-events`
- Germany: `#de-users`, `#de-events`
- Japan: `#jp-users`, `#jp-events`
### Mailing List
The Kubernetes / Google Container Engine mailing list is [kubernetes-users@googlegroups.com](https://groups.google.com/forum/#!forum/kubernetes-users)

24
docs/user-guide/containers.md
View File

@ -14,8 +14,8 @@ should run in a container. In this case, Kubernetes runs the image's default co
to run a particular command or override the image's defaults, there are two additional fields that
we can use:
1. `Command`: Controls the actual command run by the image
2. `Args`: Controls the arguments passed to the command
1. `command`: Controls the actual command run by the image
2. `args`: Controls the arguments passed to the command
### How docker handles command and arguments
@ -28,20 +28,20 @@ fields as either a string array or a string and there are subtle differences in
handled. We encourage the curious to check out Docker's documentation for this feature.
Kubernetes allows you to override both the image's default command (docker `Entrypoint`) and args
(docker `Cmd`) with the `Command` and `Args` fields of `Container`. The rules are:
(docker `Cmd`) with the `command` and `args` fields of `container`. The rules are:
1. If you do not supply a `Command` or `Args` for a container, the defaults defined by the image
will be used
2. If you supply a `Command` but no `Args` for a container, only the supplied `Command` will be
used; the image's default arguments are ignored
3. If you supply only `Args`, the image's default command will be used with the arguments you
supply
4. If you supply a `Command` **and** `Args`, the image's defaults will be ignored and the values
you supply will be used
1. If you do not supply a `command` or `args` for a container, the defaults defined by the image
will be used.
2. If you supply a `command` but no `args` for a container, only the supplied `command` will be
used; the image's default arguments are ignored.
3. If you supply only `args`, the image's default command will be used with the arguments you
supply.
4. If you supply a `command` **and** `args`, the image's defaults will be ignored and the values
you supply will be used.
Here are examples for these rules in table format
| Image `Entrypoint` | Image `Cmd` | Container `Command` | Container `Args` | Command Run |
| Image `Entrypoint` | Image `Cmd` | Container `command` | Container `args` | Command Run |
|--------------------|------------------|---------------------|--------------------|------------------|
| `[/ep-1]` | `[foo bar]` | &lt;not set&gt; | &lt;not set&gt; | `[ep-1 foo bar]` |
| `[/ep-1]` | `[foo bar]` | `[/ep-2]` | &lt;not set&gt; | `[ep-2]` |

4
docs/user-guide/federation/secrets.md
View File

@ -50,7 +50,7 @@ a matching secret in all underlying kubernetes clusters.
You can verify this by checking each of the underlying clusters, for example:
``` shell
kubectl --context=gce-asia-east1a get rs myrs
kubectl --context=gce-asia-east1a get secret mysecret
```
The above assumes that you have a context named 'gce-asia-east1a'
@ -77,7 +77,7 @@ the federation apiserver instead of sending it to a specific Kubernetes cluster.
For example, you can do that using kubectl by running:
```shell
kubectl --context=federation-cluster delete rs myrs
kubectl --context=federation-cluster delete secret mysecret
```
Note that at this point, deleting a federated secret will not delete the

7
js/bootstrap.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long