-
Notifications
You must be signed in to change notification settings - Fork 444
docs(build_recipes): add initial build recipes structure #7163
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
Conversation
Hey @dreamorosi I need a review here, pls. |
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.
Thanks looks good.
Please let's address all the MKDocs build warnings when you can - a few of them are related to pages you're linking here which are not present yet (expected) but there are also many others for dead links in pages.
|
Issue number: closes #7162
Summary
This PR creates the initial structure to add the build recipes documentation to help developers package Lambda functions with Powertools for AWS Lambda (Python) using different build tools and dependency managers.
Changes
New documentation structure:
docs/build_recipes/index.md
- Overview, terminology, and navigation guidedocs/build_recipes/getting-started.md
- Prerequisites and tool selection guidancedocs/build_recipes/cross-platform.md
- Architecture compatibility, GLIBC considerations, and Python wheelsdocs/build_recipes/build-with-{tool}.md
- Dedicated guides for pip, Poetry, uv, SAM, CDK, and Pantsdocs/build_recipes/performance-optimization.md
- Cold start and package size optimizationdocs/build_recipes/cicd-integration.md
- GitHub Actions and CodeBuild examplesdocs/build_recipes/troubleshooting.md
- Common issues and solutionsUser experience
Before:
After:
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.