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.

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

Backport of cli: update nomad job init full examples into stable-website #24246

Conversation

hc-github-team-nomad-core
Copy link
Contributor

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 and nomad job init -connect have not seen any improvement in over a year. I intended to just peek in, add a new ui{} block block, and be done. However, something about skimming over the phrase the 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:

  1. Added a ui block because I think it should be a widely used feature!
  2. Removed tons of non-connect-related blocks from the connect example. I don't think the value of documenting blocks twice in the normal example and in connect is worth it. We could add some templating to keep those blocks in sync, but I just don't think repeating our examples is helpful. When people want a service mesh example, they probably want to see exactly what's relevant to the service mesh, not a bunch of unrelated topics like affinity{}.
  3. Removed the online documentation. It is 2024, not 1999. I think our users know what a URL implies.
  4. Cleaned up whitespace in a few places although I did remove some comments to do it. For example I couldn't figure out how best to indent 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 the nomad 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

@schmichael
Copy link
Member

No website related changes.

@schmichael schmichael closed this Oct 17, 2024
@schmichael schmichael deleted the backport/f-init-update/literally-meet-escargot branch October 17, 2024 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants