redme updates

gugzkumar · Jan 4, 2020 · 3281c48 · 3281c48
1 parent 47d7076
commit 3281c48
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 11 deletions.
diff --git a/.aws-infrastructure/lib/CheetSheetNetwork-stack.ts b/.aws-infrastructure/lib/CheetSheetNetwork-stack.ts
@@ -42,7 +42,8 @@ export class CheetSheetNetworkStack extends cdk.Stack {
 
         const apiDomain = new apigateway.DomainName(this, 'ApiGatewayDomain', {
             domainName: apiDomainName,
-            certificate: acmCert
+            certificate: acmCert,
+            endpointType: apigateway.EndpointType.EDGE
         });
         const apiDomainMapping = new apigateway.CfnBasePathMapping(this, 'ApiGatewayDomainMapping',
             {
@@ -80,7 +81,7 @@ export class CheetSheetNetworkStack extends cdk.Stack {
                         allowedMethods: cloudfront.CloudFrontAllowedMethods.GET_HEAD_OPTIONS,
                         defaultTtl: cdk.Duration.seconds(60)
                       },
-                    ]
+                  ],
                 }
             ],
             aliasConfiguration: {
@@ -100,7 +101,8 @@ export class CheetSheetNetworkStack extends cdk.Stack {
                     responseCode: 200,
                     responsePagePath: '/index.html'
                 }
-            ]
+            ],
+            priceClass: cloudfront.PriceClass.PRICE_CLASS_ALL
         });
         const targetResource = new targets.CloudFrontTarget(clientUIWebDistribution);
 

diff --git a/README.md b/README.md
@@ -9,11 +9,11 @@
 
 Cheet Sheet is an open source Content Management System for developers and development teams to Create, Edit and Share code snippets. This accelerates software engineering by having a centralized place where one can see how they or teammates have solved common problems in the past.
 <br/><br/>
-Setting up Cheet Sheet for you or your organization is simple. All you need is Docker, node and an AWS account. It's 100% Serverless so your costs and infrastructure will scale and grow with minimal effort on your part. ***Read [Getting Started](/docs/getting-started.md)***
+Setting up Cheet Sheet for you or your organization is simple. All you need is Docker, node and an AWS account. It's 100% Serverless so your costs and infrastructure will automatically scale and grow automatically with minimal effort on your part. ***Read [Getting Started](/docs/getting-started.md)***
 <br/><br/>
 Here is my own instance of the application: https://cheet-sheet.gugz.net/
 <br/><br/>
-If you use the app and like it please leave a star. If you find bugs please submit an issue.
+If you use the app and like it please leave a star. If you find bugs feel free to submit an issue.
 
 <h1>Features</h1>
 

diff --git a/docs/architecture-overview.md b/docs/architecture-overview.md
@@ -0,0 +1,21 @@
+# Architecture Diagrams and Overview
+
+## Architecture Diagram
+<p align="left">
+  <img
+    alt="Public View"
+    src="/docs/images/architecture/Remote-Environment.png"
+    width="80%"
+  />
+</p>
+
+
+### Infrastructure Stack
+### Code Stack
+
+## Deployment Process
+
+
+
+
+## Local Development
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -14,13 +14,12 @@ Click [here](/docs/setting-up-remote.md) to learn how to setup and deploy the ap
 ### Set Up Continuous Deployment
 Click [here](/docs/setting-up-ci-cd.md) to learn how to setup continuous deployment through CircleCI. This will automate deployment of changes to the API and UI, so that effort can be focused on designing new features rather than launching them.
 
-### Environment Variable Glossary
-Click [here](/docs/environment-variable-glossary.md) to learn what the different Environment variables in the app are.
+# Other Useful Documents
 
-<!-- # Other Useful Documents
-
-### Architecture Overview
+### Architecture Diagrams and Overview
+Click [here](/docs/architecture-overview.md) to understand how Cheet Sheet is built, and designed.
 
 ### Environment Variable Glossary
+Click [here](/docs/environment-variable-glossary.md) to learn what the different Environment variables in the app are.
 
-### Gained Learnings -->
+<!-- ### Gained Learnings -->
diff --git a/docs/images/architecture/Infrastructure-Stack.png b/docs/images/architecture/Infrastructure-Stack.png
diff --git a/docs/images/architecture/Local-Environment.png b/docs/images/architecture/Local-Environment.png
diff --git a/docs/images/architecture/Network-Stack.png b/docs/images/architecture/Network-Stack.png
diff --git a/docs/images/architecture/Remote- Environment.png b/docs/images/architecture/Remote- Environment.png