From f7ae6cb6bfc2a683f9705a4a82c801ab110f2484 Mon Sep 17 00:00:00 2001 From: Gagan Tunuguntla Date: Tue, 7 Jan 2020 23:30:44 -0500 Subject: [PATCH] rel links attempt --- README.md | 8 ++++---- docs/architecture-overview.md | 12 ++++++------ docs/getting-started.md | 12 ++++++------ docs/setting-up-ci-cd.md | 2 +- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a7a3900..b9f4c80 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ If you use the app and like it please leave a star. If you find bugs feel free t

Public View

@@ -31,7 +31,7 @@ Cheet Sheet is fairly simple to understand. Code snippets are are organized as s

Personal View

@@ -41,7 +41,7 @@ If you sign up for an account and log in, you will have access to your own Perso

Personal View Edit Mode

@@ -52,7 +52,7 @@ You can enter Edit mode by manually toggling it on and off. When on, you can add

Personal View Edit Mode

diff --git a/docs/architecture-overview.md b/docs/architecture-overview.md index 7020bc0..fc8e96c 100644 --- a/docs/architecture-overview.md +++ b/docs/architecture-overview.md @@ -4,7 +4,7 @@

Remote Environment

@@ -21,7 +21,7 @@ The Api Deployment bucket does not play an active role in the Infrastructure. Bu

Deployment Process

@@ -45,7 +45,7 @@ Other things to note:

Infrastructure Stack

@@ -54,7 +54,7 @@ Other things to note:

Code Stack

@@ -63,7 +63,7 @@ Other things to note:

Network Stack

@@ -73,7 +73,7 @@ Other things to note:

Local Environment

diff --git a/docs/getting-started.md b/docs/getting-started.md index 902cf05..176537f 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -3,21 +3,21 @@ This document and the following ones will help you set up Cheet Sheet. ### Preliminary Setup -Click [here](/docs/setting-up-preliminary-tools.md) to read the necessary prep to run the app locally and/or deploy it to AWS. +Click [here](setting-up-preliminary-tools.md) to read the necessary prep to run the app locally and/or deploy it to AWS. ### Set Up and Run Locally -Click [here](/docs/setting-up-locally.md) to learn how to setup and run the app on your local machine. This is good for development and testing. +Click [here](setting-up-locally.md) to learn how to setup and run the app on your local machine. This is good for development and testing. ### Set Up and Deploy to AWS -Click [here](/docs/setting-up-remote.md) to learn how to setup and deploy the app to the cloud so that you and others can use it in real life. +Click [here](setting-up-remote.md) to learn how to setup and deploy the app to the cloud so that you and others can use it in real life. ### 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. +Click [here](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. # Other Useful Documents ### Architecture Diagrams and Overview -Click [here](/docs/architecture-overview.md) to understand how Cheet Sheet is built, and designed. +Click [here](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. +Click [here](environment-variable-glossary.md) to learn what the different Environment variables in the app are. diff --git a/docs/setting-up-ci-cd.md b/docs/setting-up-ci-cd.md index 3a5145a..0e8e1ed 100644 --- a/docs/setting-up-ci-cd.md +++ b/docs/setting-up-ci-cd.md @@ -9,7 +9,7 @@ Continuous Deployment automates the updating of new code in our Api and UI so th ## STEP 2: Create the ENVIRONMENT variable out of your remote.env -1. In [Setting Up And Launching The App On AWS](/docs/setting-up-remote.md) find the `remote.env` file you made for code deploys +1. In [Setting Up And Launching The App On AWS](setting-up-remote.md) find the `remote.env` file you made for code deploys 1. From the `.utils` folder run `node main.js create-infra-env` generate-base64-env. This will encode all contents of the `.env` file as base64 and spit it out. 1. The way we do continuous deployment is by mapping a branch in your repo to an environment variable that has the contents of `remote.env` (base 64 encoded). Out of the box, the following deployment strategies are provided. If you want to change the branch name, environment variable name, or add a new strategy, follow **STEP 3**.