From 57bd363f34b0cb3cf5d4db0927951604e7c98aee Mon Sep 17 00:00:00 2001 From: Ethan Holz Date: Sat, 4 Nov 2023 13:38:53 -0500 Subject: [PATCH] style(docs): updated code highlighted farmer and sprout - Changed `farmer` to farmer - Changed `sprout` to sprout --- src/content/docs/getting-started.mdx | 16 ++++++++-------- src/content/docs/ingredients/file-providers.md | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/content/docs/getting-started.mdx b/src/content/docs/getting-started.mdx index 7e6fbca..6f88443 100644 --- a/src/content/docs/getting-started.mdx +++ b/src/content/docs/getting-started.mdx @@ -60,16 +60,16 @@ Install the CLI on your development machine with the correct command for your ar -You'll be asked some questions, such as which interface the `farmer` is listening on, and which ports to use for communication. -Set the interface to the domain name or IP address of the `farmer`. +You'll be asked some questions, such as which interface the farmer is listening on, and which ports to use for communication. +Set the interface to the domain name or IP address of the farmer. Once configured, the CLI prints out your administrator public key, which you'll need for the next step! It's recommended you now add `grlx` somewhere in your `$PATH`. --- -### 2. Install the `farmer` on the control server +### 2. Install the farmer on the control server -You will then need to install the `farmer` on the control server. The `farmer` is the central server that manages the fleet. +You will then need to install the farmer on the control server. The farmer is the central server that manages the fleet. @@ -180,9 +180,9 @@ You will then need to install the `farmer` on the control server. The `farmer` i --- -### 3. Install the `sprout` on every node you want to manage +### 3. Install the sprout on every node you want to manage -The `sprout` is the agent that runs on every node you want to manage. It's responsible for executing commands and reporting back to the `farmer`. +The sprout is the agent that runs on every node you want to manage. It's responsible for executing commands and reporting back to the farmer. ```bash # or, just run as root instead of sudo @@ -195,9 +195,9 @@ Once the sprout is up and running, return to the CLI. --- -### 4. Accept the TLS cert and the `sprout` keys +### 4. Accept the TLS cert and the sprout keys -Next, you must accept each `sprout`'s public key and the `farmer`'s TLS certificate. This is done using the `keys` command. Furthermore, using `grlx version`, shows you that you are able to connect to your farmer. +Next, you must accept each sprout's public key and the farmer's TLS certificate. This is done using the `keys` command. Furthermore, using `grlx version`, shows you that you are able to connect to your farmer. ```bash grlx version diff --git a/src/content/docs/ingredients/file-providers.md b/src/content/docs/ingredients/file-providers.md index 1db2fdb..a444e1c 100644 --- a/src/content/docs/ingredients/file-providers.md +++ b/src/content/docs/ingredients/file-providers.md @@ -2,7 +2,7 @@ title: grlx.ingedients.file.providers description: grlx built-in file providers --- -`grlx` has a concept of file providers for different ways that you might obtain a file to be added to a given `sprout`. This uses a provider interface to keep this extensible and provide a standard way to use different file types. The `go` interface for File Providers looks like the following: +`grlx` has a concept of file providers for different ways that you might obtain a file to be added to a given sprout. This uses a provider interface to keep this extensible and provide a standard way to use different file types. The `go` interface for File Providers looks like the following: ```go type FileProvider interface { Download(context.Context) error