Skip to content
This repository has been archived by the owner on Jul 12, 2022. It is now read-only.

Commit

Permalink
Creating all the new doPortuguese documentation menu (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdcpmoreira committed Apr 19, 2021
1 parent ebece61 commit 8e23887
Show file tree
Hide file tree
Showing 52 changed files with 183 additions and 253 deletions.
12 changes: 0 additions & 12 deletions content/pt-br/Como/Fórmulas/Executar fórmulas/_index.md

This file was deleted.

7 changes: 0 additions & 7 deletions content/pt-br/Como/Standard Inputs/Input flags/_index.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/pt-br/Como/_index.md

This file was deleted.

44 changes: 0 additions & 44 deletions content/pt-br/Desafios/O que são esses desafios.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/pt-br/Desafios/_index.md

This file was deleted.

@@ -1,5 +1,5 @@
---
title: Visão Geral
title: Executar fórmulas
weight: 24
description: >-
Nesta seção, você vai encontrar como executar fórmulas no
Expand Down Expand Up @@ -35,7 +35,7 @@ Exemplo: uma fórmula desenvolvida em **Java** precisará ter **Java instalado**
Todas as fórmulas podem ser executadas sem depender da linguagem usada, desde que o **`DOCKER`** esteja instalado e iniciado.

{{% alert color="info" %}}
Para ver melhor como essa execução funciona na prática, confira a [**seção fórmula hello world** ](/docs-ritchie/pt-br/como/fórmulas/executar-fórmulas/fórmula-hello-world/) para ver como isso funciona na prática.
Para ver melhor como essa execução funciona na prática, confira a [**seção fórmula hello world** ](/docs-ritchie/pt-br/fórmulas/executar-uma-fórmula-hello-world/) para ver como isso funciona na prática.
{{% /alert %}}

{{% alert color="warning" %}}
Expand Down
@@ -1,5 +1,5 @@
---
title: Fórmula "Hello World"
title: Executar uma fórmula "Hello World"
weight: 25
description: >-
Nesta seção, você encontrará o passo a passo para executar nosso "Hello World".
Expand Down
@@ -1,5 +1,5 @@
---
title: Organizar a pasta de fórmula
title: Organizar a pasta de fórmulas
weight: 33
description: >-
Nesta seção, você vai encontrar como organizar a pasta de uma fórmula no Ritchie.
Expand Down
File renamed without changes.
71 changes: 64 additions & 7 deletions content/pt-br/Glossário.md
Expand Up @@ -8,6 +8,50 @@ description: >-

---

Os principais conceitos que fazem parte do Ritchie são:

* Árvore de Comando
* CLI
* Credencial
* Environment (Ambiente)
* Fórmula
* JSON
* Repositório
* Standard Streams

## **Árvore de comando**

No Ritchie, os comandos são agrupados em "árvores". Isso significa que o comando segue o padrão do **Cobra** \(uma biblioteca da linguagem Golang\) usando a seguinte lógica de construção de comandos **core**:

**`RIT + VERBO + SUBSTANTIVO`**

E, para permitir mais opções e liberdade aos usuários, também é possível seguir o padrão abaixo na construção de comandos das fórmulas:

**`RIT + GRUPO + VERBO + SUBSTANTIVO`**

Usamos o prefixo **`rit`** para iniciar nossa árvore de comandos.

![](/docs/arvore-rit%20%281%29%20%281%29.png)

{{% alert color="warning" %}}
O comando **`rit`** é nosso comando pai, ou raiz. Ele não é executável \(ou seja, ele não vai iniciar nenhuma operação se você usar ele sozinho no terminal\).

É necessário utilizar sub-comandos \(que são comandos filhos, ou ramos, do comando **`rit`**\) executáveis para conseguir iniciar algum processo.
{{% /alert %}}

Os comandos executáveis no Ritchie são os comandos localizados no último nível da árvore.

Por exemplo, na imagem acima temos:

* O comando **`rit set context`** é executável, pois está no último nível da árvore.
* O comando **`rit kafka create`** não é executável, pois ele tem um sub-comando **topic** executável no último nível da árvore.

Esse conceito de árvore de comandos é o **núcleo** da estrutura do Ritchie.

{{% alert color="info" %}}
Essa árvore é gerada **dinamicamente** pelo CLI baseado nos repositório de fórmulas adicionados localmente pelo comando**`rit add repo`**.
{{% /alert %}}

## **CLI**

Refere-se à interface de linha de comando, que é o programa responsável por processar comandos de um software ou qualquer programa computacional por meio de texto.
Expand All @@ -16,25 +60,38 @@ Refere-se à interface de linha de comando, que é o programa responsável por p

Refere-se a um parâmetro de entrada reutilizável que você pode utilizar no Ritchie \(exemplo: dados de acessos para alguma ferramenta ou api\).

## **Environment**
## **Environment (Ambiente)**

No Ritchie, cada ambiente \(environment\) possui suas próprias credenciais, que podem ser necessárias para executar fórmulas específicas através do CLI.

_Por exemplo: é possível criar ambientes **pessoal** e **profissional** \(ou **prof** e **staging**\) com diferentes credenciais e trocar de um ambiente para o outro de acordo com suas necessidades._

## **Fórmula**
## **Fórmulas**

As **fórmulas** são **automações**, ou seja, são códigos chamados através das linhas de comando para realizar alguma operação.

### **Execução de fórmulas**

No contexto de Ritchie, uma fórmula é um script que pode ser executado por meio de uma linha de comando, uma vez adaptada à estrutura de Ritchie. Ele permite ao usuário executá-lo localmente ou por meio do Docker, com as dependências necessárias.
{{% alert color="info" %}}
As fórmulas são executadas após executar linhas de comando no terminal.
{{% /alert %}}

Dependendo da fórmula, o usuário pode precisar informar alguns parâmetros de entrada.

Esses parâmetros de entrada podem ser informados de diversas maneiras:

* Depois de executar o comando no terminal \(via **prompt**\)
* Quando digitar a linha de comando no terminal \(via **stdin** ou **input flags**\)
* Durante a execução da fórmula \(se o código usou o **prompt**\)

![](/docs/start-end-ritchie.jpg)

## **JSON**

Refere-se ao JavaScript Object Notation \(JSON\), que é um formato padrão de texto text usado para estruturar dados criados com linguagem de programação Java.

## **Tree**

Refere-se ao grupo de comandos organizados em árvores dentro do Ritchie. Você pode clicar no link para saber mais sobre a [**estrutura do Tree**.](/docs-ritchie/pt-br/principais-conceitos/#árvore-de-comando)

## **Repository**
## **Repositório**

Um local de armazenamento em que você pode organizar features, comandos ou quaisquer arquivos necessários para se usar na ferramenta. No Ritchie, existem três repositórios criados para gerenciar fórmulas, servidor e contribuições:

Expand Down
2 changes: 1 addition & 1 deletion content/pt-br/Guia de começo rápido.md
Expand Up @@ -30,7 +30,7 @@ Assim que finalizar a instalação do rit, é momento de fazer sua inicializaç

### **3. Execução de uma fórmula teste**

Por último, rode um "hello-world" no Ritchie para confirmar se a instalação funcionou. Para isso, basta seguir as orientações da página abaixo.
Por último, rode um "hello-world" no Ritchie para confirmar se a instalação funcionou. Para isso, basta seguir as orientações da página [executar uma fórmula hello world](/docs-ritchie/pt-br/fórmulas/executar-uma-fórmula-hello-world)



Expand Down
2 changes: 1 addition & 1 deletion content/pt-br/Primeiros Passos/Inicialização do Cli.md
Expand Up @@ -18,7 +18,7 @@ Esse comando vai pedir **três informações:**

1. Se o usuário **quer contribuir anonimamente** as métricas do produto.
2. Se o usuário **quer adicionar as fórmulas** da comunidade localmente.
3. Se o usuário **quer usar o** [**método de execução de fórmulas**](/docs-ritchie/pt-br/tutoriais/fórmulas/como-executar-fórmulas/) **local ou via docker**.
3. Se o usuário **quer usar o** [**método de execução de fórmulas**](/docs-ritchie/pt-br/fórmulas/executar-fórmulas/) **local ou via docker**.

![](/docs/rit-init%20%283%29.gif)

Expand Down

This file was deleted.

10 changes: 0 additions & 10 deletions content/pt-br/Primeiros Passos/Instalação do Cli/_index.md

This file was deleted.

@@ -1,5 +1,5 @@
---
title: Linux
title: Instalação do CLI para Linux
weight: 8
description: 'Nesta seção, você verá como instalar o Ritchie para Linux.'
---
Expand All @@ -23,7 +23,7 @@ curl -fsSL https://commons-repo.ritchiecli.io/install.sh | bash
```

{{% alert color="info" %}}
Se preferir, você também pode seguir com a [**instalação manual**](/docs-ritchie/pt-br/primeiros-passos/instalação-do-cli/instalação-manual/)
Se preferir, você também pode seguir com a [**instalação manual**](/docs-ritchie/pt-br/primeiros-passos/instalação-manual/)
{{% /alert %}}

## Passo 2: Verifique a instalação
Expand Down
@@ -1,5 +1,5 @@
---
title: Macos
title: Instalação do CLI para Macos
weight: 10
description: 'Nesta seção, você verá como instalar o Ritchie para MacOs.'
---
Expand Down Expand Up @@ -32,7 +32,7 @@ curl -fsSL https://commons-repo.ritchiecli.io/install.sh | bash
```

{{% alert color="info" %}}
Se preferir, você também pode seguir com a [**instalação manual**.](/docs-ritchie/pt-br/primeiros-passos/instalação-do-cli/instalação-manual/)
Se preferir, você também pode seguir com a [**instalação manual**.](/docs-ritchie/pt-br/primeiros-passos/instalação-manual/)
{{% /alert %}}

### Segunda opção
Expand Down
@@ -1,5 +1,5 @@
---
title: Windows
title: Instalação do CLI para Windows
weight: 12
description: 'Nesta seção, você verá como instalar o Ritchie para Windows.'
---
Expand All @@ -13,7 +13,7 @@ Para instalar a **última versão do Ritchie**, você precisa fazer o **downloa
Você deve fazer o [**download do instalador**](https://commons-repo.ritchiecli.io/latest/ritchiecli.msi) e fazer as configurações necessárias. Basta seguir as instruções que aparecerem no seu terminal.

{{% alert color="info" %}}
Se preferir, você também pode seguir com a [**instalação manual**.](/docs-ritchie/pt-br/primeiros-passos/instalação-do-cli/instalação-manual/)
Se preferir, você também pode seguir com a [**instalação manual**.](/docs-ritchie/pt-br/primeiros-passos/instalação-manual/)
{{% /alert %}}

## Passo 2: Verifique a instalação
Expand Down
71 changes: 0 additions & 71 deletions content/pt-br/Principais conceitos.md

This file was deleted.

0 comments on commit 8e23887

Please sign in to comment.