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

Commit

Permalink
New menu - english version (#58)
Browse files Browse the repository at this point in the history
* New menu - english version
  • Loading branch information
jessica-tw committed Apr 19, 2021
1 parent 8e23887 commit e6a4955
Show file tree
Hide file tree
Showing 54 changed files with 214 additions and 277 deletions.
46 changes: 0 additions & 46 deletions content/en/Challenges/What are these challenges.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/en/Challenges/_index.md

This file was deleted.

Expand Up @@ -16,12 +16,12 @@ rit delete credential

Check out how the process works:

![](/docs/large-gif-814x408-.gif)
![](/docs-ritchie/large-gif-814x408-.gif)

## Next steps

On this section, you saw how to delete a credential on Ritchie. If you want to keep reading:

👉 Go to [**how to add providers**](/docs-ritchie/how-to/credentials/add-providers/) section to keep configuring your credentials.
👉 Go to [**how to add providers**](/docs-ritchie/credentials/add-providers/) section to keep configuring your credentials.

👉 Check out the [**list of commands and flags**](/docs-ritchie/reference/list-of-commands-and-flags/) available on Ritchie.
Expand Up @@ -38,5 +38,5 @@ After you chose one of the available providers, Ritchie will ask you to fill the
```

{{% alert color="info" %}}
You can check out on [**formula's editable files**](/docs-ritchie/how-to/formulas/organize-the-formula-folder/) to see how to manipulate the credentials defined in the session as formula input parameters \(inputs in the config.json file\).
You can check out on [**formula's editable files**](/docs-ritchie/formulas/organize-the-formula-folder/) to see how to manipulate the credentials defined in the session as formula input parameters \(inputs in the config.json file\).
{{% /alert %}}
File renamed without changes.
Expand Up @@ -16,7 +16,7 @@ If you're using a previous version just follow the instructions of this section.

## How to build?

After [**creating a formula**](/docs-ritchie/how-to/formulas/create-formulas/), if you want to edit the code of the formula, it's necessary to **build** these changes to test the command with the new implementation.
After [**creating a formula**](/docs-ritchie/formulas/create-formulas/), if you want to edit the code of the formula, it's necessary to **build** these changes to test the command with the new implementation.

To do so, just run the command:

Expand Down
Expand Up @@ -44,7 +44,7 @@ The variable **name** will be convert **uppercase** as the **local variable name
* **text** \(string\),
* **bool** \(boolean\),
* **password** \(hidden string on CLI\),
* **credentials** _\(specific type, learn more informations_ [_**here**_](https://docs.ritchiecli.io/tutorials/credentials#how-to-use-credentials-as-formula-inputs)_\),_
* **credentials** _\(specific type, learn more information_ [_**here**_](/docs-ritchie/credentials/use-credentials-as-formula-inputs/)_\),_
* **dynamic** _\(associated with the optional `request_info` field below\),_
* **path:** enables the autocomplete to inform a path to a folder or a file \(string\).
* `label`: text appearing on the CLI, asking for the input.
Expand Down
Expand Up @@ -20,21 +20,21 @@ rit create formula

Then, you'll have to inform those inputs before running the formula:

1. The **command** \(following the **pattern `rit + group + verb + noun`** to respect the [**tree pattern**](https://docs.ritchiecli.io/key-concepts#command-tree)\).
1. The **command** \(following the **pattern `rit + group + verb + noun`** to respect the [**tree pattern**](/docs-ritchie/reference/glossary/)\).
2. The formula's **programming language**.
3. **The path** used to save formula's files.

Example: `rit demo create formula`

![](/docs/rit_create_formula_demo.gif)
![](/docs-ritchie/rit_create_formula_demo.gif)

### **Step 2: Test your formula**

You can test the formula directly after its creation. That's possible because the **`rit create formula`** command also builds the formula automatically \(it generates the formula's executable files and add them on **.rit folder**\).

In that case, the formula **"Hello World" template** will be executed as shown below:

![](/docs/rit_demo_hello-world_hd.gif)
![](/docs-ritchie/rit_demo_hello-world_hd.gif)

This template is composed of 4 **inputs parameters**, that represents the currently available kinds of inputs to use Ritchie:

Expand Down Expand Up @@ -72,4 +72,4 @@ A repository associated to this workspace will be created on the `/home/user/.ri

On this section, you saw how to create a formula on Ritchie and test it. To keep configuring the formula:

👉 Go to [**build a formula**](/docs-ritchie/how-to/formulas/build-formulas/) to see how to continue the tests on the formulas you create.
👉 Go to [**build a formula**](/docs-ritchie/formulas/build-formulas/) to see how to continue the tests on the formulas you create.
Expand Up @@ -21,12 +21,12 @@ Once you've made this, follow the steps:

**Step 3:** The Ritchie will ask you to confirm if you wish to continue the operation to delete the formula. Just select the answer "yes".

![](/docs/delete-formula.gif)
![](/docs-ritchie/delete-formula.gif)

## Next Steps

On this section, you saw how to delete a formula on Ritchie. To keep reading:

👉 Go to [**how to group formulas**](/docs-ritchie/how-to/formulas/group-formulas/) section to find out how to run a formula inside another formula.
👉 Go to [**how to group formulas**](/docs-ritchie/formulas/group-formulas/) section to find out how to run a formula inside another formula.

👉 Check out all the available formulas on Ritchie in the [**list of commands and flags**](/docs-ritchie/reference/list-of-commands-and-flags/)
Expand Up @@ -8,7 +8,7 @@ description: 'In this section, you will understand how to group formulas on Rit

## What is an aggregation?

On Ritchie, it is possible to **run formulas inside formulas.** This process is called **Formula aggregation.**
On Ritchie, it is possible to **run formulas inside formulas.** This process is called **Formula aggregation**.

This functionality allows you, for example, to make operations in which you need to run consecutive formulas.

Expand Down Expand Up @@ -69,6 +69,6 @@ Depending on the operation, the **`input flags`** used for the command could be

You saw in this section how to use formula aggregation. If you want to keep reading about Ritchie's commands:‌

​👉 Check out the [**challenges**](/docs-ritchie/challenges/what-are-these-challenges/) we created to apply all the Ritchie concepts you learned.‌
​👉 Check out the [**tutorials**](/docs-ritchie/tutorials/) page to apply all Ritchie's concepts you have learned.‌

​👉 Check out our [**list of commands**](/docs-ritchie/reference/list-of-commands-and-flags/) to see the available automations on our community repo.
Expand Up @@ -58,7 +58,7 @@ rit demo hello-world
```
Select an option for each input parameter and see how the magic works:

![](/docs/large-gif-1054x366-.gif)
![](/docs-ritchie/large-gif-1054x366-.gif)

This is the default command line execution, that runs the formula locally using **prompt** to inform the input parameters.

Expand Down Expand Up @@ -123,6 +123,6 @@ In this section, you saw how to run formulas on Ritchie. To keep learning:
- Check which formulas you can run using the following command:


- See how to [**create formula** ](/docs-ritchie/how-to/formulas/create-formulas/).
- See how to [**create formula** ](/docs-ritchie/formulas/create-formulas/).


Expand Up @@ -45,7 +45,7 @@ The user has to inform 5 different kinds of inputs:
4. The **`local repository path`** you wish to publish
5. The **`release version`** to generate

![](/docs/rit-publish-repo.gif)
![](/docs-ritchie/rit-publish-repo.gif)

{{% alert color="warning" %}}

Expand All @@ -69,4 +69,4 @@ To publish a formula manually, you need to push it on a **Github/Gitlab** reposi

On this section, you saw how to publish a formula on Ritchie. To keep configuring the formula:

👉 Check out [**how to share formulas**](/docs-ritchie/how-to/formulas/share-formulas/)
👉 Check out [**how to share formulas**](/docs-ritchie/formulas/share-formulas/).
@@ -1,5 +1,5 @@
---
title: Overview
title: Run Formula
weight: 24
description: 'In this section, you will find a path to how run formulas using Ritchie.'
---
Expand All @@ -17,7 +17,7 @@ It's good to reinforce that the **default formulas execution method** is defined
rit set formula-runner
```

![](/docs/large-gif-1374x404-.gif)
![](/docs-ritchie/large-gif-1374x404-.gif)

### 1. Locally

Expand All @@ -31,7 +31,7 @@ Example: a formula written in **Node** will need **Node installed** on the compu
All formulas can run regardless the programming language used from the moment you have **`DOCKER`** installed and running.

{{% alert color="info" %}}
Check out on the following example [**how to run a "Hello World" formula** ](/docs-ritchie/how-to/formulas/run-formulas/hello-world-formula/)
Check out on the following example [**how to run a "Hello World" formula** ](/docs-ritchie/formulas/hello-world-formula/)
{{% /alert %}}

{{% alert color="warning" %}}
Expand Down Expand Up @@ -64,6 +64,6 @@ All formulas templates contain a **Dockerfile** which creates a container with *

On this section, you saw how to run a formula on Ritchie. To keep learning:

👉 Go to [**Hello World formula**](/docs-ritchie/how-to/formulas/run-formulas/hello-world-formula/) to see different ways to run a formula on Ritchie.
👉 Go to [**Hello World formula**](/docs-ritchie/formulas/hello-world-formula/) to see different ways to run a formula on Ritchie.

👉 Go to the [**create formulas**](/docs-ritchie/how-to/formulas/create-formulas/) section to understand how to create your first automation with Ritchie.
👉 Go to the [**create formulas**](/docs-ritchie/formulas/create-formulas/) section to understand how to create your first automation with Ritchie.
Expand Up @@ -20,7 +20,7 @@ rit add repo

Once the repository has been added, Ritchie will use the selected release on the repository to access the available formulas.

![](/docs/rit-add-repo-3.gif)
![](/docs-ritchie/rit-add-repo-3.gif)

{{% alert color="warning" %}}
If the formula repository is **private**, the user will have to inform his Github/Gitlab token.
Expand Down Expand Up @@ -72,6 +72,6 @@ rit update repo

On this section, you saw how to share a formula on Ritchie. To keep configuring the formula:

👉 Check out how to [**use credentials**](/docs-ritchie/how-to/credentials/use-credentials-as-formula-inputs/) with your formulas.
👉 Check out how to [**use credentials**](/docs-ritchie/credentials/use-credentials-as-formula-inputs/) with your formulas.

👉 Check out our [**list of commands**](/docs-ritchie/reference/list-of-commands-and-flags/) to see the available automations on our community repo.
File renamed without changes.
6 changes: 3 additions & 3 deletions content/en/Getting Started/Initialize Cli.md
Expand Up @@ -18,9 +18,9 @@ This command will ask the user three questions:

1. If he **wants to contribute anonymously** to Ritchie metrics.
2. If he **wants to add the community** formulas locally.
3. If he **wants the default** [**formula execution method**](/docs-ritchie/how-to/formulas/run-formulas/overview/) **to be local or through docker.**
3. If he **wants the default** [**formula execution method**](/docs-ritchie/formulas/run-formula/) **to be local or through docker.**

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

Then, the command execution will create all the necessary configuration's files.

Expand All @@ -36,7 +36,7 @@ rit list repo

This command will return all formulas repositories the user has access locally.

![](/docs/large-gif-1448x466-.gif)
![](/docs-ritchie/large-gif-1448x466.gif)

### 2. Ritchie folder

Expand Down
15 changes: 0 additions & 15 deletions content/en/Getting Started/Install Cli/Introdução.md

This file was deleted.

8 changes: 0 additions & 8 deletions content/en/Getting Started/Install Cli/_index.md

This file was deleted.

@@ -1,5 +1,5 @@
---
title: Linux
title: CLI installation for Linux
weight: 8
description: 'In this section, you will find how to install Ritchie for Linux.'
---
Expand All @@ -23,7 +23,7 @@ curl -fsSL https://commons-repo.ritchiecli.io/install.sh | bash
```

{{% alert color="info" %}}
If you prefer, you also can follow with the[ **manual installation**.](manual-installation)
If you prefer, you also can follow with the[ **manual installation**.](/docs-ritchie/getting-started/manual-installation/)
{{% /alert %}}

## Step 2: Verify installation
Expand Down
@@ -1,5 +1,5 @@
---
title: Macos
title: CLI installation for Macos
weight: 10
description: 'In this section, you will find how to install Ritchie for MacOs.'
---
Expand Down
Expand Up @@ -58,7 +58,7 @@ cp $HOME/Downloads/rit
chmod +x rit
```

### **How to configure the .bashrc ou /etc/profile or .zshrc \(Linux / MacOS\)**
### **How to configure the .bashrc or /etc/profile or .zshrc \(Linux / MacOS\)**

To ZSH, define a new PATH by copying the following code:

Expand Down
@@ -1,5 +1,5 @@
---
title: Windows
title: CLI installation for Windows
weight: 12
description: 'In this section, you will find how to install Ritchie for Windows.'
---
Expand All @@ -13,7 +13,7 @@ To install **the latest version of Ritchie** on Windows, you have to download Ri
You must [**download Ritchie's installer**](https://commons-repo.ritchiecli.io/latest/ritchiecli.msi) to make this configuration. Once you made it, follow the instructions on your terminal.

{{% alert color="info" %}}
If you prefer, you also can proceed with the[ **manual installation**.](manual-installation)
If you prefer, you also can proceed with the[ **manual installation**.](/docs-ritchie/getting-started/manual-installation/)
{{% /alert %}}

## Step 2: Verify installation
Expand Down
46 changes: 0 additions & 46 deletions content/en/Glossary.md

This file was deleted.

7 changes: 0 additions & 7 deletions content/en/How to/Formulas/Run formulas/_index.md

This file was deleted.

6 changes: 0 additions & 6 deletions content/en/How to/Standard Inputs/Input flags/_index.md

This file was deleted.

0 comments on commit e6a4955

Please sign in to comment.