Skip to content

Commit 826375b

Browse files
authored
Update README.md to be more visual (#518)
Update `README.md` to be more visual and informative. * Add visual elements such as architecture diagrams and workflow images. * Integrate the "Tech Stack" section from `techstack.md`. * Display images directly in the "Resilience Hub Screenshots" section. * Include visual representations of CloudFormation templates. * Add sections for mentioning additional documentation files: `CHANGELOG.md`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE.md`, `SECURITY.md`, and various CloudFormation template files. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Hack23/lambda-in-private-vpc?shareId=XXXX-XXXX-XXXX-XXXX).
1 parent dcba6de commit 826375b

File tree

1 file changed

+31
-11
lines changed

1 file changed

+31
-11
lines changed

README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Lambda in Private VPC
32

43
**Status:** Work in Progress
@@ -11,7 +10,6 @@ This project shows how to build a highly available system that runs in multiple
1110
[![Verify and Deploy](https://github.com/Hack23/lambda-in-private-vpc/actions/workflows/main.yml/badge.svg)](https://github.com/Hack23/lambda-in-private-vpc/actions/workflows/main.yml)
1211
[![Scorecard supply-chain security](https://github.com/Hack23/lambda-in-private-vpc/actions/workflows/scorecard.yml/badge.svg?branch=main)](https://github.com/Hack23/lambda-in-private-vpc/actions/workflows/scorecard.yml)
1312

14-
1513
## CloudFormation Templates
1614

1715
The project includes several AWS CloudFormation templates that automate the creation and management of the necessary AWS resources:
@@ -39,18 +37,25 @@ Learn more about AWS Resilience Hub concepts and understand the key terms and pr
3937

4038
## Architecture Diagrams
4139

42-
- [Infrastructure](cloudformation/template.png) - Depicts the overall infrastructure, including AWS services and components.
43-
- [DNS Route53](cloudformation/route53.png) - Shows the Route 53 configuration for DNS routing and failover.
44-
- [Web Application Firewall](cloudformation/waf.png) - Displays the setup of the Web Application Firewall for securing your application.
45-
- [Disaster Recovery](cloudformation/disaster-recovery.png) - Illustrates the disaster recovery strategy for the application.
40+
- ![Infrastructure](cloudformation/template.png) - Depicts the overall infrastructure, including AWS services and components.
41+
- ![DNS Route53](cloudformation/route53.png) - Shows the Route 53 configuration for DNS routing and failover.
42+
- ![Web Application Firewall](cloudformation/waf.png) - Displays the setup of the Web Application Firewall for securing your application.
43+
- ![Disaster Recovery](cloudformation/disaster-recovery.png) - Illustrates the disaster recovery strategy for the application.
4644

4745
## Resilience Hub Screenshots
4846

49-
- [Resilience Hub Policy](ResilienceHubPolicy.png) - Overview of the policy settings in AWS Resilience Hub.
50-
- [Application](ResiliencyHub-App.png) - The application setup and components in AWS Resilience Hub.
51-
- [App Recommendation 1](ResiliencyHub-App-rec1.png) - First set of recommendations for improving application resiliency.
52-
- [App Recommendation 2](ResiliencyHub-App-rec2.png) - Second set of recommendations for enhancing application resiliency.
53-
- [Region](ResHub-region.png) - Regional recommendations
47+
- ![Resilience Hub Policy](ResilienceHubPolicy.png) - Overview of the policy settings in AWS Resilience Hub.
48+
- ![Application](ResiliencyHub-App.png) - The application setup and components in AWS Resilience Hub.
49+
- ![App Recommendation 1](ResiliencyHub-App-rec1.png) - First set of recommendations for improving application resiliency.
50+
- ![App Recommendation 2](ResiliencyHub-App-rec2.png) - Second set of recommendations for enhancing application resiliency.
51+
- ![Region](ResHub-region.png) - Regional recommendations
52+
53+
## Tech Stack
54+
Hack23/lambda-in-private-vpc is built on the following main stack:
55+
56+
- <img width='25' height='25' src='https://img.stackshare.io/service/11563/actions.png' alt='GitHub Actions'/> [GitHub Actions](https://github.com/features/actions) – Continuous Integration
57+
58+
Full tech stack [here](/techstack.md)
5459

5560
## Relevant Links
5661

@@ -60,5 +65,20 @@ Learn more about AWS Resilience Hub concepts and understand the key terms and pr
6065

6166
For more information on AWS service level agreements, visit the [AWS SLA page](https://aws.amazon.com/legal/service-level-agreements/).
6267

68+
## Additional Documentation
69+
70+
- [CHANGELOG.md](CHANGELOG.md)
71+
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
72+
- [CONTRIBUTING.md](CONTRIBUTING.md)
73+
- [LICENSE.md](LICENSE.md)
74+
- [SECURITY.md](SECURITY.md)
75+
- [AlarmRecommendation-apigateway/alarm/AlarmRecommendation-apigateway-Alarm-172017021075-eu-west-1.json](AlarmRecommendation-apigateway/alarm/AlarmRecommendation-apigateway-Alarm-172017021075-eu-west-1.json)
76+
- [AlarmRecommendation-apigateway/alarm/AlarmRecommendation-apigateway-Alarm-172017021075-eu-west-2.json](AlarmRecommendation-apigateway/alarm/AlarmRecommendation-apigateway-Alarm-172017021075-eu-west-2.json)
77+
- [AlarmRecommendation-apigateway/manifest.json](AlarmRecommendation-apigateway/manifest.json)
78+
- [AlarmRecommendation-apigateway/README.md](AlarmRecommendation-apigateway/README.md)
79+
- [SopRecommendation-apigateway/sop/SopRecommendation-apigateway-Sop-172017021075-eu-west-1.json](SopRecommendation-apigateway/sop/SopRecommendation-apigateway-Sop-172017021075-eu-west-1.json)
80+
- [SopRecommendation-apigateway/manifest.json](SopRecommendation-apigateway/manifest.json)
81+
- [SopRecommendation-apigateway/README.md](SopRecommendation-apigateway/README.md)
82+
6383
## License
6484
This project is licensed under the Apache License 2.0.

0 commit comments

Comments
 (0)