Skip to content

Commit

Permalink
Docs: Update CLI job tag unset (#24273)
Browse files Browse the repository at this point in the history
* Docs: Update CLI job tag unset

CLI help order was wrong, so updating the docs.

* change usage to [options]. Move general options into expanable.

* change "to see" to "for"
  • Loading branch information
aimeeu authored Oct 23, 2024
1 parent 3aeb254 commit 6a2e1e4
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions website/content/docs/commands/job/tag.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ following subcommands:
nomad job tag <subcommand> [options] [args]
```

## General options

Use these optional general options with the subcommands.

@include 'general_options.mdx'

## Apply

Use `job tag apply` to create or modify a version tag.
Expand All @@ -38,6 +32,15 @@ Use `job tag apply` to create or modify a version tag.
nomad job tag apply [options] <job_id>
```

### General options

<details>
<summary>Expand for general options</summary>

@include 'general_options.mdx'

</details>

### Apply options

- `name`: Specifies the name of the tag. Must be unique per job.
Expand Down Expand Up @@ -69,9 +72,18 @@ Use `nomad job tag unset` to delete a tag from a version. This command requires
### Unset usage

```shell-session
nomad job tag unset [options] <job_id> -name <tag>
nomad job tag unset [options] <job_id>
```

### General options

<details>
<summary>Expand for general options</summary>

@include 'general_options.mdx'

</details>

### Unset options

- `name`: Specifies the name of the tag to remove from the job version.
Expand All @@ -81,7 +93,7 @@ nomad job tag unset [options] <job_id> -name <tag>
This example removes the `golden-version` tag from the `hello-world` job.

```shell-session
$ nomad job tag unset hello-world -name "golden-version"
$ nomad job tag unset -name "golden-version" hello-world
```

[diff]: /nomad/docs/commands/job/history/
Expand Down

0 comments on commit 6a2e1e4

Please sign in to comment.