Backport of cli: update nomad job init full examples into stable-website #24246
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.
Backport
This PR is auto-generated from #24232 to be assessed for backporting due to the inclusion of the label backport/website.
The below text is copied from the body of the original PR.
The full example jobspecs emitted by
nomad job init
andnomad job init -connect
have not seen any improvement in over a year. I intended to just peek in, add a newui{}
block block, and be done. However, something about skimming over the phrasethe online documentation
a dozen times made me stop and do some spring cleaning.The diff is an absolute nightmare even though I think my changes are fairly minor. Some highlights:
ui
block because I think it should be a widely used feature!affinity{}
.the online documentation
. It is 2024, not 1999. I think our users know what a URL implies.affinity{}
and all of its field comments, so I just removed the field comments. I think users are much better off visiting the online documentation for those details. The examples should demonstrate Nomad's featureset, not be a comprehensive guide to those features.Pinging @philrenaud because I've been pestering Phil with
ui{}
things already, and @aimeeu because despite this being a part of thenomad
binary, I think it's documentation, and I want to make sure my changes fit with the style of similar examples our docs are full of. Let me know if you want to hand it off.Overview of commits