Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[#1265] Merge cheatsheet from introduction into reference #1277

Merged
merged 5 commits into from
Mar 18, 2021
Merged

[#1265] Merge cheatsheet from introduction into reference #1277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9c1f54d
initial commit
ogbeche77 Mar 17, 2021
0e5aa22
run prettier
ogbeche77 Mar 18, 2021
9bb7504
Implemend suggested changes
ogbeche77 Mar 18, 2021
aa15fe4
Implement suggested changes
ogbeche77 Mar 18, 2021
61fba13
Implement suggested change
ogbeche77 Mar 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/docs/cli/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ import SuccessBox from "@site/src/components/SuccessBox";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<TLDR>

The Airy CLI is a developer tool to help you **build**, **test**, and **manage**
the Airy Core directly from your terminal.

</TLDR>

<TLDR>
Install the CLI quickly with our step-by-step guide or build it from source
</TLDR>
Expand Down
26 changes: 0 additions & 26 deletions docs/docs/cli/introduction.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docs/concepts/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ and reloading the appropriate `Airy Components` based on the provided configurat
## Airy CLI

Every release features a command line binary, used to configure and fetch status
information from your Airy Core instance. This tool is referred to as the [Airy CLI](/cli/introduction.md) throughout the documentation.
information from your Airy Core instance. This tool is referred to as the [Airy CLI](/cli/installation.md) throughout the documentation.
2 changes: 1 addition & 1 deletion docs/docs/getting-started/installation/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ These settings are used to enable or disable some external tools, used to monito

## Applying the configuration

If you made changes in `airy.yaml` and want to apply it to your instance you can use the [airy config apply](/cli/reference.md#config-apply) by running the following [Airy CLI](/cli/introduction.md) command.
If you made changes in `airy.yaml` and want to apply it to your instance you can use the [airy config apply](/cli/reference.md#config-apply) by running the following [Airy CLI](/cli/installation.md) command.

```bash
airy config apply --config ./airy.yaml --kube-config /path/to/your/kube.conf
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/installation/vagrant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ hosts file yourself.

After the bootstrap process finishes, it will download the Kubernetes
configuration file to the local host machine under `~/.airy/kube.conf`. That
file is required for the Airy Command Line tool [Airy CLI](/cli/introduction.md), in order to access
file is required for the Airy Command Line tool [Airy CLI](/cli/installation.md), in order to access
the Kubernetes cluster where your Airy Core instance is running. You can also
use that configuration file with the `kubectl` utility, for example:

Expand Down
2 changes: 1 addition & 1 deletion docs/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ module.exports = {
],
},
{
'Command Line Interface': ['cli/introduction', 'cli/installation', 'cli/reference'],
'Command Line Interface': ['cli/installation', 'cli/reference'],
},
'getting-started/quickstart',
'getting-started/troubleshooting',
Expand Down