Skip to content

Conversation

pru55e11
Copy link
Collaborator

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Patrick Russell added 2 commits October 16, 2025 13:58
- 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
- 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
@pru55e11 pru55e11 requested a review from shazron October 17, 2025 00:06
Copy link
Contributor

@purplecabbage purplecabbage left a 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
Copy link
Contributor

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

Copy link
Contributor

@moritzraho moritzraho left a 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)
Copy link
Contributor

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

@MichaelGoberling
Copy link
Contributor

To get started with sequences, might be good to point users to the action-sequences QuickStart

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants