Fix readmes (#319)

* fixed all aws readmes Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * fixed beagle readme Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * fixed bitbucket readmes Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * fixed circleci readmes Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * fixed clean-swift readmes Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * fixed docker readme Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * fixed git readme Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * fixed gitlab readmes Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * removed title from readmes Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * adding markdownlint-disable-file MD041 Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * changing order of readme markdowns Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> * fixing markdown Signed-off-by: JoaoDanielRufino <joaodaniel0405@gmail.com> Co-authored-by: JoaoDanielRufino <joaodaniel0405@gmail.com>
ZupIT · Nov 16, 2020 · 146bce9 · 146bce9
1 parent 910e1af
commit 146bce9
Show file tree

Hide file tree

Showing 22 changed files with 187 additions and 358 deletions.
diff --git a/aws/add/terraform-eks/README.md b/aws/add/terraform-eks/README.md
@@ -1,12 +1,14 @@
-# Terraform aws eks
+# Description
 
-## command
+This formula receives 2 inputs (cluster name, domain name)
+and adds eks module files into the project.
+
+## Command
 
 ```bash
 rit aws add terraform-eks
 ```
 
-## description
+## Requirements
 
-This formula receives 2 inputs (cluster name, domain name)
-and adds eks module files into the project.
+- Golang
diff --git a/aws/add/terraform-vpc/README.md b/aws/add/terraform-vpc/README.md
@@ -1,12 +1,14 @@
-# Terraform aws vpc
+# Description
 
-## command
+This formula receives 5 inputs (region, vpc name, vpc cidr, vpc azs, customer name)
+and adds vpc module files into the project.
+
+## Command
 
 ```bash
 rit aws add terraform-vpc
 ```
 
-## description
+## Requirements
 
-This formula receives 5 inputs (region, vpc name, vpc cidr, vpc azs, customer name)
-and adds vpc module files into the project.
+- Golang
diff --git a/aws/apply/terraform/README.md b/aws/apply/terraform/README.md
@@ -1,50 +1,7 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
 
-# Terraform aws apply
-
-## Premisses
-
-- Set Github credentials
-- Set AWS credentials
-
-You can set credentials by running _rit set credential_ and providing USERNAME, TOKEN and EMAIL for Github and ACCESS KEY ID and SECRET ACCESS KEY for AWS.
-
-## Command
-
-- Prompt
-
-```bash
-rit aws apply terraform
-```
-
-_It is necessary to have [Golang](https://golang.org/doc/install) and [Terraform](https://www.terraform.io/downloads.html) installed for this command to work_
-
-- Docker
-
-```bash
-rit aws apply terraform --docker
-```
-
-_It is necessary to have [Docker installed](https://docs.docker.com/get-docker) for this command to work_
-
-- Stdin
-
-```bash
-echo '{"repository":"https://github.com/eduardorcury/ritchie-demo", "terraform_path":"/terraform", "environment":"dev"}' | rit aws apply terraform --stdin
-```
-
-_It is necessary to have [Golang](https://golang.org/doc/install) and [Terraform](https://www.terraform.io/downloads.html) installed for this command to work_
-
-- Stdin + Docker
-
-```bash
-echo '{"repository":"https://github.com/eduardorcury/ritchie-demo", "terraform_path":"/terraform", "environment":"dev"}' | rit aws apply terraform --stdin --docker
-```
-
-_It is necessary to have [Docker installed](https://docs.docker.com/get-docker) for this command to work_
-
-## Description
+# Description
 
 This command allows the user to execute terraform init, terraform plan and terraform apply command on a given repository. The command also loads the variables located on the files './variables/common.tfvars' and 'variables/**env**.tfvars', where **env** is the environment name provided.
 
@@ -64,6 +21,21 @@ The equivalent terraform apply command is:
 terraform apply -var-file=./variables/common.tfvars -var-file=variables/{ENV}.tfvars -auto-approve
 ```
 
+## Command
+
+```bash
+rit aws apply terraform
+```
+
+## Requirements
+
+- Golang
+- Terraform
+- Set Github credentials
+- Set AWS credentials
+
+You can set credentials by running _rit set credential_ and providing USERNAME, TOKEN and EMAIL for Github and ACCESS KEY ID and SECRET ACCESS KEY for AWS.
+
 ## Demonstration
 
 - Command execution

diff --git a/aws/clean/bucket/README.md b/aws/clean/bucket/README.md
@@ -1,54 +1,33 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
 
-# clean bucket aws
+# Description
 
-## Premisses
-
-- Set AWS credentials ($ rit set credential) with accesskeyid, secretaccesskey
+This AWS Clean Bucket command allows the user to clean a bucket in AWS S3
 
-```bash
-rit set credential
-```
+If the command using stdin method, the question for list and confirm name of the bucket is suppressed.
 
-## command
+The user has to inform 2 different kinds of inputs:
 
-- Prompt
+- the Region Bucket name
 
-```bash
-rit aws clean bucket
-```
+- the Bucket name
 
-- Docker
+## Command
 
 ```bash
-rit aws clean bucket --docker
+rit aws clean bucket
 ```
 
-- Stdin
-
-```bash
-echo '{"region":"us-east-1", "bucket":"ritchie-formulas-demo-stdin"}' | rit aws clean bucket --stdin
-```
+## Requirements
 
-- Stdin + Docker
+- Golang
+- Set AWS credentials (\$ rit set credential) with accesskeyid, secretaccesskey
 
 ```bash
-echo '{"region":"us-east-1", "bucket":"ritchie-formulas-demo-stdin-docker"}' | rit aws clean bucket --stdin --docker
+rit set credential
 ```
 
-## Description
-
-This AWS Clean Bucket command allows the user to clean a bucket in AWS S3
-
-If the command using stdin method, the question for list and confirm name of the bucket is suppressed.
-
-The user has to inform 2 different kinds of inputs:
-
-- the Region Bucket name
-
-- the Bucket name
-
 ## Demonstration
 
 - Command execution

diff --git a/aws/create/bucket/README.md b/aws/create/bucket/README.md
@@ -1,53 +1,32 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
 
-# Create bucket aws
+# Description
 
-## Premisses
+This AWS Create Bucket command allows the user to create a bucket in AWS S3
+If the repository already exists, the user don't receive error.
 
-- Set AWS credentials ($ rit set credential) with accesskeyid, secretaccesskey
+The user has to inform 2 different kinds of inputs:
 
-```bash
-rit set credential
-```
+- the Region Bucket name
 
-## command
+- the Bucket name
 
-- Prompt
+## Command
 
 ```bash
 rit aws create bucket
 ```
 
-- Docker
-
-```bash
-rit aws create bucket --docker
-```
-
-- Stdin
-
-```bash
-echo '{"region":"us-east-1", "bucket":"ritchie-formulas-demo-stdin"}' | rit aws create bucket --stdin
-```
+## Requirements
 
-- Stdin + Docker
+- Golang
+- Set AWS credentials (\$ rit set credential) with accesskeyid, secretaccesskey
 
 ```bash
-echo '{"region":"us-east-1", "bucket":"ritchie-formulas-demo-stdin-docker"}' | rit aws create bucket --stdin --docker
+rit set credential
 ```
 
-## Description
-
-This AWS Create Bucket command allows the user to create a bucket in AWS S3
-If the repository already exists, the user don't receive error.
-
-The user has to inform 2 different kinds of inputs:
-
-- the Region Bucket name
-
-- the Bucket name
-
 ## Demonstration
 
 - Command execution

diff --git a/aws/delete/bucket/README.md b/aws/delete/bucket/README.md
@@ -1,63 +1,42 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
 
-# delete bucket aws
+# Description
 
-## Premisses
-
-- The bucket is clean
-- Set AWS credentials ($ rit set credential) with accesskeyid, secretaccesskey
+This AWS Delete Bucket command allows the user to delete a bucket in AWS S3
 
-```bash
-rit set credential
-```
+If the command using stdin method, the question for list and confirm name of the bucket is suppressed.
 
-## command
+The user has to inform 2 different kinds of inputs:
 
-- Prompt
+- the Region Bucket name
 
-```bash
-rit aws delete bucket
-```
+- the Bucket name
 
-- Docker
+If the bucket has content, you receive the error:
 
 ```bash
-rit aws delete bucket --docker
+error: BucketNotEmpty: The bucket you tried to delete is not empty
 ```
 
-- Stdin
-
-```bash
-echo '{"region":"us-east-1", "bucket":"ritchie-formulas-demo-stdin"}' | rit aws delete bucket --stdin
-```
+For this error you can execute before `rit aws clean bucket`
 
-- Stdin + Docker
+## Command
 
 ```bash
-echo '{"region":"us-east-1", "bucket":"ritchie-formulas-demo-stdin-docker"}' | rit aws delete bucket --stdin --docker
+rit aws delete bucket
 ```
 
-## Description
-
-This AWS Delete Bucket command allows the user to delete a bucket in AWS S3
-
-If the command using stdin method, the question for list and confirm name of the bucket is suppressed.
-
-The user has to inform 2 different kinds of inputs:
-
-- the Region Bucket name
-
-- the Bucket name
+## Requirements
 
-If the bucket has content, you receive the error:
+- Golang
+- The bucket is clean
+- Set AWS credentials (\$ rit set credential) with accesskeyid, secretaccesskey
 
 ```bash
-error: BucketNotEmpty: The bucket you tried to delete is not empty
+rit set credential
 ```
 
-For this error you can execute before `rit aws clean bucket`
-
 ## Demonstration
 
 - Command execution

diff --git a/aws/generate/terraform-project/README.md b/aws/generate/terraform-project/README.md
@@ -1,27 +1,7 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
 
-# Aws generate terraform project
-
-## Premisses
-
-- [Golang](https://golang.org/doc/install) installed
-
-## Command
-
-- Prompt
-
-```bash
-rit aws generate terraform-project
-```
-
-- Stdin
-
-```bash
-echo '{"project_name":"my-terraform-project", "project_location":"/home/user/projects", "bucket_name":"my-aws-bucket", "bucket_region":"us-east-1"}' | rit aws generate terraform-project --stdin
-```
-
-## Description
+# Description
 
 This formula allows the user to generate a terraform based project. The user has to provide 4 different inputs:
 
@@ -49,6 +29,16 @@ The folders and files generated by this commands are as follows:
 
 - A **Makefile** with commands to run _terraform init/plan/apply/destroy_
 
+## Command
+
+```bash
+rit aws generate terraform-project
+```
+
+## Requirements
+
+- [Golang](https://golang.org/doc/install) installed
+
 ## Demonstration
 
 - Command execution