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.

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

[1092] Merge deployment and installation sections #1096

Merged
merged 1 commit into from
Feb 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/docs/apps/ui/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ in to the UI**

## Introduction

The easiest way to see the Airy Core UI in action is to launch the
[Vagrant Box](getting-started/deployment/vagrant.md) and then follow these three
simple steps.
The easiest way to see the Airy Core UI in action is to launch the [Vagrant
Box](getting-started/installation/vagrant.md) and then follow these three simple
steps.

## Step 1: Registration

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cli/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ airy init
:tada: Congratulations!

You have successfully installed Airy CLI! Next step: Choose a way to [Deploy
Airy Core](/getting-started/deployment/introduction.md)
Airy Core](/getting-started/installation/introduction.md)

</SuccessBox>

Expand Down
37 changes: 0 additions & 37 deletions docs/docs/getting-started/deployment/introduction.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/docs/getting-started/installation.md

This file was deleted.

47 changes: 47 additions & 0 deletions docs/docs/getting-started/installation/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Install Airy Core
sidebar_label: Introduction
---

import useBaseUrl from "@docusaurus/useBaseUrl";
import TLDR from "@site/src/components/TLDR";
import ButtonBoxList from "@site/src/components/ButtonBoxList";
import ButtonBox from "@site/src/components/ButtonBox";
import VagrantSVG from "@site/static/icons/vagrant.svg";
import ProductionSVG from "@site/static/icons/cloud.svg";
import DeploySVG from "@site/static/icons/deploy.svg";

<TLDR>

You can deploy Airy Core in many different ways: **locally** or
**production-ready in your cloud**.

</TLDR>

We recommend to [install](/cli/installation.md) the Airy CLI first which will
aid you in the process of installing and managing your Airy Core instance. It is
easy to install and works on macOS, Windows, and Linux.

## Installation Guides

<ButtonBoxList>
<ButtonBox
icon={() => <DeploySVG />}
title='CLI'
description='Install the Airy Core CLI application'
link='/cli/installation'
/>

<ButtonBox
icon={() => <VagrantSVG />}
title='Local test environment with Vagrant'
description='Step by step guide to run Airy Core on your local machine'
link='getting-started/installation/vagrant'
/>
<ButtonBox
icon={() => <ProductionSVG />}
title='Production ready environment with Kafka'
description='Manual step by step guide for running Airy Core in production'
link='getting-started/installation/production'
/>
</ButtonBoxList>
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@ After the [required services](#requirements) are deployed, you're ready to start
the `Airy Components` inside a Kubernetes cluster.

We provided a Helm chart to deploy the `Airy Components`. Before you can run helm, you
must configure the system. See our [Configuration Docs](/getting-started/deployment/configuration.md) for detailed instructions.
must configure the system. See our [Configuration
Docs](/getting-started/installation/configuration.md) for detailed instructions.

Then you can proceed:

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import TLDR from "@site/src/components/TLDR";

<TLDR>

In this Quickstart we are **setting up our first source, listen to conversations, and
consume directly from Kafka**
In this Quickstart we are **setting up our first source, listen to
conversations, and consume directly from Kafka**

</TLDR>

Expand All @@ -25,8 +25,8 @@ directly in Apache Kafka.
:::info

To get going with the Quickstart, [you must install Airy
first](/getting-started/installation.md). Once you installed Airy and have the CLI
up and running you are good to go.
first](/getting-started/installation/introduction.md). Once you installed Airy and have the
CLI up and running you are good to go.

:::

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/integrations/rasa.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ Airy Core to send and receive messages.

:::note Prerequisites

- A running Airy Core installation [Get Started](getting-started/installation.md)
- A running Airy Core installation [Get
Started](getting-started/installation/introduction.md)
- A local Rasa setup: For convenience, we recommend [the Docker setup](https://rasa.com/docs/rasa/docker/building-in-docker/) or [a demo repository](https://github.com/airyhq/rasa-demo) we created for this guide

:::
Expand Down
34 changes: 23 additions & 11 deletions docs/docs/sources/facebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,13 @@ Core Platform instance.

The Facebook source requires the following configuration:

- [Step 1: Find the App ID and Secret](#step-1-find-the-app-id-and-secret)
- [Step 2: Configure the webhook integration](#step-2-configure-the-webhook-integration)
- [Step 3: Obtain the page token](#step-3-obtain-the-page-token)
- [Configuration](#configuration)
- [Step 1: Find the App ID and Secret](#step-1-find-the-app-id-and-secret)
- [Step 2: Configure the webhook integration](#step-2-configure-the-webhook-integration)
- [Step 3: Obtain the page token](#step-3-obtain-the-page-token)
- [Connect a Facebook page to your instance](#connect-a-facebook-page-to-your-instance)
- [Send messages from a Facebook source](#send-messages-from-a-facebook-source)
- [Send and receive messages with the Inbox UI](#send-and-receive-messages-with-the-inbox-ui)

Let's proceed step by step.

Expand Down Expand Up @@ -66,11 +70,14 @@ Copy and paste your App ID and App Secret as strings next to `appId` and `appSec

:::note

Refer to the [Configuration Docs](/getting-started/deployment/configuration.md#components) on how to input these values.
Refer to the [Configuration
Docs](/getting-started/installation/configuration.md#components) on how to input
these values.

Refer to the [test](getting-started/deployment/vagrant.md#connect-sources) guide
or the [production](getting-started/deployment/production.md#connect-sources)
one to set these variables in your Airy Core instance.
Refer to the [test](getting-started/installation/vagrant.md#connect-sources)
guide or the
[production](getting-started/installation/production.md#connect-sources) one to
set these variables in your Airy Core instance.

:::

Expand Down Expand Up @@ -112,16 +119,21 @@ Your Facebook Webhook URL should have the following format:
`https://fb-RANDOM_STRING.tunnel.airy.co/facebook`
```

Refer to [our section on the Vagrant box status](/getting-started/deployment/vagrant#status) for information about how to find your Facebook Webhook URL.
Refer to [our section on the Vagrant box
status](/getting-started/installation/vagrant#status) for information about how
to find your Facebook Webhook URL.

:::

If you encounter errors, please make sure that the Verify Token matches the `webhookSecret` in `infrastructure/airy.yaml` and that your variables have been successfully set to your Airy Core instance.
If you encounter errors, please make sure that the Verify Token matches the
`webhookSecret` in `infrastructure/airy.yaml` and that your variables have been
successfully set to your Airy Core instance.

:::note

Refer to the [test](/getting-started/deployment/vagrant.md#connect-sources)
Refer to the [test](/getting-started/installation/vagrant.md#connect-sources)
guide or the
[production](/getting-started/deployment/production.md#connect-sources) one to
[production](/getting-started/installation/production.md#connect-sources) one to
set these variables in your Airy Core instance.

:::
Expand Down
15 changes: 7 additions & 8 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,16 @@ module.exports = {
{
'🚀 Getting Started': [
'getting-started/introduction',
'getting-started/installation',
{
'Command Line Interface': ['cli/introduction', 'cli/installation', 'cli/reference'],
Installation: [
'getting-started/installation/introduction',
'getting-started/installation/vagrant',
'getting-started/installation/production',
'getting-started/installation/configuration',
],
},
{
Deployment: [
'getting-started/deployment/introduction',
'getting-started/deployment/vagrant',
'getting-started/deployment/production',
'getting-started/deployment/configuration',
],
'Command Line Interface': ['cli/introduction', 'cli/installation', 'cli/reference'],
},
'getting-started/quickstart',
'getting-started/troubleshooting',
Expand Down