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

docs: Restructure apps documentation, add triggers and actions

Browse Source
This commit is contained in:
Faruk AYDIN
2022-11-01 22:08:54 +01:00
parent b63603afb6
commit 802a9bd2e2
33 changed files with 325 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
packages/docs/pages/apps/discord/actions.md Normal file
View File

@@ -0,0 +1,12 @@
---
items:
- name: Send a message to channel
desc: Send a message to a specific channel you specify.
avatar: /favicons/discord.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

26
packages/docs/pages/apps/discord/connection.md Normal file
View File

@@ -0,0 +1,26 @@
# Discord
:::info
This page explains the steps you need to follow to set up the Discord
connection in Automatisch. If any of the steps are outdated, please let us know!
:::
1. Go to the [link](https://discord.com/developers/applications) to register a **new application** on Discord.
1. Fill **Name**.
1. Check the checkboxes.
1. Click on the **create** button.
1. Go to **OAuth2** > **General** page.
1. Copy the **Client ID** and save it to use later.
1. Reset the **Client secret** to get the initial client secret and copy it to use later.
1. Click the **Add Redirect** button to define a redirect URI.
1. Copy **OAuth Redirect URL** from Automatisch to **Redirect** field.
1. Save the changes.
1. Go to **Bot** page.
1. Click **Add Bot** button.
1. Acknowledge the warning and click **Yes, do it!**.
1. Click **Reset Token** to get the initial bot token and copy it to use later.
1. Fill the **Consumer key** field with the **Client ID** value we copied.
1. Fill the **Consumer secret** field with the **Client Secret** value we copied.
1. Fill the **Bot token** field with the **Bot Token** value we copied.
1. Click **Submit** button on Automatisch.
1. Congrats! Start using your new Discord connection within the flows.

22
packages/docs/pages/apps/flickr/connection.md Normal file
View File

@@ -0,0 +1,22 @@
# Flickr
:::info
This page explains the steps you need to follow to set up the Flickr
connection in Automatisch. If any of the steps are outdated, please let us know!
:::
1. Go to the [link](https://www.flickr.com/services/apps/create/) to **create an
app** on Flickr API.
2. Click **Request an API key**.
3. Apply for a non-commercial key.
4. Fill the field of **What is the name of your app?**.
5. Fill the field of **What are you building?**.
6. Check the checkboxes.
7. Click on **Submit** button.
8. Copy **Key** and **Key Secret** values and save them to use later.
9. Click **Edit auth flow for this app** to configure "Callback URL".
10. Copy **OAuth Redirect URL** from Automatisch and paste it to the **Callback URL** field.
11. Click **Save changes**.
12. Paste **Key** and **Secret** values you have saved from the 8th step and paste them into Automatisch as **Consumer Key** and **Consumer Secret**, respectively.
13. Click **Submit** button on Automatisch.
14. Now, you can start using the Flickr connection with Automatisch.

21
packages/docs/pages/apps/flickr/triggers.md Normal file
View File

@@ -0,0 +1,21 @@
---
items:
- name: New albums
desc: Triggers when you create a new album.
avatar: /favicons/flickr.svg
- name: New favorite photos
desc: Triggers when you favorite a photo.
avatar: /favicons/flickr.svg
- name: New photos
desc: Triggers when you add a new photo.
avatar: /favicons/flickr.svg
- name: New photos in album
desc: Triggers when you add a new photo in an album.
avatar: /favicons/flickr.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

12
packages/docs/pages/apps/github/actions.md Normal file
View File

@@ -0,0 +1,12 @@
---
items:
- name: Create issue
desc: Create a new issue.
avatar: /favicons/github.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

15
packages/docs/pages/apps/github/connection.md Normal file
View File

@@ -0,0 +1,15 @@
# Github
:::info
This page explains the steps you need to follow to set up the Github
connection in Automatisch. If any of the steps are outdated, please let us know!
:::
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.

21
packages/docs/pages/apps/github/triggers.md Normal file
View File

@@ -0,0 +1,21 @@
---
items:
- name: New issue
desc: Triggers when a new issue is created
avatar: /favicons/github.svg
- name: New pull requests
desc: Triggers when a new pull request is created
avatar: /favicons/github.svg
- name: New stargazers
desc: Triggers when a user stars a repository
avatar: /favicons/github.svg
- name: New watchers
desc: Triggers when a user watches a repository
avatar: /favicons/github.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

3
packages/docs/pages/apps/rss/connection.md Normal file
View File

@@ -0,0 +1,3 @@
# RSS
RSS 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 RSS app.

12
packages/docs/pages/apps/rss/triggers.md Normal file
View File

@@ -0,0 +1,12 @@
---
items:
- name: New items in feed
desc: Triggers on new RSS feed items.
avatar: /favicons/rss.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

3
packages/docs/pages/apps/scheduler/connection.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.

21
packages/docs/pages/apps/scheduler/triggers.md Normal file
View File

@@ -0,0 +1,21 @@
---
items:
- name: Every hour
desc: Triggers every hour.
avatar: /favicons/scheduler.svg
- name: Every day
desc: Triggers every day.
avatar: /favicons/scheduler.svg
- name: Every week
desc: Triggers every week.
avatar: /favicons/scheduler.svg
- name: Every month
desc: Triggers every month.
avatar: /favicons/scheduler.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

15
packages/docs/pages/apps/slack/actions.md Normal file
View File

@@ -0,0 +1,15 @@
---
items:
- name: Find message
desc: Find a Slack message using the Slack Search feature.
avatar: /favicons/slack.svg
- name: Send a message to channel
desc: Send a message to a specific channel you specify.
avatar: /favicons/slack.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

23
packages/docs/pages/apps/slack/connection.md Normal file
View File

@@ -0,0 +1,23 @@
# Slack
:::info
This page explains the steps you need to follow to set up the Slack connection in Automatisch. If any of the steps are outdated, please let us know!
:::
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 **User Token Scopes** and add the necessary scopes.
([more info](https://api.slack.com/scopes?filter=user))
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 **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.

12
packages/docs/pages/apps/smtp/actions.md Normal file
View File

@@ -0,0 +1,12 @@
---
items:
- name: Send Email
desc: Send an email
avatar: /favicons/smtp.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

16
packages/docs/pages/apps/smtp/connection.md Normal file
View File

@@ -0,0 +1,16 @@
# SMTP
:::info
This page explains the steps you need to follow to set up the SMTP connection in Automatisch. If any of the steps are outdated, please let us know!
:::
SMTP is a protocol that allows you to send emails. It's a very common protocol and it's used by many email providers. You need to provide the following information to send emails from Automatisch by using SMTP connection.
1. Fill host address field with the SMTP host address.
2. Fill username field with the SMTP username.
3. Fill password field with the SMTP password.
4. Select wheather to use TLS or not.
5. Fill port field with the SMTP port.
6. Fill from field with the email address you want to use as the sender.
7. Click **Submit** button on Automatisch.
8. Now, you can start using the SMTP connection with Automatisch.

12
packages/docs/pages/apps/twilio/actions.md Normal file
View File

@@ -0,0 +1,12 @@
---
items:
- name: Send SMS
desc: Send an SMS
avatar: /favicons/twilio.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

13
packages/docs/pages/apps/twilio/connection.md Normal file
View File

@@ -0,0 +1,13 @@
# Twilio
:::info
This page explains the steps you need to follow to set up the Twilio connection in Automatisch. If any of the steps are outdated, please let us know!
:::
1. Go to the Twilio [console page](https://console.twilio.com)
2. Copy **Account SID** and paste it to **Account SID** field on the
Automatisch connection creation page.
3. Copy **Auth Token** and paste it to **Auth Token** field on the
Automatisch connection creation page.
4. Click **Submit** button on Automatisch.
5. Now you can start using the new Twilio connection!

12
packages/docs/pages/apps/twilio/triggers.md Normal file
View File

@@ -0,0 +1,12 @@
---
items:
- name: Receive SMS
desc: Will be triggered when a new SMS is received.
avatar: /favicons/twilio.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

12
packages/docs/pages/apps/twitter/actions.md Normal file
View File

@@ -0,0 +1,12 @@
---
items:
- name: Create Tweet
desc: Create a tweet.
avatar: /favicons/twitter.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />

25
packages/docs/pages/apps/twitter/connection.md Normal file
View File

@@ -0,0 +1,25 @@
# Twitter
:::info
This page explains the steps you need to follow to set up the Twitter connection in Automatisch. If any of the steps are outdated, please let us know!
:::
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 **API Key** and **API Secret**, respectively.
14. Congrats! You can start using the new Twitter connection!

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

@@ -0,0 +1,21 @@
---
items:
- name: My Tweets
desc: Will be triggered when you tweet something new.
avatar: /favicons/twitter.svg
- name: New Follower of Me
desc: Will be triggered when you have a new follower.
avatar: /favicons/twitter.svg
- name: Search Tweets
desc: Will be triggered when any user tweet something containing a specific keyword, phrase, username or hashtag.
avatar: /favicons/twitter.svg
- name: User Tweets
desc: Will be triggered when a specific user tweet something new.
avatar: /favicons/twitter.svg
---
<script setup>
import CustomListing from '../../components/CustomListing.vue'
</script>
<CustomListing />