-
Notifications
You must be signed in to change notification settings - Fork 89
ACNA-4139 - Docs update for sequences #448
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
- Added comprehensive sequences.md guide in configuration directory - Includes examples of declarative sequence configuration - Covers when to use sequences, data flow, and error handling - Updated main configuration.md to reference sequences guide - Provides migration path from CLI-based sequences to declarative config
- Added sequences.md link to config.md sidebar under Configuration section - Added comprehensive CLI Commands section to sequences guide - Includes creating, listing, invoking, updating, and deleting sequences via CLI - Added CLI vs declarative configuration comparison - Enhanced migration section with clear before/after examples and benefits - Added cross-reference to Runtime Sequences & Compositions guide
src/pages/guides/app_builder_guides/configuration/configuration.md
Outdated
Show resolved
Hide resolved
- Changed from actions/sequence format to sequences/actions format - Updated all examples throughout both files - Sequences now correctly use: sequences: { my-sequence: { actions: ... } } - Addresses shazron's review comment about proper grammar
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
re-approved by me
aio runtime activation get <activation-id> | ||
``` | ||
|
||
### CLI vs Declarative Configuration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could be reused for any rt operation vs config declaration
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
**When NOT to use sequences:** | ||
- When you need conditional logic or branching | ||
- When actions need to run in parallel | ||
- When you need error handling between steps (use a [conductor action](https://github.com/apache/incubator-openwhisk-composer/blob/master/docs/COMBINATORS.md) instead) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: latency could be one argument against too
To get started with sequences, might be good to point users to the action-sequences QuickStart |
Adding docs for sequences
Description
Added small section in configuration guide and dedicated sequences guide under that.
Related Issue
ACNA04139
Motivation and Context
So people can learn how to use sequences!
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: