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.

Sign up for GitHub

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

Capitalized "Pod" in multiple locations #10199

Merged
merged 2 commits into from
Oct 4, 2018
Merged

Capitalized "Pod" in multiple locations #10199

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07c6a2d
Capitalized "Pod" in multiple locations
alex-libre Sep 5, 2018
55f32d2
Capitalized two additional instances of "Pod" as recommended by @neol…
alex-libre Sep 6, 2018
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
14 changes: 7 additions & 7 deletions content/en/docs/contribute/style/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ leads to an awkward construction.
Use angle brackets for placeholders. Tell the reader what a placeholder
represents.

1. Display information about a pod:
1. Display information about a Pod:

kubectl describe pod <pod-name>

where `<pod-name>` is the name of one of your pods.
where `<pod-name>` is the name of one of your Pods.

### Use bold for user interface elements

Expand Down Expand Up @@ -138,7 +138,7 @@ For field values of type string or integer, use normal style without quotation m

### Separate commands from output

Verify that the pod is running on your chosen node:
Verify that the Pod is running on your chosen node:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is also one near the end:
This page teaches you how to use pods.

pods -> Pods.


kubectl get pods --output=wide

Expand All @@ -149,7 +149,7 @@ The output is similar to this:

### Versioning Kubernetes examples

Code examples and configuration examples that include version information should be consistent with the accompanying text.
Code examples and configuration examples that include version information should be consistent with the accompanying text.

If the information is version specific, the Kubernetes version needs to be defined in the `prerequisites` section of the [Task template](/docs/contribute/style/page-templates/#task-template) or the [Tutorial template] (/docs/contribute/style/page-templates/#tutorial-template). Once the page is saved, the `prerequisites` section is shown as **Before you begin**.

Expand Down Expand Up @@ -194,7 +194,7 @@ Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create d
1. Surround the text with an opening and closing shortcode.

2. Use the following syntax to apply a style:

```
{{</* note */>}}
**Note:** The prefix you use is the same text you use in the tag.
Expand All @@ -213,7 +213,7 @@ The output is:
Use {{</* note */>}} to highlight a tip or a piece of information that may be helpful to know.

For example:

```
{{</* note */>}}
**Note:** You can _still_ use Markdown inside these callouts.
Expand Down Expand Up @@ -364,7 +364,7 @@ whether they're part of the "we" you're describing.
<tr><th>Do</th><th>Don't</th></tr>
<tr><td>Version 1.4 includes ...</td><td>In version 1.4, we have added ...</td></tr>
<tr><td>Kubernetes provides a new feature for ...</td><td>We provide a new feature ...</td></tr>
<tr><td>This page teaches you how to use pods.</td><td>In this page, we are going to learn about pods.</td></tr>
<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
Expand Down