From 46ae1025bb3de80889176f91b1bf9ae4f1e2118e Mon Sep 17 00:00:00 2001 From: Michael Schurter Date: Thu, 16 Mar 2023 09:42:46 -0700 Subject: [PATCH] docs: dispatch_payload and jobs api docs had some weirdness (#16514) * 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 --- website/content/api-docs/jobs.mdx | 2 +- .../content/docs/job-specification/dispatch_payload.mdx | 8 +------- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/website/content/api-docs/jobs.mdx b/website/content/api-docs/jobs.mdx index 1be4fd161..bf3619804 100644 --- a/website/content/api-docs/jobs.mdx +++ b/website/content/api-docs/jobs.mdx @@ -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 { diff --git a/website/content/docs/job-specification/dispatch_payload.mdx b/website/content/docs/job-specification/dispatch_payload.mdx index 482fe1004..af5e905a5 100644 --- a/website/content/docs/job-specification/dispatch_payload.mdx +++ b/website/content/docs/job-specification/dispatch_payload.mdx @@ -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.