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

Commit

Permalink
fix: links (#154)
Browse files Browse the repository at this point in the history
* fix: links

Signed-off-by: KelsonCarmozine <kelson.carmozine@zup.com.br>
  • Loading branch information
kelsoncarmozinezup committed Oct 8, 2021
1 parent ae3c69f commit e7692e9
Show file tree
Hide file tree
Showing 155 changed files with 186 additions and 544 deletions.
8 changes: 3 additions & 5 deletions config.toml
Expand Up @@ -85,15 +85,15 @@ version_menu = "Versões"
[[languages.pt-br.menu.main]]
name = "Sobre"
weight = 20
url = "/pt-br/sobre-ritchie"
url = "/pt-br/referência/sobre-ritchie"
[[languages.pt-br.menu.main]]
name = "FAQ"
weight = 20
url = "/pt-br/faq/"
url = "/pt-br/referência/faq/"
[[languages.pt-br.menu.main]]
name = "Glossário"
weight = 20
url = "/pt-br/glossário"
url = "/pt-br/referência/glossário"

[markup]
[markup.goldmark]
Expand Down Expand Up @@ -222,5 +222,3 @@ desc = "Discuss development issues around the project"
icon = "fa fa-envelope"
name = "Developer mailing list"
url = ""


4 changes: 2 additions & 2 deletions content/en/Credentials/Delete credentials.md
Expand Up @@ -22,6 +22,6 @@ Check out how the process works:

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

👉 Go to [**how to add providers**]({{< ref path="Credentials/Add providers.md" >}}) section to keep configuring your credentials.
👉 Go to [**how to add providers**]({{< ref path="Credentials/Add providers" >}}) section to keep configuring your credentials.

👉 Check out the [**list of commands and flags**]({{< ref path="Reference/List of commands and flags.md" >}}) available on Ritchie.
👉 Check out the [**list of commands and flags**]({{< ref path="Reference/List of commands and flags" >}}) available on Ritchie.
2 changes: 1 addition & 1 deletion content/en/Credentials/Set credentials.md
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**]({{< ref path="/Formulas/Organize the Formula Folder.md" >}}) 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**]({{< ref path="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 %}}
Expand Up @@ -53,4 +53,4 @@ github default {"token":"***", "email":"***", "username":"***"}

You saw in this section how to deal with credentials on Ritchie.

👉 Check the [**commands list**]({{< ref path="Reference/List of commands and flags.md" >}}) to see the available automations on our community repo.
👉 Check the [**commands list**]({{< ref path="Reference/List of commands and flags" >}}) to see the available automations on our community repo.
3 changes: 1 addition & 2 deletions content/en/Formulas/Build formulas.md
Expand Up @@ -16,8 +16,7 @@ If you're using a previous version just follow the instructions of this section.

## How to build?

After [**creating a formula**]({{< ref path="/Formulas/Create formulas.md" >}}), 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**]({{< ref path="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 @@ -62,7 +62,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, check out more on [**use crendential as formula inputs**]({{< ref path="/Credentials/Use credentials as formula inputs.md" >}})\_\),
- **credentials** \(specific type, check out more on [**use crendential as formula inputs**]({{< ref path="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
4 changes: 2 additions & 2 deletions content/en/Formulas/Create formulas.md
Expand Up @@ -20,7 +20,7 @@ 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**]({{< ref path="/Reference/Glossary.md" >}})\).
1. The **command** \(following the **pattern `rit + group + verb + noun`** to respect the [**tree pattern**]({{< ref path="Reference/Glossary" >}})\).
2. The formula's **programming language**.
3. **The path** used to save formula's files.

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 [**organize the formula folder**]({{< ref path="/Formulas/Organize the Formula Folder.md" >}}) to see how to organize the formulas you create.
👉 Go to [**organize the formula folder**]({{< ref path="formulas/Organize the formula folder" >}}) to see how to organize the formulas you create.
4 changes: 2 additions & 2 deletions content/en/Formulas/Delete formulas.md
Expand Up @@ -29,6 +29,6 @@ Once you've made this, follow the steps:

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

👉 Go to [**how to group formulas**]({{< ref path="/Formulas/Group formulas.md" >}}) section to find out how to run a formula inside another formula.
👉 Go to [**how to group formulas**]({{< ref path="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**]({{< ref path="Reference/List of commands and flags.md" >}}).
👉 Check out all the available formulas on Ritchie in the [**list of commands and flags**]({{< ref path="Reference/List of commands and flags" >}}).
6 changes: 3 additions & 3 deletions content/en/Formulas/Group formulas.md
Expand Up @@ -22,7 +22,7 @@ To group formulas, it is necessary to use **Standard Inputs**. On the following

### 2. Execution <a id="2-execution"></a>

When [**implementing a formula**]({{< ref path="/Formulas/Configure Inputs.md" >}}), the file where the operation is coded needs to execute a command line associated to a formula.‌
When [**implementing a formula**]({{< ref path="Formulas/Configure inputs" >}}), the file where the operation is coded needs to execute a command line associated to a formula.‌

The grouped formula command line needs to be executed using **Standard Inputs**, which means informing the inputs parameters directly on the code.‌

Expand Down Expand Up @@ -67,6 +67,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 [**tutorials**]({{< ref path="Tutorials.md" >}}) page to apply all Ritchie's concepts you have learned.‌
​👉 Check out the [**tutorials**]({{< ref path="Tutorials" >}}) page to apply all Ritchie's concepts you have learned.‌

​👉 Check out our [**list of commands**]({{< ref path="Reference/List of commands and flags.md" >}}) to see the available automations on our community repo.
​👉 Check out our [**list of commands**]({{< ref path="Reference/List of commands and flags" >}}) to see the available automations on our community repo.
Expand Up @@ -115,4 +115,4 @@ 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** ]({{< ref path="/Formulas/Create formulas.md" >}}).
- See how to [**create formula** ]({{< ref path="Formulas/Create formulas" >}}).
2 changes: 1 addition & 1 deletion content/en/Formulas/Publish formulas.md
Expand Up @@ -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**]({{< ref path="/Formulas/Share formulas.md" >}}).
👉 Check out [**how to share formulas**]({{< ref path="Formulas/Share formulas" >}}).
48 changes: 0 additions & 48 deletions content/en/Formulas/Rename formulas.md

This file was deleted.

6 changes: 3 additions & 3 deletions content/en/Formulas/Run formula.md
Expand Up @@ -30,7 +30,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** ](/formulas/hello-world-formula/)
Check out on the following example [**how to run a "Hello World" formula** ]({{< ref path="Formulas/Hello world formula" >}}).
{{% /alert %}}

{{% alert color="warning" %}}
Expand Down Expand Up @@ -63,6 +63,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**]({{< ref path="/Formulas/Hello World Formula.md" >}}) to see different ways to run a formula on Ritchie.
👉 Go to [**Hello World formula**]({{< ref path="Formulas/Hello world formula" >}}) to see different ways to run a formula on Ritchie.

👉 Go to the [**create formulas**]({{< ref path="/Formulas/Create formulas.md" >}}) section to understand how to create your first automation with Ritchie.
👉 Go to the [**create formulas**]({{< ref path="Formulas/Create formulas" >}}) section to understand how to create your first automation with Ritchie.
8 changes: 4 additions & 4 deletions content/en/Formulas/Share formulas.md
Expand Up @@ -64,11 +64,11 @@ To do so, just follow these steps:

{{% alert color="info" %}}

This feature is available from Ritchie 2.11 version.
This feature is available from Ritchie 2.11 version.

{{% /alert %}}

When you work with various formula groups, it may be hard to remember all the available commands.
When you work with various formula groups, it may be hard to remember all the available commands.

If you want to list formulas from a specific repository, follow the steps below:

Expand Down Expand Up @@ -108,6 +108,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**]({{< ref path="Credentials/Use credentials as formula inputs.md" >}}) with your formulas.
👉 Check out how to [**use credentials**]({{< ref path="Credentials/Use credentials as formula inputs" >}}) with your formulas.

👉 Check out our [**list of commands**]({{< ref path="Reference/List of commands and flags.md" >}}) to see the available automations on our community repo.
👉 Check out our [**list of commands**]({{< ref path="Reference/List of commands and flags" >}}) to see the available automations on our community repo.
8 changes: 4 additions & 4 deletions content/en/Formulas/Workspaces.md
Expand Up @@ -15,11 +15,11 @@ Repositories and workspaces are used to interact with formulas on Ritchie, but t

**`repository`** You can use repository commands to import formulas from `Git repositories` and execute them.

Check out an example to add a repository on the [**Hello World Formula**]({{< ref path="/Formulas/Hello World Formula.md" >}}) section.
*See an example to add a repository on the [**Hello World Formula**]({{< ref path="Formulas/Hello world formula" >}}) section.*

Commands for repos and workspaces are similar, they allow the CLI to "see" available formulas on your local machine. Workspaces have **higher priority** than Repos, for example, if you use both commands for the same formulas' repositories, the workspaces' formulas will be executed.

Check out more about workspace and repositories commands [**in the list of commands and flags**]({{< ref path="Reference/List of commands and flags.md" >}}).
Check out more about workspace and repositories commands [**in the list of commands and flags**]({{< ref path="Reference/List of commands and flags" >}}).

## How to add?

Expand All @@ -35,7 +35,7 @@ After that, follow the next steps:

**Step 2:** Inform the workspace path on the local machine.

![](/docs-ritchie/shared/rit-add-workspace.gif)
![](/shared/rit-add-workspace.gif)

## How to list?

Expand Down Expand Up @@ -81,4 +81,4 @@ After that, follow the next steps:

In this section, you saw how to use workspaces on Ritchie. Now

👉 Check out all the available formulas on Ritchie in the [**list of commands and flags**]({{< ref path="Reference/List of commands and flags.md" >}}).
👉 Check out all the available formulas on Ritchie in the [**list of commands and flags**]({{< ref path="Reference/List of commands and flags" >}}).
Expand Up @@ -18,7 +18,7 @@ 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**]({{< ref path="/Formulas/Run formula.md" >}}) **to be local or through docker.**
3. If he **wants the default** [**formula execution method**]({{< ref path="Formulas/Run formula" >}}) **to be local or through docker.**

![](/shared/rit-init.gif)

Expand Down
Expand Up @@ -12,7 +12,7 @@ If you want to efficiently use Ritchie on Linux with version **`2.0.5 and earlie

* The **make** command

Once you have it, just run the command below at your terminal:
Once you have it, just run the command below at your terminal.

## Step 1: Installing command

Expand All @@ -38,21 +38,23 @@ To download a specific package or version, just paste the URL on your browser re

#### Red Hat Package Manager

```text
```url
https://commons-repo.ritchiecli.io/{VERSION}/installer/ritchie.rpm
```

#### Debian

```text
```url
https://commons-repo.ritchiecli.io/{VERSION}/installer/ritchie.deb
```

#### Arch Linux

The `tar.gz` package is available on this [**Arch Linux user repository**](https://aur.archlinux.org/packages/ritchie-cli/) page ([**repository reference**](https://github.com/avelino/ritchie-cli-archpack)).

_If you prefer, you also can follow with the[ **manual installation**.](/docs-ritchie/getting-started/manual-installation/)_
{{% alert color="info" %}}
If you prefer, you also can follow with the[ **manual installation**.]({{< ref path="Getting started/Manual installation" >}}).
{{% /alert %}}

## Step 2: Verify installation

Expand Down
Expand Up @@ -39,7 +39,7 @@ curl -fsSL https://commons-repo.ritchiecli.io/install.sh | sed -e 's/sudo//g' |
```
{{% /alert %}}

If you prefer, you also can follow with the [**manual installation**.]({{< ref path="/Getting Started/Manual Installation.md" >}})
If you prefer, you also can follow with the [**manual installation**.]({{< ref path="Getting started/Manual installation" >}}).

### Second option

Expand Down
Expand Up @@ -28,7 +28,7 @@ winget install Ritchie-CLI
When you finish, follow the instructions on your terminal after running the `rit` command.

{{% alert color="info" %}}
If you prefer, you also can proceed with the[ **manual installation**.]({{< ref path="/Getting Started/Manual Installation.md" >}})
If you prefer, you also can proceed with the[ **manual installation**.]({{< ref path="Getting started/Manual installation" >}}).
{{% /alert %}}

## Step 2: Verify installation
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions content/en/Quick start guide.md
Expand Up @@ -14,15 +14,15 @@ To use Ritchie, you must follow these **3 steps**:

### **1. Installation**

First you have to install Ritchie according to your operating system. Check out more in the [**Getting Started section**]({{< ref path="Getting Started.md" >}})
First you have to install Ritchie according to your operating system. Check out more in the [**Getting Started section**]({{< ref path="Getting started" >}}).

### **2. Initialization**

Once you finished Ritchie's installation, it is necessary to initialize it. To do so, see more information on the [**Initialize CLI page**]({{< ref path="/Getting Started/Initialize Cli.md" >}}).
Once you finished Ritchie's installation, it is necessary to initialize it. To do so, see more information on the [**Initialize CLI page**]({{< ref path="Getting started/Initialize cli" >}}).

### **3. Running a test formula**

Last \(but not least\), run a [**"hello-world"**]({{< ref path="/Formulas/Hello World Formula.md" >}}) on Ritchie to confirm if your installation went well. Check out more on [**Formulas section**]({{< ref path="Formulas.md" >}}).
Last \(but not least\), run a [**"hello-world"**]({{< ref path="Formulas/Hello world formula" >}}) on Ritchie to confirm if your installation went well. Check out more on [**Formulas section**]({{< ref path="Formulas" >}}).

{{% alert color="success" %}}
Well done, you're ready to use Ritchie on your projects!
Expand Down
Expand Up @@ -2,7 +2,6 @@
title: About Ritchie
weight: 102
description: You will find in this section more details about Ritchie's story.
toc_hide: true
---

---
Expand Down Expand Up @@ -34,4 +33,4 @@ So, instead of writing down on the command lines which parameters and / or argum

In the example below, we have the execution of a scaffold command with the coffee formula. As the user signals which formula he wants to use, the system automatically passes, line by line, asking which specific parameters must be considered to perform the desired action.

![](/shared/rit-scaffold-generate-coffe-go.gif)
![](/shared/rit-scaffold-generate-coffee-go.gif)

0 comments on commit e7692e9

Please sign in to comment.