Use consistent case for Job #12603
Merged
Use consistent case for Job #12603
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
cncf-cla: yes
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit d0e9121 https://deploy-preview-12603--kubernetes-io-master-staging.netlify.com |
soltysh
suggested changes
Feb 12, 2019
content/en/docs/concepts/workloads/controllers/jobs-run-to-completion.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/workloads/controllers/jobs-run-to-completion.md
Outdated
Show resolved
Hide resolved
| 1. Parallel Jobs with a *fixed completion count*: | ||
| - specify a non-zero positive value for `.spec.completions`. | ||
| - the job is complete when there is one successful pod for each value in the range 1 to `.spec.completions`. | ||
| - **not implemented yet:** Each pod passed a different index in the range 1 to `.spec.completions`. | ||
| - the overall task is complete when there is one successful Pod for each value in the range 1 to `.spec.completions`. |
There was a problem hiding this comment.
I'm keen for the reader to get the idea that there's an overall piece of work represented by the Job. Usings might be coming from other systems where “job” could mean a batch from a larger pool, or a even a single element inside a batch.
I'll see if I can make some wording that to reinforce that, without losing the link to the Job concept in a Kubernetes sense.
|
How about this revised approach? |
soltysh
approved these changes
Feb 13, 2019
| of successful completions is reached, the job itself is complete. Deleting a Job will cleanup the | ||
| pods it created. | ||
| A Job creates one or more pods and ensures that a specified number of them successfully terminate. | ||
| As pods successfully complete, the Job tracks the successful completions. When a specified number |
There was a problem hiding this comment.
Do you want to fix Pod casing throughout this doc too?
There was a problem hiding this comment.
To me this reads better using pod in lowercase where using the term more loosely. It comes down to a matter of style and taste, I think.
- Use “Job” to mean the Kubernetes object - Use “job” where capitalization hinders readability - Use “task”, or other synonymous concepts, to avoid confusion - Use “Pod” to mean the Kubernetes object - Use “pod” where capitalization hinders readability - Use “container” in lowercase everywhere Also: - Clarify work queue example for Job controller - Fix advice on running Job example - Tweak emphasis
sftim
force-pushed
the
job_consistent_case
branch
from
7bab99e to
d0e9121
Compare
|
Squashed & force-pushed |
|
/approve |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: zparnold The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
kwiesmueller
pushed a commit
to kwiesmueller/website
that referenced
this pull request
Feb 28, 2019
- Use “Job” to mean the Kubernetes object - Use “job” where capitalization hinders readability - Use “task”, or other synonymous concepts, to avoid confusion - Use “Pod” to mean the Kubernetes object - Use “pod” where capitalization hinders readability - Use “container” in lowercase everywhere Also: - Clarify work queue example for Job controller - Fix advice on running Job example - Tweak emphasis
|
Thanks, @sftim ! |
krmayankk
pushed a commit
to krmayankk/kubernetes.github.io
that referenced
this pull request
Mar 11, 2019
- Use “Job” to mean the Kubernetes object - Use “job” where capitalization hinders readability - Use “task”, or other synonymous concepts, to avoid confusion - Use “Pod” to mean the Kubernetes object - Use “pod” where capitalization hinders readability - Use “container” in lowercase everywhere Also: - Clarify work queue example for Job controller - Fix advice on running Job example - Tweak emphasis
yagonobre
pushed a commit
to yagonobre/website
that referenced
this pull request
Mar 14, 2019
- Use “Job” to mean the Kubernetes object - Use “job” where capitalization hinders readability - Use “task”, or other synonymous concepts, to avoid confusion - Use “Pod” to mean the Kubernetes object - Use “pod” where capitalization hinders readability - Use “container” in lowercase everywhere Also: - Clarify work queue example for Job controller - Fix advice on running Job example - Tweak emphasis
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #10086 highlights some confusing capitalization on https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
These changes are aimed at making the
Jobcontroller documentation more readable and less likely to confuse a reader. In deciding what changes to make, I've assumed that the reader is likely to have encountered the pod and container concepts already. Where it helps with readability I've opted to use “pod” as a normal English word, saving “Pod” for when this specifically describes an object of kindPod.There's a bit more detail on my thinking here in the commit message for 8006296.