Workflows: sweep nested-inputs YAML structure across remaining docs#6814
Open
benironside wants to merge 4 commits into
Open
Workflows: sweep nested-inputs YAML structure across remaining docs#6814benironside wants to merge 4 commits into
benironside wants to merge 4 commits into
Conversation
Closes #6811. Follows the pattern established in PR #6669 for anatomy.md. Sweeps every other workflows page that still shows root-level inputs:. Tier 1 (applies-switch — schema is the topic or featured prominently): - templating.md (Reference inputs section) - triggers/manual-triggers.md - reference/context-variables.md (inputs.<name> section) - steps/composition.md (Shared workflow library example) - authoring-techniques/compose-workflows.md (Declare contract section) Tier 2 (new form only + one-line cross-link to anatomy.md): - workflows.md (landing-page anatomy example). Restructured the inline YAML so inputs nests under the manual trigger, with a comment header that reflects the new placement. - reference/cheat-sheet.md (anatomy placeholder snippet). - use-cases/security/automate-security-operations/ enrich-alert-with-threat-intel.md (stepper example + full workflow). - use-cases/security/manage-detection-rules/ run-rules-on-demand.md (stepper example + full workflow). Tier 3 (migration documentation): - authoring-techniques/migrate-from-9-3.md: new "Looking ahead to 9.5: inputs schema change" section near the end, gated with applies_to: stack: ga 9.5+. Shows old/new YAML side by side and cross-links to anatomy.md for the full reference. Labels follow the convention from anatomy.md: legacy form labeled { stack: ga 9.4, serverless: ga }; new form labeled stack: ga 9.5+ only. The serverless label on the new form will be added by #6812 when the schema change ships in serverless. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
The schema change moving inputs: from the workflow root to under
the manual trigger is now live in serverless. Updates the applies-
switch labels, dependent prose, and the migration guide section
to reflect this on all the pages this PR added or modified.
Changes:
Applies-switch labels (5 Tier 1 pages — templating.md, manual-
triggers.md, context-variables.md, composition.md, compose-
workflows.md):
- Legacy form: { stack: ga 9.4, serverless: ga } -> stack: ga 9.4
- New form: stack: ga 9.5+ -> { stack: ga 9.5+, serverless: ga }
Orientation prose on the same 5 pages: "On 9.4 and earlier (and
on serverless today), inputs sits at the top level. On 9.5+,
inputs sits inside the manual trigger." -> "On 9.4, inputs sits
at the top level. On 9.5+ and serverless, inputs sits inside
the manual trigger."
Tier 2 prose-only updates (4 pages — workflows.md, cheat-sheet.md,
enrich-alert-with-threat-intel.md, run-rules-on-demand.md): same
shape ("9.4 and serverless today" -> "9.4 only", "9.5+ structure"
-> "9.5+ and serverless structure").
Migration guide (migrate-from-9-3.md):
- Section title: "Looking ahead to 9.5: inputs schema change" ->
"inputs schema change in 9.5 and serverless".
- applies_to: stack: ga 9.5+ -> stack: ga 9.5+, serverless: ga.
- Removed the "The change is not yet live in serverless." line.
- YAML comment headers updated to mention serverless.
Closes #6812. The corresponding update on anatomy.md ships on the
#6669 fix-up commit (still on the workflows-authoring-guidance
branch, not yet pushed).
Co-authored-by: Cursor <cursoragent@cursor.com>
Workflows shipped as preview in 9.3 and went GA in 9.4, so the
top-level `inputs:` form is the only form on both 9.3 (preview) and
9.4 (GA). Update each Tier 1 page so the legacy applies-item is
labeled `stack: preview 9.3, ga 9.4` instead of just `stack: ga 9.4`,
and tighten the dependent prose.
Tier 1 (5 pages — templating.md, manual-triggers.md, context-
variables.md, composition.md, compose-workflows.md):
- Legacy applies-item: `stack: ga 9.4` -> `stack: preview 9.3, ga 9.4`.
- New applies-item unchanged (`{ stack: ga 9.5+, serverless: ga }`).
- Orientation prose: "On 9.4, inputs sits at the top level. On 9.5+
and serverless, inputs sits inside the manual trigger." ->
"On stack 9.4 and earlier, inputs sits at the top level. On stack
9.5+ and on serverless, inputs sits inside the manual trigger."
Tier 2 (4 pages — workflows.md, cheat-sheet.md, enrich-alert-with-
threat-intel.md, run-rules-on-demand.md): tighten the cross-reference
prose with the same convention ("On 9.4" -> "On stack 9.4 and
earlier"; "9.5+ and serverless structure" -> "stack 9.5+ and
serverless structure").
migrate-from-9-3.md: tighten "On 9.5+ and serverless" to "On stack
9.5+ and on serverless" in the section body for consistency. The
section's applies_to label is already correct (stack: ga 9.5+ and
serverless: ga together).
Co-authored-by: Cursor <cursoragent@cursor.com>
benironside
added a commit
that referenced
this pull request
Jun 3, 2026
…se-the-right-step (#6669) Closes #6670. ## Summary Three new authoring-guidance pages under `explore-analyze/workflows/authoring-techniques/`, adapted from PM internal source material: - **`anatomy.md`** ([preview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6669/explore-analyze/workflows/authoring-techniques/anatomy)) — every top-level workflow field, what it does, and the execution lifecycle states. Field table schema-verified against `kbn-workflows/spec/schema.ts` (11 fields confirmed). - **`settings.md`** ([preview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6669/explore-analyze/workflows/authoring-techniques/settings))— workflow-wide settings reference covering `timeout`, `timezone`, `concurrency`, `max-step-size`, and global `on-failure`. - **`choose-the-right-step.md`** ([preview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6669/explore-analyze/workflows/authoring-techniques/choose-the-right-step)) — decision aid organized by intent ("I want to query Elasticsearch" → step). Incidental updates: TOC entries plus targeted cross-links from [`workflows.md`](https://github.com/elastic/docs-content/blob/main/explore-analyze/workflows.md), [`authoring-techniques.md`](https://github.com/elastic/docs-content/blob/main/explore-analyze/workflows/authoring-techniques.md), [`compose-workflows.md`](https://github.com/elastic/docs-content/blob/main/explore-analyze/workflows/authoring-techniques/compose-workflows.md), [`pass-data-handle-errors.md`](https://github.com/elastic/docs-content/blob/main/explore-analyze/workflows/authoring-techniques/pass-data-handle-errors.md), [`scheduled-triggers.md`](https://github.com/elastic/docs-content/blob/main/explore-analyze/workflows/triggers/scheduled-triggers.md), [`cheat-sheet.md`](https://github.com/elastic/docs-content/blob/main/explore-analyze/workflows/reference/cheat-sheet.md), and [`step-types.md`](https://github.com/elastic/docs-content/blob/main/explore-analyze/workflows/reference/step-types.md) into the new pages where existing prose was already gesturing at the same information. ## `applies-switch` label convention The two `applies-switch` blocks in `anatomy.md` (covering the placement of `inputs`) use this convention: - Legacy form (top-level `inputs:`): `stack: preview 9.3, ga 9.4` - New form (nested under `manual`): `{ stack: ga 9.5+, serverless: ga }` Workflows shipped as preview in 9.3 and went GA in 9.4, so the legacy form covers both. The new form is required for new workflows on stack 9.5+ and on serverless (per Tinsae's review confirming the schema change is live in serverless). ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Claude Opus 4.7 via Cursor. ## Follow-up issues Sub-issues under [docs-content-internal#1151](elastic/docs-content-internal#1151) (Workflows docs maturity META): - [#6811](#6811) — Apply the nested-inputs YAML structure (and the applies-switch pattern established here) uniformly across all remaining workflows docs. Tracked in PR [#6814](#6814). - [#6812](#6812) — Update the applies-switch labels to add `serverless: ga` to the new (nested) form. Resolved together with this PR and #6814: the schema change is live in serverless, so the new-form applies-item is labeled `{ stack: ga 9.5+, serverless: ga }` from the start. --------- Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # explore-analyze/workflows.md # explore-analyze/workflows/reference/cheat-sheet.md
Contributor
Contributor
Elastic Docs Style Checker (Vale)Summary: 1 warning, 1 suggestion found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/workflows.md | 44 | Elastic.DirectionalLanguage | Don't use directional language. Use 'the following element' instead of 'The example below'. |
💡 Suggestions (1): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/workflows/authoring-techniques/migrate-from-9-3.md | 222 | Elastic.Semicolons | Use semicolons judiciously. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #6811 and #6812. Will stay broken until #6669 is merged.
Summary
Follows the pattern established in PR #6669 for
anatomy.md. Sweeps every other workflows page that still shows root-levelinputs:so the docset is consistent about teaching the 9.5+ nested-under-manualform alongside the legacy form.Files changed (10, by tier)
Tier 1 —
applies-switch(schema is the topic or featured prominently):templating.md(Reference inputs section)triggers/manual-triggers.mdreference/context-variables.md(inputs.<name>section)steps/composition.md(Shared workflow library example)authoring-techniques/compose-workflows.md(Declare contract section)Tier 2 — new form only + one-line cross-link to anatomy.md:
workflows.md(landing-page anatomy example). Restructured the inline YAML soinputsnests under the manual trigger.reference/cheat-sheet.md(anatomy placeholder snippet).use-cases/security/automate-security-operations/enrich-alert-with-threat-intel.md(stepper example + full workflow).use-cases/security/manage-detection-rules/run-rules-on-demand.md(stepper example + full workflow).Tier 3 — migration documentation:
authoring-techniques/migrate-from-9-3.md: new "inputsschema change in 9.5 and serverless" section near the end, gated withapplies_tostack: ga 9.5+andserverless: ga. Shows old/new YAML side by side and cross-links to anatomy.md for the full reference.Label convention
Following the convention from anatomy.md established in PR #6669:
inputs:):stack: preview 9.3, ga 9.4manual):{ stack: ga 9.5+, serverless: ga }The legacy form covers stack 9.3 (preview) and 9.4 (GA) — the only versions where the top-level form was the only form. The new form is required for new workflows on stack 9.5+ and on serverless. This also closes #6812, which tracked the serverless label sweep — the schema change is live in serverless per Tinsae's review on #6669, so the new-form applies-item now includes
serverless: ga.Generative AI disclosure