Skip to content

Commit 3c88b46

Browse files
authored
Fix broken doc link (#693)
1 parent 36c74f4 commit 3c88b46

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

docs/about/04_coherence_spec.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ m| completionMode | CompletionMode specifies how Pod completions are tracked. It
219219
+
220220
`Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`. +
221221
+
222-
More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job. m| *https://{k8s-doc-link}/#completionmode-v1-batch[batchv1.CompletionMode] | false
222+
More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job. m| *https://pkg.go.dev/k8s.io/api/batch/v1#CompletionMode | false
223223
m| suspend | Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false. m| *bool | false
224224
m| jobAnnotations | JobAnnotations are free-form yaml that will be added to the Coherence workload's `Job` as annotations. Any annotations should be placed BELOW this "annotations:" key, for example: +
225225
+

utils/docgen/main.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ var (
5656

5757
func main() {
5858
// hard coded links to types that are not in the k8s docs
59+
selfLinks["batchv1.CompletionMode"] = "https://pkg.go.dev/k8s.io/api/batch/v1#CompletionMode"
5960
selfLinks["corev1.DNSPolicy"] = "https://pkg.go.dev/k8s.io/api/core/v1#DNSPolicy"
6061
selfLinks["corev1.IPFamily"] = "https://pkg.go.dev/k8s.io/api/core/v1#IPFamily"
6162
selfLinks["corev1.IPFamilyPolicyType"] = "https://pkg.go.dev/k8s.io/api/core/v1#IPFamilyPolicyType"

0 commit comments

Comments
 (0)