Skip to content
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.

Sign up for GitHub

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

Jump to bottom

aws-cdk-lib.stepfunctions: Add Non-trivial Examples to Map Documentation #26707

Closed
navneethc opened this issue Aug 10, 2023 · 4 comments · Fixed by #26870
Closed

aws-cdk-lib.stepfunctions: Add Non-trivial Examples to Map Documentation #26707

navneethc opened this issue Aug 10, 2023 · 4 comments · Fixed by #26870
Labels
aws-cdk-lib Related to the aws-cdk-lib package documentation This is a problem with documentation. effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p1

Comments

@navneethc
Copy link

Describe the issue

The documentation for the Map constructor currently points to using a single Pass state, however this is far from a real-world scenario. (Without intending to be rude, I'd say this is useless.) Recently I was bitten by a few bugs and lost a few hours thanks to the way I arranged the tasks within Map state.

Consider adding an example or two which show how to add more than one state to a Map, and how to proceed from a Map to the outside. And also how to use the next methods in such cases.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html#map
@navneethc navneethc added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Aug 10, 2023
@github-actions github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label Aug 10, 2023
@navneethc navneethc changed the title aws-cdk-lib.stepfunctions: Add Non-trivial Examples for Map State aws-cdk-lib.stepfunctions: Add Non-trivial Examples to Map Documentation Aug 10, 2023
@peterwoodworth peterwoodworth added p1 effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md and removed needs-triage This issue or PR still needs to be triaged. labels Aug 10, 2023
@peterwoodworth
Copy link
Contributor

Thanks for the suggestion on how to improve our docs 🙂

@anshikam
Copy link
Contributor

@peterwoodworth @navneethc I would like to take this one up as my first task.

@peterwoodworth
Copy link
Contributor

Feel free @anshikam

@kaizencc kaizencc mentioned this issue Aug 25, 2023
Merged
@mergify mergify bot closed this as completed in #26870 Aug 25, 2023
mergify bot pushed a commit that referenced this issue Aug 25, 2023
@anshikam
docs(stepfunctions): multi-state example for map state (#26870)
803cfe3 
Closes #26707.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot mentioned this issue Sep 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
aws-cdk-lib Related to the aws-cdk-lib package documentation This is a problem with documentation. effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(stepfunctions): multi-state example for map state anshikam/aws-cdk
3 participants
@navneethc @anshikam @peterwoodworth