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

Add object fields to style guide.

pull/2418/head
steveperry-53 2017-02-03 11:55:13 -08:00
parent e3368b9733
commit 69cc2e60a2
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -17,7 +17,7 @@ docs, follow the instructions on
## Documentation formatting standards ## Documentation formatting standards
### Use Camel Case for API objects ### Use camel case for API objects
When you refer to an API object, use the same uppercase and lowercase letters 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 that are used in the actual object name. Typically, the names of API
@ -75,7 +75,7 @@ represents.
<tr><td>Open the <code>/_data/concepts.yaml</code> file.</td><td>Open the /_data/concepts.yaml file.</td></tr> <tr><td>Open the <code>/_data/concepts.yaml</code> file.</td><td>Open the /_data/concepts.yaml file.</td></tr>
</table> </table>
## Code snippet formatting ## Inline code formatting
### Use code style for inline code and commands ### Use code style for inline code and commands
@ -84,10 +84,31 @@ document, use the backtick (`).
<table> <table>
<tr><th>Do</th><th>Don't</th></tr> <tr><th>Do</th><th>Don't</th></tr>
<tr><td>Set the value of the <code>replicas</code> field in the configuration file.</td><td>Set the value of the "replicas" field in the configuration file.</td></tr>
<tr><td>The <code>kubectl run</code> command creates a Deployment.</td><td>The "kubectl run" command creates a Deployment.</td></tr> <tr><td>The <code>kubectl run</code> command creates a Deployment.</td><td>The "kubectl run" command creates a Deployment.</td></tr>
<tr><td>For declarative management, use <code>kubectl apply</code>.</td><td>For declarative management, use "kubectl apply".</td></tr>
</table> </table>
### Use code style for object field names
<table>
<tr><th>Do</th><th>Don't</th></tr>
<tr><td>Set the value of the <code>replicas</code> field in the configuration file.</td><td>Set the value of the "replicas" field in the configuration file.</td></tr>
<tr><td>The value of the <code>exec</code> field is an ExecAction object.</td><td>The value of the "exec" field is an ExecAction object.</td></tr>
</table>
### Use normal style for string and integer field values
For field values of type string or integer, use normal style without quotation marks.
<table>
<tr><th>Do</th><th>Don't</th></tr>
<tr><td>Set the value of <code>imagePullPolicy</code> to Always.</td><td>Set the value of <code>imagePullPolicy</code> to "Always".</td></tr>
<tr><td>Set the value of <code>image</code> to nginx:1.8.</td><td>Set the value of <code>image</code> to <code>nginx:1.8</code>.</td></tr>
<tr><td>Set the value of the <code>replicas</code> field to 2.</td><td>Set the value of the <code>replicas</code> field to <code>2</code>.</td></tr>
</table>
## Code snippet formatting
### Don't include the command prompt ### Don't include the command prompt
<table> <table>