api/ui: alloc stop incorrectly documented
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 17k
- Forks
- 2.1k
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 105
Description
The Nomad docs detail the alloc stop CLI command as allowing "a user to perform an in-place restart of an entire allocation or individual task". The Nomad UI details the alloc stop that "This will reschedule the allocation on a different client".
These are both incorrect as stopping an allocation will result in a rescheduling of the allocation which can either be on the same node, or a different node, depending on the scheduling outcome and parameters.
We should come up with common wording and update these two locations along with the nomad alloc stop CLI help output. The Nomad CLI has the following help output which seems accurate:
Stop an existing allocation. This command is used to signal a specific alloc
to shut down. When the allocation has been shut down, it will then be
rescheduled.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the alloc stop CLI documentation, the Nomad UI allocation-stop text, and the nomad alloc stop help output described in the issue. Align all three locations so they state that stopping an allocation shuts it down and reschedules it, potentially on the same or a different client, then verify the wording is consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100