Add three workflows authoring guidance pages: anatomy, settings, choose-the-right-step#6669
Draft
benironside wants to merge 2 commits into
Draft
Add three workflows authoring guidance pages: anatomy, settings, choose-the-right-step#6669benironside wants to merge 2 commits into
benironside wants to merge 2 commits into
Conversation
…ht-step Three new reference pages under authoring-techniques, adapted from PM internal source material at elastic/workflows-internal-docs: - anatomy.md: every top-level workflow field, what it does, and the execution lifecycle states. Schema verified against kbn-workflows/spec/schema.ts (11 top-level fields confirmed). - settings.md: workflow-wide settings reference covering timeout, timezone, concurrency, max-step-size, and global on-failure. - choose-the-right-step.md: decision aid keyed by intent. No mermaid flowchart (the PM source had one; redundant with the intent tables). Companion updates: - toc.yml: three new entries under Authoring techniques. - workflows.md, authoring-techniques.md: bullet-list signposts to the new pages. - compose-workflows.md, pass-data-handle-errors.md, scheduled-triggers.md, cheat-sheet.md, reference/step-types.md: targeted cross-links into the new pages where existing prose was already gesturing at the same info. Style: per-page anchors on every section, no version references in prose (applies_to handles versioning), REFER TO not "see", em-dashes used sparingly, concrete legal values enumerated in tables, no mermaid. References docs-content-internal#1158. The issue stays open for the two remaining pages tracked there (debugging-and-testing and designing-for-reuse), which need fresh authoring or are blocked on composition GA. 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: 2 warnings, 14 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/workflows/authoring-techniques/anatomy.md | 250 | Elastic.Spelling | 'inis' is a possible misspelling. |
| explore-analyze/workflows/authoring-techniques/choose-the-right-step.md | 34 | Elastic.DirectionalLanguage | Don't use directional language. Use 'in the preceding section' instead of 'listed above'. |
💡 Suggestions (14)
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/workflows/authoring-techniques/anatomy.md | 18 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| explore-analyze/workflows/authoring-techniques/anatomy.md | 73 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| explore-analyze/workflows/authoring-techniques/anatomy.md | 95 | Elastic.WordChoice | Consider using 'cancel, stop' instead of 'kill', unless the term is in the UI. |
| explore-analyze/workflows/authoring-techniques/anatomy.md | 97 | Elastic.WordChoice | Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI. |
| explore-analyze/workflows/authoring-techniques/anatomy.md | 158 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/workflows/authoring-techniques/choose-the-right-step.md | 18 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/workflows/authoring-techniques/choose-the-right-step.md | 115 | Elastic.WordChoice | Consider using 'stop, exit' instead of 'terminate', unless the term is in the UI. |
| explore-analyze/workflows/authoring-techniques/settings.md | 28 | Elastic.Wordiness | Consider using 'per' instead of 'as per'. |
| explore-analyze/workflows/authoring-techniques/settings.md | 54 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/workflows/authoring-techniques/settings.md | 73 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/workflows/authoring-techniques/settings.md | 98 | Elastic.HeadingColons | Capitalize ': p'. |
| explore-analyze/workflows/authoring-techniques/settings.md | 110 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/workflows/authoring-techniques/settings.md | 116 | Elastic.HeadingColons | Capitalize ': c'. |
| explore-analyze/workflows/triggers/scheduled-triggers.md | 95 | 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.
- Convert tags: [observability, slo] in the complete-shape example to block-style (multi-line) array so the array syntax matches triggers, inputs, outputs, and steps elsewhere in the same snippet. - Split the bundled 'Identity fields' section so name, description, tags, and version each get their own H2, matching the per-field treatment that enabled, triggers, inputs, consts, outputs, settings, and steps already had. - Reorder sections to match the field-reference table. - Add small concrete details to each new section (uniqueness + API-identifier note for name; UI placement for description; yaml example + convention notes for tags; quoting note for version). Co-authored-by: Cursor <cursoragent@cursor.com>
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 #6670.
Summary
Three new authoring-guidance pages under
explore-analyze/workflows/authoring-techniques/, adapted from PM internal source material:anatomy.md(preview) — every top-level workflow field, what it does, and the execution lifecycle states. Field table schema-verified againstkbn-workflows/spec/schema.ts(11 fields confirmed).settings.md(preview)— workflow-wide settings reference coveringtimeout,timezone,concurrency,max-step-size, and globalon-failure.choose-the-right-step.md(preview) — decision aid organized by intent ("I want to query Elasticsearch" → step).Incidental updates: TOC entries plus targeted cross-links from
workflows.md,authoring-techniques.md,compose-workflows.md,pass-data-handle-errors.md,scheduled-triggers.md,cheat-sheet.md, andstep-types.mdinto the new pages where existing prose was already gesturing at the same information.Generative AI disclosure
Tool(s) and model(s) used: Claude Opus 4.7 via Cursor.