Workflows cheat-sheet: clarify the shared-- naming convention#7095
Open
benironside wants to merge 1 commit into
Open
Workflows cheat-sheet: clarify the shared-- naming convention#7095benironside wants to merge 1 commit into
benironside wants to merge 1 commit into
Conversation
Adds a one-line note to composition gotcha #7 explaining that the `shared--` prefix on `workflow-id` is an optional shared-workflow naming convention, not required syntax. Follow-up to a post-merge review comment on #6826 where the double dash read as a possible typo. The double dash is intentional and documented (shared--<verb>-<noun>), so the YAML example is unchanged; only the clarifying note is added. 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
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! 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. |
Contributor
🔍 Preview links for changed docs |
charlotte-hoblik
approved these changes
Jun 24, 2026
florent-leborgne
approved these changes
Jun 24, 2026
florent-leborgne
left a comment
florent-leborgne
left a comment
Member
There was a problem hiding this comment.
LGTM, a very optional suggestion
| alerts: "${{ event.alerts }}" | ||
| ``` | ||
|
|
||
| The `shared--` prefix in the workflow ID is an optional [naming convention](/explore-analyze/workflows/authoring-techniques/compose-workflows.md) for shared workflows, not required syntax. |
Member
There was a problem hiding this comment.
Suggested change
| The `shared--` prefix in the workflow ID is an optional [naming convention](/explore-analyze/workflows/authoring-techniques/compose-workflows.md) for shared workflows, not required syntax. | |
| :::{tip} | |
| The `shared--` prefix in the workflow ID is an optional [naming convention](/explore-analyze/workflows/authoring-techniques/compose-workflows.md) for shared workflows, not required syntax. | |
| ::: |
Optional, I think it fits this case, but up to you
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
3 participants
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.
Summary
Follow-up to #6826. Adds a one-line note to composition gotcha #7 in the Workflows cheat-sheet clarifying that the
shared--prefix onworkflow-idis an optional shared-workflow naming convention (shared--<verb>-<noun>), not required syntax.Background
In a post-merge review on #6826, the double dash in
workflow-id: "shared--enrich-alerts"read as a possible typo. The double dash is intentional and documented (see Compose workflows), and it's used consistently acrosscomposition.md,troubleshooting.md, and the security use-case pages. Rather than change the value (which would make the cheat-sheet inconsistent with the rest of the docs), this PR adds a brief note so readers don't mistake--for required syntax.Change
explore-analyze/workflows/reference/cheat-sheet.md: one clarifying sentence after the gotcha Update docs-elastic-publish.yml #7 YAML snippet. YAML unchanged.Generative AI disclosure
Yes — Claude Opus 4.8 / Cursor.
Made with Cursor