Workflows: extract Location-column schema convention into a reusable snippet#6724
Draft
benironside wants to merge 1 commit into
Draft
Workflows: extract Location-column schema convention into a reusable snippet#6724benironside wants to merge 1 commit into
benironside wants to merge 1 commit into
Conversation
…snippet Closes #6512. Adds a shared snippet at explore-analyze/workflows/_snippets/schema-location-legend.md that decodes the Location column used by parameter schema tables on step and trigger reference pages, and includes it on every page that has such a table. The legend covers all three Location values: - top level: alongside type and name on the step or trigger. - with: inside the step's with: block. - on: inside the trigger's on: block. Pages updated (12, plus the new snippet): - triggers/event-driven-triggers.md (also removes the inline "Schema convention" prose added in #6480, now superseded by the shared include). - steps/ai-steps.md, cases.md, composition.md, data.md, kibana.md, loop-break.md, loop-continue.md, streams.md, switch.md, wait-for-input.md, while.md. Placement is one include per page, near the top, before the first schema table on the page. Same legend governs every subsequent table on that page. Spot-check: reference/cheat-sheet.md and authoring-techniques/ pass-data-handle-errors.md have no Parameter|Location schema tables, so no include needed there. 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. |
Contributor
Contributor
Vale Linting ResultsSummary: 3 suggestions found 💡 Suggestions (3)
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 #6512.
Summary
Adds a shared snippet at
explore-analyze/workflows/_snippets/schema-location-legend.mdthat decodes theLocationcolumn used by parameter schema tables on step and trigger reference pages, and includes it on every page that has such a table.The legend covers all three
Locationvalues:top level— Alongsidetypeandnameon the step or trigger.`with`— Inside the step'swith:block.`on`— Inside the trigger'son:block.Background
In Nastasha Solomon's review of #6480 she asked "What is the
onlocation?" on thecases.caseCreatedschema table. That PR added an inline "Schema convention" paragraph toevent-driven-triggers.md. This PR generalizes that fix: every workflow step/trigger reference page now starts with the same one-time legend, so a reader landing on any single page from search hits a clear decode before the first schema table.Pages updated (12, plus the new snippet)
triggers/event-driven-triggers.md— also removes the inline "Schema convention" prose added in Document new cases.* event-driven triggers (9.5) #6480 (now superseded by the shared include).steps/ai-steps.mdsteps/cases.mdsteps/composition.mdsteps/data.mdsteps/kibana.mdsteps/loop-break.mdsteps/loop-continue.mdsteps/streams.mdsteps/switch.mdsteps/wait-for-input.mdsteps/while.mdPlacement is one include per page, near the top, before the first schema table. The same legend then governs every subsequent table on that page.
Spot-check
reference/cheat-sheet.mdandauthoring-techniques/pass-data-handle-errors.mdhave noParameter | Locationschema tables, so the legend doesn't apply there. No include added.Generative AI disclosure
Made with Cursor