docs: add clarifying example to job dispatch command docs
- Dominant language
- Go
- Stars
- 17k
- Forks
- 2.1k
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 105
Description
https://developer.hashicorp.com/nomad/docs/commands/job/dispatch
The docs here don't make it clear that `nomad job dispatch ` is referring to JobID (as opposed to the job filename). It's also not clear that the job must be "run" first before "dispatch". Let's fixup the docs so these points are clear.
Contributor guide
No contributing guide indexed for this repository
Research direction
Open the linked Nomad job dispatch command documentation and review the usage section and examples. Update the wording so it identifies the argument as the JobID rather than a job filename and states that the job must be run before dispatching. Done means both prerequisites are clear to readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100