kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-01 16:05:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: dispatch_payload and jobs api docs had some weirdness (#16514)

Browse Source 
* docs: dispatch_payload docs had some weirdness

Docs said "Examples" when there was only 1 example. Not sure what the
floating "to" in the description was for.

* docs: missing a heading level on jobs api docs
This commit is contained in:
Michael Schurter
2023-03-16 09:42:46 -07:00
committed by GitHub
parent ea727dff9e
commit 46ae1025bb
2 changed files with 2 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/content/api-docs/jobs.mdx
View File

@@ -237,7 +237,7 @@ The table below shows this endpoint's support for
- `HCLv1` `(bool: false)` - Use the legacy v1 HCL parser.
## Sample Payload
### Sample Payload
```json
{

8
website/content/docs/job-specification/dispatch_payload.mdx
View File

@@ -3,7 +3,6 @@ layout: docs
page_title: dispatch_payload Block - Job Specification
description: |-
The "dispatch_payload" block allows a task to access dispatch payloads.
to
---
# `dispatch_payload` Block
@@ -34,12 +33,7 @@ job "docs" {
dispatch payload to. The file is written relative to the [task's local
directory][localdir].
## `dispatch_payload` Examples
The following examples only show the `dispatch_payload` blocks. Remember that the
`dispatch_payload` block is only valid in the placements listed above.
### Write Payload to a File
## `dispatch_payload` Example
This example shows a `dispatch_payload` block in a parameterized job that writes
the payload to a `config.json` file.