Skip to content

Add lambda template docs #867

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

Open
wants to merge 1 commit into
base: main-enterprise
Choose a base branch
from

Conversation

bheemreddy181
Copy link
Contributor

@bheemreddy181 bheemreddy181 commented Aug 2, 2025

Summary

Updated AWS Lambda deployment documentation to accurately reflect the production-ready SafeSettings-Template implementation instead of generic deployment approaches.

Changes Made

New docs/awslambda.md:

✅ Template-First Approach: Prominently features SafeSettings-Template as the recommended deployment method
✅ Accurate Architecture: Documents the dual Lambda function approach (webhooks + scheduler) with Docker containers
✅ Real Implementation: Reflects actual Node.js 20 runtime, handler structure, and project organization
✅ Production-Ready Setup: Includes GitHub Actions CI/CD, testing, and monitoring guidance
✅ Template-Specific Troubleshooting: Addresses issues specific to the containerized deployment

Updated deploy.md:

🚀 Enhanced AWS Lambda Section: Now highlights SafeSettings-Template with clear benefits and features
📦 Better Organization: Separates modern template approach from legacy Serverless Framework method
🔄 Updated Dependencies: Changed Node.js requirement from 16.x to 18.x+ (20.x LTS recommended)
🔗 Updated Repository URLs: Changed clone instructions to point to new repository origin

Key Benefits

  • Accurate Documentation: Now matches the actual SafeSettings-Template implementation
  • Clear User Path: Users can easily choose between modern template or alternative approaches
  • Production Ready: Highlights battle-tested features like automated CI/CD and comprehensive testing
  • Consistent Experience: Both documents work together seamlessly

Impact

Users now have clear guidance for deploying safe-settings to AWS Lambda using the modern, containerized template approach while maintaining access to alternative deployment methods.

Template Repository: SafeSettings-Template
Documentation: AWS Lambda Deployment Guide

https://medium.com/@bheemreddy181/deploying-github-safe-settings-to-aws-lambda-a-docker-first-serverless-approach-d70eff7a0c6b

@bheemreddy181
Copy link
Contributor Author

@decyjphr Can i get some insights on this ?

@bheemreddy181
Copy link
Contributor Author

@decyjphr can I get a review here as well

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.

1 participant