feat: Adjust docs to use vitepress

This commit is contained in:
Faruk AYDIN
2022-08-13 16:54:47 +03:00
parent 2e9d5fb2fc
commit b737cf68ba
46 changed files with 610 additions and 3361 deletions

View File

@@ -0,0 +1,9 @@
# Available Apps
Following integrations are currently supported by Automatisch.
- [Github](/integrations/github)
- [Scheduler](/integrations/scheduler)
- [Slack](/integrations/scheduler)
- [Twitter](/integrations/twitter)
- [Typeform](/integrations/typeform)

View File

@@ -0,0 +1,44 @@
# Installation
<!-- TODO: Add instructions to install PostgreSQL and specify supported node versions -->
Automatisch supports both npm and docker installation.
### npm
You can try Automatisch without installing by using [npx](https://docs.npmjs.com/cli/v8/commands/npx).
```bash
npx automatisch
```
Or you can install Automatisch globally via [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
```bash
npm install automatisch -g
```
You need to run the start command after the installation.
```bash
automatisch start
```
### docker
You can also use [docker](https://docs.docker.com/get-docker/) to install Automatisch.
```bash
docker run -it \
--name automatisch \
-p 3000:3000 \
automatisch start
```
<!-- TODO: Check requirements of https usage and revise the document accordingly -->
## Let's discover!
✌️ That's it; you have Automatisch running. Let's check it out by browsing [http://localhost:3000](http://localhost:3000)
If you see any problem while installing Automatisch, let us know via [github issues](https://github.com/automatisch/automatisch/issues) or our [discord server](https://discord.gg/dJSah9CVrC).

View File

@@ -0,0 +1,28 @@
# Key Concepts
We will cover four main terms of Automatisch before creating our first flow.
## App
👉 Apps are the third-party services you can use with Automatisch like Twitter, Github, Twilio. You can check the complete list of available apps [here](/integrations/available-apps). Automatisch aims to connect those apps to build workflows. So whenever you work with other concepts of Automatisch, you will use apps.
:::tip
You can request a new integration [here](/integrations/request-integration). We will collect all the requests and prioritize the most requested ones.
:::
## Connection
📪 To use an app, you need to add a connection first. Connection is essentially the place where you pass the credentials of the specified service like consumer key, consumer secret, etc., to let Automatisch connect third-party apps on your behalf. Required fields for the connection will be asked when you click 'Add connection' and choose an app. You can also add multiple connections to the same app if you have more than one account to use.
## Flow
🛠️ Flow is the most crucial part of Automatisch. It's a place to arrange the business workflow by connecting multiple steps. So, for example, we can define a flow which does:
- **Search tweets** for the "Automatisch" keyword
- **Send those tweets as an email** to the contributors of Automatisch.
## Step
📄 Steps are the individual items in the flow. In our example, **searching tweets** and **sending an email** are both steps in our flow. Flows can also have more than two steps. Steps have two different types, which are trigger and action. The first step of each flow should be the trigger step, and the following steps should be action steps.

View File

@@ -0,0 +1,15 @@
# Request Integration
You can request a new integration by using [Github discussions](https://github.com/automatisch/automatisch/discussions/categories/integration-request).
:::info
While we are working hard to add as many integrations as possible, it might take some time to see your request is being done. It's because we prefer to collect all integration requests and prioritize the most requested ones.
:::
:::tip
If there is already an integration request for the service you'd like, it's still crucial to upvote that discussion for us to analyze the potential audience around the integration.
:::