groot/automatisch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Adjust docs to use vitepress

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/docs/pages/connections/github.md Normal file
View File

@@ -0,0 +1,10 @@
# Github
1. Go to the [link](https://github.com/settings/applications/new) to register a **new OAuth application** on Github.
2. Fill **Application name** and **Homepage URL**.
3. Copy **OAuth Redirect URL** from Automatisch to **Authorization callback URL** field on Github page.
4. Click on the **Register application** button on the Github page.
5. Copy the **Client ID** value from the following page to the `Client ID` field on Automatisch.
6. Click **Generate a new client secret** on the Github page and copy generated value into the `Client Secret` field on Automatisch.
7. Click **Submit** button on Automatisch.
8. Congrats! Start using your new Github connection within the flows.

3
packages/docs/pages/connections/scheduler.md Normal file
View File

@@ -0,0 +1,3 @@
# Scheduler
Scheduler is a built-in app shipped with Automatisch, and it doesn't need to talk with any other external service to run. So there are no additional steps to use the Scheduler app.

14
packages/docs/pages/connections/slack.md Normal file
View File

@@ -0,0 +1,14 @@
# Slack
1. Go to the [link](https://api.slack.com/apps?new_app=1) to **create an app** on Slack API.
2. Select **From scratch**.
3. Enter **App name**.
4. Pick the workspace you would like to use with the Slack connection.
5. Click on **Create App** button.
6. Click the **Permissions** card on the **Add features and functionality** section.
7. Go to **Bot Token Scopes** and add the necessary scopes. ([more info](https://api.slack.com/scopes?filter=granular_bot))
8. Go to **OAuth Tokens for Your Workspace** and click **Install to Workspace**.
9. In **Where should Sample post?** section, select the channel you would like to use with Automatisch, and click **Allow**.
10. Copy **Bot User OAuth Token** and paste it to **Access Token** on the Automatisch page.
11. Click **Submit** button on Automatisch.
12. Now, you can start using the Slack connection with Automatisch.

21
packages/docs/pages/connections/twitter.md Normal file
View File

@@ -0,0 +1,21 @@
# Twitter
1. Go to the [Twitter Developer Portal](https://developer.twitter.com/en/portal/projects-and-apps),complete the questionnaire and click the **Let's do this** button.
2. Accept terms & conditions on the following page and click **Submit**.
:::warning
If you see an error saying `There was a problem completing your request. User must have a verified phone number on file prior to submitting application.` Go to the [phone settings page](https://twitter.com/settings/phone) and set up your phone number to be able to continue on step 2.
:::
3. You will get a verification email from Twitter. Click on **Confirm your email** button.
4. Fill out the **App name** field and click on the **Get keys** button.
5. Copy **API Key** and **API Key Secret** values and save them to use later.
6. Click **Dashboard** and **Yes, I saved them** buttons, respectively.
7. Go to the **App settings** link in the project section you have created.
8. Go to the **User authentication settings** section and click **Set up**.
9. Enable **OAuth 1.0a** on the following page.
10. In the **OAuth 1.0A Settings** section, select **Read and write** option.
11. Copy **OAuth Redirect URL** from Automatisch and paste it to the **Callback URI / Redirect URL** field.
12. Fill **Website URL** and click **Save**.
13. Paste **API Key** and **API Key Secret** values you have saved from the 5th step and paste them into Automatisch as **Consumer Key** and **Consumer Secret**, respectively.
14. Congrats! You can start using the new Twitter connection!

10
packages/docs/pages/connections/typeform.md Normal file
View File

@@ -0,0 +1,10 @@
# Typeform
1. Go to the [link](https://admin.typeform.com/user) and click on **Developer apps** in the sidebar.
2. Click on the **Register a new app** button.
3. Fill **App name** and **App website**, and **Developer email** fields.
4. Copy **OAuth Redirect URL** from Automatisch to **Redirect URI(s)** field on the Typeform page.
5. Click on the **Register app** button.
6. Copy **Client ID** and **Client Secret** values from Typeform to Automatisch.
7. Click **Submit** button on Automatisch.
8. Congrats! Typeform connection is created.