Workflows lookup reference: add glossary and expand cheat-sheet gotchas#6826
Open
benironside wants to merge 2 commits into
Open
Workflows lookup reference: add glossary and expand cheat-sheet gotchas#6826benironside wants to merge 2 commits into
benironside wants to merge 2 commits into
Conversation
Closes docs-content-internal#1159. Two deliverables in one PR: 1. New explore-analyze/workflows/reference/glossary.md (48 terms). Adapted from the PM internal docset (elastic/workflows-internal- docs, reference/glossary.md). One H3 per term with per-term anchor; alphabetical groups (A-B, C, D-E, F-H, I-K, L, N-O, P-R, S, T, V-W, Y) mirror the PM source. Cross-links rewritten from PM-site relative paths to docs-content paths. Cut 7 terms not Workflows-specific (devops/security/observability acronyms): CI, EDR, NL authoring (experimental, not documented), SIEM, SLO, SOAR, SOC. Fixed version-prose in 5 PM-source entries (Composition, Event- driven trigger, Streams, Tech Preview, Trigger, workflows.failed) — moved version info to applies_to directives, dropped "in 9.4" qualifiers. Updated Terminal state to include timed_out (matches the lifecycle-table fix that shipped in PR #6669). 2. Cheat-sheet expansion: added a worked-example YAML snippet under each of the 10 gotchas that support one (gotcha 1 is purely UI- driven and has no YAML form). Each snippet is 3-12 lines, shows either wrong/right comparison or a single correct shape. Patterns anchored in existing reference pages, not invented. TOC: added glossary.md to the Reference sub-parent in explore- analyze/toc.yml; alphabetized the existing entries (cheat-sheet, context-variables, glossary, liquid-filters, step-types). Cross-links: glossary added to cheat-sheet's Related section, a terminology pointer added near the top of pass-data-handle-errors, and a Glossary signpost added to the workflows.md landing-page Learn-more section. 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. |
Update the ES|QL reference link to the canonical elasticsearch://reference/query-languages/esql.md path so the strict docs build no longer fails on the redirect warning. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Contributor
Elastic Docs Style Checker (Vale)Summary: 3 warnings, 4 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/workflows/reference/cheat-sheet.md | 309 | Elastic.Spelling | 'docset' is a possible misspelling. |
| explore-analyze/workflows/reference/glossary.md | 180 | Elastic.Spelling | 'rrules' is a possible misspelling. |
| explore-analyze/workflows/reference/glossary.md | 217 | Elastic.Spelling | 'docset' is a possible misspelling. |
💡 Suggestions (4): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/workflows/reference/glossary.md | 97 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/workflows/reference/glossary.md | 124 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/workflows/reference/glossary.md | 194 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/workflows/reference/glossary.md | 217 | 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 elastic/docs-content-internal#1159.
Summary
Two deliverables for the Workflows lookup-reference surface:
explore-analyze/workflows/reference/glossary.md— 48 terms with cross-links into the canonical reference pages.Files changed (5)
explore-analyze/workflows/reference/glossary.md.explore-analyze/workflows/reference/cheat-sheet.md— 10 worked-example YAML snippets added inside the existing "Top gotchas" section; Glossary added to Related.explore-analyze/toc.yml— glossary added to the Reference sub-parent; existing 4 entries alphabetized.explore-analyze/workflows/authoring-techniques/pass-data-handle-errors.md— terminology pointer near the top of the page.explore-analyze/workflows.md— Glossary signpost in the Learn-more section.Generative AI disclosure