Portal/update readme v2 (#321)

* Update v2 github add collaborator Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 github publish repo Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 github create repo Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 github delete repo Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 github merge branch Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 github navigate handbook Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 github search handbook Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 http generate http-config Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 http perform load-test Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 istio init Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 jupyter create ml_template Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 kafka consume message Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 kafka create topic Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 kafka list topic Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 kafka produce message Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 kubernetes clean heal-configmap Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 kubernetes create port-forward Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 kubernetes show health-status Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 publish repo Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 scaffold generate spring-startero Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 scaffold show spring-starter-dependencies Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 xcode config pre-build Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 kubernetes show logs Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Update v2 - Update Img Urls Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br> * Review 1 Changes Signed-off-by: maurineimirandazup <maurinei.miranda@zup.com.br>
ZupIT · Nov 17, 2020 · ed8e9a9 · ed8e9a9
1 parent 0ddaa0b
commit ed8e9a9
Show file tree

Hide file tree

Showing 24 changed files with 287 additions and 456 deletions.
diff --git a/aws/apply/terraform/README.md b/aws/apply/terraform/README.md
@@ -40,10 +40,10 @@ You can set credentials by running _rit set credential_ and providing USERNAME,
 
 - Command execution
 
-![Demo gif](https://github.com/eduardorcury/ritchie-demo/blob/main/media/rit-demo.gif)
+![Demo gif](https://raw.githubusercontent.com/eduardorcury/ritchie-demo/main/media/rit-demo.gif)
 
 - The created resource
 
 In this demo, an AWS IAM user was created using terraform and ritchie.
 
-![Img](https://github.com/eduardorcury/ritchie-demo/blob/main/media/resource-img.png)
+![Img](https://raw.githubusercontent.com/eduardorcury/ritchie-demo/main/media/resource-img.png)
diff --git a/github/add/collaborator/README.md b/github/add/collaborator/README.md
@@ -1,21 +1,19 @@
-<!-- markdownlint-disable-file MD013 -->
-# Add a collaborator on a repository
+# Description
+
+This formula allows adding a new collaborator by typing only two parameters.
+(collaborator username and repository name)
 
 ## Command
 
 ```bash
 rit github add collaborator
 ```
 
-![Example](https://github.com/ZupIT/ritchie-formulas/raw/master/github/add/collaborator/src/docs/github.gif)
-
-## Description
+## Requirements
 
-This formula allows adding a new collaborator by typing only two parameters.
-(collaborator username and repository name)
+- [Git Installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- Github Account
 
-### STDIN Example
+## Demonstration
 
-```bash
-echo '{"collaborator_user":"value", "repository_name":"value"}' | rit github add collaborator --stdin
-```
+![Example](https://github.com/ZupIT/ritchie-formulas/raw/master/github/add/collaborator/src/docs/github.gif)
diff --git a/github/create/repo/README.md b/github/create/repo/README.md
@@ -1,4 +1,6 @@
-# Create a local and remote repository
+# Description
+
+This Github create command allows the user to create a new Github repository.
 
 ## Command
 
@@ -8,18 +10,9 @@ rit github create repo
 
 ## Requirements
 
-- git installed
-
-- set github username and token credentials using
-
-```bash
-rit set credential
-```
-
-## How to generate personal access token
-
-To generate a personal access token click [here](https://github.com/settings/tokens)
+- [Git Installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- Github Account
 
-## How it works
+## Demonstration
 
 ![gif](https://github.com/ZupIT/ritchie-formulas/raw/master/github/create/repo/doc/github-create-repo.gif)
diff --git a/github/delete/repo/README.md b/github/delete/repo/README.md
@@ -1,48 +1,26 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
 <!-- markdownlint-disable-file MD034 -->
+# Description
 
-# Ritchie Formula
+This Github delete command allows the user to delete a Github PUBLIC or PRIVATE repository on the user domain.
 
-## Premisses
+The user has to inform only one input:
 
-- Set GITHUB credentials ($ rit set credentials) with USERNAME, TOKEN
+- the repository name on Github
 
-## Command
+Ex: The NAME would be "ritchie-formulas" for URL https://github.com/ZupIT/ritchie-formulas
 
-- Prompt
+## Command
 
 ```bash
 rit github delete repo
 ```
 
-- Docker
-
-```bash
-rit github delete repo --docker
-```
-
-- Stdin
-
-```bash
-echo '{"project_name":"dennis-ritchie"}' | rit github delete repo --stdin
-```
+## Requirements
 
-- Stdin + Docker
-
-```bash
-echo '{"project_name":"dennis-ritchie"}' | rit github delete repo --stdin --docker
-```
-
-## Description
-
-This Github delete command allows the user to delete a Github PUBLIC or PRIVATE repository on the user domain.
-
-The user has to inform only one input:
-
-- the repository name on Github
-
-Ex: The NAME would be "ritchie-formulas" for URL https://github.com/ZupIT/ritchie-formulas
+- [Git Installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- Github Account
 
 ## Demonstration
 

diff --git a/github/merge/branch/README.md b/github/merge/branch/README.md
@@ -1,21 +1,7 @@
-# Github merge branch
 
-## Command
-
-```bash
-rit github merge branch
-```
-
-## Requirements
+# Description
 
-- git installed
-
-## How to generate personal access token
-
-To generate a personal access token click
- [here](https://github.com/settings/tokens)
-
-## How it works
+- How it works
 
 ```bash
 git pull origin {{current_branch}}
@@ -31,3 +17,19 @@ If push is true
  git push
  git checkout {{current_branch}}
 ```
+
+## Command
+
+```bash
+rit github merge branch
+```
+
+## Requirements
+
+- [Git Installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- Git Account
+
+## How to generate personal access token
+
+To generate a personal access token click
+ [here](https://github.com/settings/tokens)
diff --git a/github/navigate/handbook/README.md b/github/navigate/handbook/README.md
@@ -1,39 +1,21 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
+# Description
 
-# Github Navigate Handbook
-
-## Premisses
-
-- [Ritchie installed](https://docs.ritchiecli.io/v/v2.0-pt/getting-started/installation)
-- Set Github credentials (\$ rit set credential) with USERNAME, EMAIL and TOKEN.
-
-## How to generate personal access token
-
-To generate a personal access token click [here](https://github.com/settings/tokens)
+Navigate Handbooks from [ZupIT](https://github.com/ZupIT) repositories
 
 ## Command
 
-- Prompt
-
 ```bash
 rit github navigate handbook
 ```
 
-_It is necessary to have [Golang](https://golang.org/doc/install) installed for this command to work_
-
-- Docker
+## Requirements
 
-```bash
-rit github navigate handbook --docker
-```
-
-_It is necessary to have [Docker installed](https://docs.docker.com/get-docker) for this command to work_
-
-## Description
-
-Navigate Handbooks from [ZupIT](https://github.com/ZupIT) repositories
+- [Ritchie installed](https://docs.ritchiecli.io/v/v2.0-pt/getting-started/installation)
+- Set Github credentials (\$ rit set credential) with USERNAME, EMAIL and TOKEN.
+- It is necessary to have [Golang](https://golang.org/doc/install) installed for this command to work_
 
-## Demo
+## Demonstration
 
 <img src="https://github.com/ZupIT/ritchie-formulas/raw/master/github/navigate/handbook/demo.gif">
diff --git a/github/publish/repo/README.md b/github/publish/repo/README.md
@@ -1,39 +1,6 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
-
-# Ritchie Formula
-
-## Premisses
-
-- Set GITHUB credentials ($ rit set credentials) with USERNAME, TOKEN & EMAIL
-
-## Command
-
-- Prompt
-
-```bash
-rit github publish repo
-```
-
-- Docker
-
-```bash
-rit github publish repo --docker
-```
-
-- Stdin
-
-```bash
-echo '{"privacy":"true", "project_name":"ritchie-formulas-demo", "workspace_path":"/home/users/dennis/ritchie-formulas-local", "version":"v1.0.0"}' | rit github publish repo --stdin
-```
-
-- Stdin + Docker
-
-```bash
-echo '{"privacy":"true", "project_name":"ritchie-formulas-demo", "workspace_path":"/home/users/dennis/ritchie-formulas-local", "version":"v1.0.0"}' | rit github publish repo --stdin --docker
-```
-
-## Description
+# Description
 
 This Github publish command allows the user to create a Github Ritchie formulas repository based on a local repository.
 It also generates a release and add it to Ritchie repositories ($ rit add repo).
@@ -49,6 +16,17 @@ The user has to inform 4 different kinds of inputs:
 
 - the release version to generate
 
+## Command
+
+```bash
+rit github publish repo
+```
+
+## Requirements
+
+- [Git Installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- Github Account
+
 ## Demonstration
 
 - Command execution

diff --git a/github/search/handbook/README.md b/github/search/handbook/README.md
@@ -1,14 +1,16 @@
 <!-- markdownlint-disable-file MD013 -->
 <!-- markdownlint-disable-file MD033 -->
+# Description
 
-# Github Search Handbook
+This formula search a handbook on a github repository
 
-## Premisses
+## Command
 
-- [Golang installed](https://golang.org/doc/install)
-- [Ritchie installed](https://docs.ritchiecli.io/v/v2.0-pt/getting-started/installation)
+```bash
+rit github search handbook
+```
 
-## Adding ritchie-formulas to Ritchie CLI
+### Adding ritchie-formulas to Ritchie CLI
 
 - Run command
 
@@ -22,18 +24,11 @@ echo '{"provider":"Github", "name":"demo", "version":"2.0.0", "url":"https://git
 rit add repo
 ```
 
-## Formula Command
-
-- Prompt
+## Requirements
 
-```bash
-rit github search handbook
-```
-
-## description
-
-This formula search a handbook on a github repository
+- [Golang installed](https://golang.org/doc/install)
+- Github Account
 
-## Demo
+## Demonstration
 
 <img src="https://github.com/ZupIT/ritchie-formulas/raw/master/github/search/handbook/demo.gif">
diff --git a/http/generate/http-config/README.md b/http/generate/http-config/README.md
@@ -2,7 +2,7 @@
 <!-- markdownlint-disable-file MD033 -->
 <!-- markdownlint-disable-file MD029 -->
 
-# rit http generate http-config
+# Description
 
 This formula is a helper for ritman http load testing formula, it generates a default configuration template, like the one bellow:
 
@@ -38,6 +38,16 @@ This formula is a helper for ritman http load testing formula, it generates a de
 
 4. The "body" field supports any valid JSON format, so you can fullfill with your disired test content.
 
-## Demo
+## Command
+
+```bash
+rit http generate http-config
+```
+
+## Requirements
+
+- [Golang installed](https://golang.org/doc/install)
+
+## Demonstration
 
 ![Alt Text](https://media1.giphy.com/media/DvpJneeGh2v9TsHkQM/giphy.gif)
diff --git a/http/perform/load-test/README.md b/http/perform/load-test/README.md
@@ -4,7 +4,7 @@
 <!-- markdownlint-disable-file MD001 -->
 <!-- markdownlint-disable-file MD046 -->
 
-# HTTP Load testing tool
+# Description
 
 the "http-load" formula named as Ritman is a tiny http load testing client dedicated for performance testing. As of now, ritman is intended for interactive usage, in a near future you'll be able to integrate on pipelines as a simple command call.
 
@@ -141,6 +141,16 @@ Note:
 
 Acronyns: - avg - stands for average - rps - stands for rate per seconds - ms - stands for milliseconds
 
-## Demo
+## Command
+
+```bash
+rit http perform load-test
+```
+
+## Requirements
+
+- [Golang installed](https://golang.org/doc/install)
+
+## Demostration
 
 ![Alt Text](https://media3.giphy.com/media/KEIZsoInjvzmFUYCcL/giphy.gif)