Skip to content

Docs: add a section to explicitly explain how public SSM works #3799

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

Closed
1 task done
am29d opened this issue Apr 2, 2025 · 4 comments · Fixed by #3818
Closed
1 task done

Docs: add a section to explicitly explain how public SSM works #3799

am29d opened this issue Apr 2, 2025 · 4 comments · Fixed by #3818
Assignees
Labels
documentation Improvements or additions to documentation pending-release This item has been merged and will be released soon

Comments

@am29d
Copy link
Contributor

am29d commented Apr 2, 2025

What were you searching in the docs?

Information on how to use public SSM parameter to fetch either a specific layer version or the latest version of powertools. At the moment it is hidden under the SAM tab and customers are using different IaC tool they will not find it.

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/typescript/latest/#sam

How can we improve?

We should add examples to CDK and potentially other tabs to show how to fetch latest or specific version. Optionally we can add another tab to fully explain how to fetch the SSM for versions and regions.

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@am29d am29d added confirmed The scope is clear, ready for implementation documentation Improvements or additions to documentation labels Apr 2, 2025
@am29d am29d added good-first-issue Something that is suitable for those who want to start contributing help-wanted We would really appreciate some support from community for this one labels Apr 2, 2025
@dreamorosi dreamorosi moved this from Triage to Backlog in Powertools for AWS Lambda (TypeScript) Apr 2, 2025
@dreamorosi
Copy link
Contributor

I agree, SSM parameters didn't get a lot of love in the docs.

Before we work on this, I'd like to finish working on this #2948 since I'm moving these parts around a bit - I'll try to prioritize that issue and finish it during this iteration.

@VatsalGoel3
Copy link
Contributor

@dreamorosi, I can pick this up.

@dreamorosi dreamorosi added on-hold This item is on-hold and will be revisited in the future and removed good-first-issue Something that is suitable for those who want to start contributing help-wanted We would really appreciate some support from community for this one confirmed The scope is clear, ready for implementation labels Apr 8, 2025
@dreamorosi dreamorosi moved this from Backlog to On hold in Powertools for AWS Lambda (TypeScript) Apr 8, 2025
@dreamorosi
Copy link
Contributor

Hi @VatsalGoel3, sorry but the issue was mislabeled - we need to work on another issue before this is ready to be worked on (see my comment above).

Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments 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 added pending-release This item has been merged and will be released soon and removed on-hold This item is on-hold and will be revisited in the future labels Apr 15, 2025
@dreamorosi dreamorosi self-assigned this Apr 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pending-release This item has been merged and will be released soon
Projects
Status: Coming soon
Development

Successfully merging a pull request may close this issue.

3 participants