[gh-24311] Expand on documentation about jobs that are both parameterised and periodic #24384
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
Juanadelacuesta
force-pushed
the
d-gh24311-parameterized-jobs
branch
from
5489ef8
to
e57bbf4
Compare
Juanadelacuesta
force-pushed
the
d-gh24311-parameterized-jobs
branch
from
782140c
to
e467896
Compare
Juanadelacuesta
force-pushed
the
d-gh24311-parameterized-jobs
branch
from
e467896
to
4095fc5
Compare
Juanadelacuesta
changed the title
Juanadelacuesta
changed the title
Juanadelacuesta
added
backport/1.8.x
aimeeu
added
the
backport/website
gulducat
reviewed
Nov 7, 2024
| ID Type Submit Date | ||
| sync batch/periodic/parameterized 2024-11-07T10:43:30+01:00 // Original submitted job | ||
| sync/dispatch-1730972650-247c6e97 batch/periodic 2024-11-07T10:44:10+01:00 // First dispatched job with parameters A | ||
| sync/dispatch-1730972650-247c6e97/periodic-1730972680 batch 2024-11-07T10:44:40+01:00 // Cron job with parameters A |
There was a problem hiding this comment.
whoa! I didn't notice these great // comments in the preview, because I didn't see that the little code block could scroll to the right; I only saw to the Type column. I'm not sure what to suggest for that... maybe say above this to "Scroll to the right for descriptions of each job."?
Comment on lines
62
to
64
| See the [parameterized] documentation for additional considerations when | ||
| using in conjunction with parameterized options. | ||
|
|
There was a problem hiding this comment.
this seems a little buried under these Parameters. maybe move it up under Requirements?
There was a problem hiding this comment.
Since this periodic page doesn't talk about parameterized options at all, what about moving this line right before the # periodic Requirements section?
There was a problem hiding this comment.
It is a bit of a corner case, I didn't want to put it in the general description
Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: Aimee Ukasick <[email protected]>
aimeeu
approved these changes
Nov 8, 2024
Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: Aimee Ukasick <[email protected]>
This was referenced Nov 8, 2024
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.
Addresses this issue.
Deploy preview: https://nomad-git-d-gh24311-parameterized-jobs-hashicorp.vercel.app/nomad/docs/job-specification/parameterized#interactions-with-periodic