From 802a9bd2e2c1241a7f5973663f3f5c7fb6747deb Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 1 Nov 2022 22:08:54 +0100 Subject: [PATCH] docs: Restructure apps documentation, add triggers and actions --- packages/docs/pages/.vitepress/config.js | 87 ++++++++++++++++--- packages/docs/pages/apps/discord/actions.md | 12 +++ .../discord.md => apps/discord/connection.md} | 0 .../flickr.md => apps/flickr/connection.md} | 0 packages/docs/pages/apps/flickr/triggers.md | 21 +++++ packages/docs/pages/apps/github/actions.md | 12 +++ .../github.md => apps/github/connection.md} | 0 packages/docs/pages/apps/github/triggers.md | 21 +++++ .../rss.md => apps/rss/connection.md} | 0 packages/docs/pages/apps/rss/triggers.md | 12 +++ .../scheduler/connection.md} | 0 .../docs/pages/apps/scheduler/triggers.md | 21 +++++ packages/docs/pages/apps/slack/actions.md | 15 ++++ .../slack.md => apps/slack/connection.md} | 0 packages/docs/pages/apps/smtp/actions.md | 12 +++ .../smtp.md => apps/smtp/connection.md} | 0 packages/docs/pages/apps/twilio/actions.md | 12 +++ .../twilio.md => apps/twilio/connection.md} | 0 packages/docs/pages/apps/twilio/triggers.md | 12 +++ packages/docs/pages/apps/twitter/actions.md | 12 +++ .../twitter.md => apps/twitter/connection.md} | 0 packages/docs/pages/apps/twitter/triggers.md | 21 +++++ .../docs/pages/components/CustomListing.vue | 12 +++ packages/docs/pages/guide/available-apps.md | 15 ++-- .../docs/pages/public/favicons/discord.svg | 4 + .../docs/pages/public/favicons/flickr.svg | 5 ++ .../docs/pages/public/favicons/github.svg | 6 ++ packages/docs/pages/public/favicons/rss.svg | 6 ++ .../docs/pages/public/favicons/scheduler.svg | 1 + packages/docs/pages/public/favicons/slack.svg | 6 ++ packages/docs/pages/public/favicons/smtp.svg | 4 + .../docs/pages/public/favicons/twilio.svg | 11 +++ .../docs/pages/public/favicons/twitter.svg | 4 + 33 files changed, 325 insertions(+), 19 deletions(-) create mode 100644 packages/docs/pages/apps/discord/actions.md rename packages/docs/pages/{connections/discord.md => apps/discord/connection.md} (100%) rename packages/docs/pages/{connections/flickr.md => apps/flickr/connection.md} (100%) create mode 100644 packages/docs/pages/apps/flickr/triggers.md create mode 100644 packages/docs/pages/apps/github/actions.md rename packages/docs/pages/{connections/github.md => apps/github/connection.md} (100%) create mode 100644 packages/docs/pages/apps/github/triggers.md rename packages/docs/pages/{connections/rss.md => apps/rss/connection.md} (100%) create mode 100644 packages/docs/pages/apps/rss/triggers.md rename packages/docs/pages/{connections/scheduler.md => apps/scheduler/connection.md} (100%) create mode 100644 packages/docs/pages/apps/scheduler/triggers.md create mode 100644 packages/docs/pages/apps/slack/actions.md rename packages/docs/pages/{connections/slack.md => apps/slack/connection.md} (100%) create mode 100644 packages/docs/pages/apps/smtp/actions.md rename packages/docs/pages/{connections/smtp.md => apps/smtp/connection.md} (100%) create mode 100644 packages/docs/pages/apps/twilio/actions.md rename packages/docs/pages/{connections/twilio.md => apps/twilio/connection.md} (100%) create mode 100644 packages/docs/pages/apps/twilio/triggers.md create mode 100644 packages/docs/pages/apps/twitter/actions.md rename packages/docs/pages/{connections/twitter.md => apps/twitter/connection.md} (100%) create mode 100644 packages/docs/pages/apps/twitter/triggers.md create mode 100644 packages/docs/pages/components/CustomListing.vue create mode 100644 packages/docs/pages/public/favicons/discord.svg create mode 100644 packages/docs/pages/public/favicons/flickr.svg create mode 100644 packages/docs/pages/public/favicons/github.svg create mode 100644 packages/docs/pages/public/favicons/rss.svg create mode 100644 packages/docs/pages/public/favicons/scheduler.svg create mode 100644 packages/docs/pages/public/favicons/slack.svg create mode 100644 packages/docs/pages/public/favicons/smtp.svg create mode 100644 packages/docs/pages/public/favicons/twilio.svg create mode 100644 packages/docs/pages/public/favicons/twitter.svg diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index c8b91438..75d0a509 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -24,25 +24,86 @@ export default defineConfig({ activeMatch: '^/$|^/guide/', }, { - text: 'Connections', - link: '/connections/discord', - activeMatch: '/connections/', + text: 'Apps', + link: '/apps/discord/actions', + activeMatch: '/apps/', }, ], sidebar: { - '/connections/': [ + '/apps/': [ { - text: 'Connections', + text: 'Discord', collapsible: true, items: [ - { text: 'Discord', link: '/connections/discord' }, - { text: 'Flickr', link: '/connections/flickr' }, - { text: 'Github', link: '/connections/github' }, - { text: 'Scheduler', link: '/connections/scheduler' }, - { text: 'Slack', link: '/connections/slack' }, - { text: 'SMTP', link: '/connections/smtp' }, - { text: 'Twilio', link: '/connections/twilio' }, - { text: 'Twitter', link: '/connections/twitter' }, + { text: 'Actions', link: '/apps/discord/actions' }, + { text: 'Connection', link: '/apps/discord/connection' }, + ], + }, + { + text: 'Flickr', + collapsible: true, + items: [ + { text: 'Triggers', link: '/apps/flickr/triggers' }, + { text: 'Connection', link: '/apps/flickr/connection' }, + ], + }, + { + text: 'Github', + collapsible: true, + items: [ + { text: 'Triggers', link: '/apps/github/triggers' }, + { text: 'Actions', link: '/apps/github/actions' }, + { text: 'Connection', link: '/apps/github/connection' }, + ], + }, + { + text: 'RSS', + collapsible: true, + items: [ + { text: 'Triggers', link: '/apps/rss/triggers' }, + { text: 'Connection', link: '/apps/rss/connection' }, + ], + }, + { + text: 'Scheduler', + collapsible: true, + items: [ + { text: 'Triggers', link: '/apps/scheduler/triggers' }, + { text: 'Connection', link: '/apps/scheduler/connection' }, + ], + }, + { + text: 'Slack', + collapsible: true, + items: [ + { text: 'Actions', link: '/apps/slack/actions' }, + { text: 'Connection', link: '/apps/slack/connection' }, + ], + }, + { + text: 'SMTP', + collapsible: true, + items: [ + { text: 'Actions', link: '/apps/smtp/actions' }, + { text: 'Connection', link: '/apps/smtp/connection' }, + ], + }, + { + text: 'Twilio', + collapsible: true, + items: [ + { text: 'Triggers', link: '/apps/twilio/triggers' }, + { text: 'Actions', link: '/apps/twilio/actions' }, + { text: 'Connection', link: '/apps/twilio/connection' }, + ], + }, + { + text: 'Twitter', + collapsible: true, + items: [ + { text: 'Triggers', link: '/apps/twitter/triggers' }, + { text: 'Actions', link: '/apps/twitter/actions' }, + { text: 'Connection', link: '/apps/twitter/connection' }, ], }, ], diff --git a/packages/docs/pages/apps/discord/actions.md b/packages/docs/pages/apps/discord/actions.md new file mode 100644 index 00000000..575410e6 --- /dev/null +++ b/packages/docs/pages/apps/discord/actions.md @@ -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 +--- + + + + diff --git a/packages/docs/pages/connections/discord.md b/packages/docs/pages/apps/discord/connection.md similarity index 100% rename from packages/docs/pages/connections/discord.md rename to packages/docs/pages/apps/discord/connection.md diff --git a/packages/docs/pages/connections/flickr.md b/packages/docs/pages/apps/flickr/connection.md similarity index 100% rename from packages/docs/pages/connections/flickr.md rename to packages/docs/pages/apps/flickr/connection.md diff --git a/packages/docs/pages/apps/flickr/triggers.md b/packages/docs/pages/apps/flickr/triggers.md new file mode 100644 index 00000000..8adef87c --- /dev/null +++ b/packages/docs/pages/apps/flickr/triggers.md @@ -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 +--- + + + + diff --git a/packages/docs/pages/apps/github/actions.md b/packages/docs/pages/apps/github/actions.md new file mode 100644 index 00000000..45afc09b --- /dev/null +++ b/packages/docs/pages/apps/github/actions.md @@ -0,0 +1,12 @@ +--- +items: + - name: Create issue + desc: Create a new issue. + avatar: /favicons/github.svg +--- + + + + diff --git a/packages/docs/pages/connections/github.md b/packages/docs/pages/apps/github/connection.md similarity index 100% rename from packages/docs/pages/connections/github.md rename to packages/docs/pages/apps/github/connection.md diff --git a/packages/docs/pages/apps/github/triggers.md b/packages/docs/pages/apps/github/triggers.md new file mode 100644 index 00000000..783db0bd --- /dev/null +++ b/packages/docs/pages/apps/github/triggers.md @@ -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 +--- + + + + diff --git a/packages/docs/pages/connections/rss.md b/packages/docs/pages/apps/rss/connection.md similarity index 100% rename from packages/docs/pages/connections/rss.md rename to packages/docs/pages/apps/rss/connection.md diff --git a/packages/docs/pages/apps/rss/triggers.md b/packages/docs/pages/apps/rss/triggers.md new file mode 100644 index 00000000..f056341d --- /dev/null +++ b/packages/docs/pages/apps/rss/triggers.md @@ -0,0 +1,12 @@ +--- +items: + - name: New items in feed + desc: Triggers on new RSS feed items. + avatar: /favicons/rss.svg +--- + + + + diff --git a/packages/docs/pages/connections/scheduler.md b/packages/docs/pages/apps/scheduler/connection.md similarity index 100% rename from packages/docs/pages/connections/scheduler.md rename to packages/docs/pages/apps/scheduler/connection.md diff --git a/packages/docs/pages/apps/scheduler/triggers.md b/packages/docs/pages/apps/scheduler/triggers.md new file mode 100644 index 00000000..cc161d3a --- /dev/null +++ b/packages/docs/pages/apps/scheduler/triggers.md @@ -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 +--- + + + + diff --git a/packages/docs/pages/apps/slack/actions.md b/packages/docs/pages/apps/slack/actions.md new file mode 100644 index 00000000..9bbd7ee0 --- /dev/null +++ b/packages/docs/pages/apps/slack/actions.md @@ -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 +--- + + + + diff --git a/packages/docs/pages/connections/slack.md b/packages/docs/pages/apps/slack/connection.md similarity index 100% rename from packages/docs/pages/connections/slack.md rename to packages/docs/pages/apps/slack/connection.md diff --git a/packages/docs/pages/apps/smtp/actions.md b/packages/docs/pages/apps/smtp/actions.md new file mode 100644 index 00000000..90cec3d9 --- /dev/null +++ b/packages/docs/pages/apps/smtp/actions.md @@ -0,0 +1,12 @@ +--- +items: + - name: Send Email + desc: Send an email + avatar: /favicons/smtp.svg +--- + + + + diff --git a/packages/docs/pages/connections/smtp.md b/packages/docs/pages/apps/smtp/connection.md similarity index 100% rename from packages/docs/pages/connections/smtp.md rename to packages/docs/pages/apps/smtp/connection.md diff --git a/packages/docs/pages/apps/twilio/actions.md b/packages/docs/pages/apps/twilio/actions.md new file mode 100644 index 00000000..b377058a --- /dev/null +++ b/packages/docs/pages/apps/twilio/actions.md @@ -0,0 +1,12 @@ +--- +items: + - name: Send SMS + desc: Send an SMS + avatar: /favicons/twilio.svg +--- + + + + diff --git a/packages/docs/pages/connections/twilio.md b/packages/docs/pages/apps/twilio/connection.md similarity index 100% rename from packages/docs/pages/connections/twilio.md rename to packages/docs/pages/apps/twilio/connection.md diff --git a/packages/docs/pages/apps/twilio/triggers.md b/packages/docs/pages/apps/twilio/triggers.md new file mode 100644 index 00000000..7f0be807 --- /dev/null +++ b/packages/docs/pages/apps/twilio/triggers.md @@ -0,0 +1,12 @@ +--- +items: + - name: Receive SMS + desc: Will be triggered when a new SMS is received. + avatar: /favicons/twilio.svg +--- + + + + diff --git a/packages/docs/pages/apps/twitter/actions.md b/packages/docs/pages/apps/twitter/actions.md new file mode 100644 index 00000000..2f4d938f --- /dev/null +++ b/packages/docs/pages/apps/twitter/actions.md @@ -0,0 +1,12 @@ +--- +items: + - name: Create Tweet + desc: Create a tweet. + avatar: /favicons/twitter.svg +--- + + + + diff --git a/packages/docs/pages/connections/twitter.md b/packages/docs/pages/apps/twitter/connection.md similarity index 100% rename from packages/docs/pages/connections/twitter.md rename to packages/docs/pages/apps/twitter/connection.md diff --git a/packages/docs/pages/apps/twitter/triggers.md b/packages/docs/pages/apps/twitter/triggers.md new file mode 100644 index 00000000..5acb4475 --- /dev/null +++ b/packages/docs/pages/apps/twitter/triggers.md @@ -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 +--- + + + + diff --git a/packages/docs/pages/components/CustomListing.vue b/packages/docs/pages/components/CustomListing.vue new file mode 100644 index 00000000..fdc4e42c --- /dev/null +++ b/packages/docs/pages/components/CustomListing.vue @@ -0,0 +1,12 @@ + + + diff --git a/packages/docs/pages/guide/available-apps.md b/packages/docs/pages/guide/available-apps.md index da209151..6fdb5239 100644 --- a/packages/docs/pages/guide/available-apps.md +++ b/packages/docs/pages/guide/available-apps.md @@ -6,9 +6,12 @@ We just have a few available integrations at the moment and we also know that wo Following integrations are currently supported by Automatisch. -- [Flickr](/connections/flickr) -- [Github](/connections/github) -- [Scheduler](/connections/scheduler) -- [Slack](/connections/slack) -- [SMTP](/connections/smtp) -- [Twitter](/connections/twitter) +- [Discord](/apps/discord/actions) +- [Flickr](/apps/flickr/triggers) +- [Github](/apps/github/triggers) +- [RSS](/apps/rss/triggers) +- [Scheduler](/apps/scheduler/triggers) +- [Slack](/apps/slack/actions) +- [SMTP](/apps/smtp/actions) +- [Twilio](/apps/twilio/triggers) +- [Twitter](/apps/twitter/triggers) diff --git a/packages/docs/pages/public/favicons/discord.svg b/packages/docs/pages/public/favicons/discord.svg new file mode 100644 index 00000000..307c7703 --- /dev/null +++ b/packages/docs/pages/public/favicons/discord.svg @@ -0,0 +1,4 @@ + + + + diff --git a/packages/docs/pages/public/favicons/flickr.svg b/packages/docs/pages/public/favicons/flickr.svg new file mode 100644 index 00000000..f8499a7a --- /dev/null +++ b/packages/docs/pages/public/favicons/flickr.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/packages/docs/pages/public/favicons/github.svg b/packages/docs/pages/public/favicons/github.svg new file mode 100644 index 00000000..b49b4e23 --- /dev/null +++ b/packages/docs/pages/public/favicons/github.svg @@ -0,0 +1,6 @@ + diff --git a/packages/docs/pages/public/favicons/rss.svg b/packages/docs/pages/public/favicons/rss.svg new file mode 100644 index 00000000..0c3e5023 --- /dev/null +++ b/packages/docs/pages/public/favicons/rss.svg @@ -0,0 +1,6 @@ + diff --git a/packages/docs/pages/public/favicons/scheduler.svg b/packages/docs/pages/public/favicons/scheduler.svg new file mode 100644 index 00000000..d80c1010 --- /dev/null +++ b/packages/docs/pages/public/favicons/scheduler.svg @@ -0,0 +1 @@ + diff --git a/packages/docs/pages/public/favicons/slack.svg b/packages/docs/pages/public/favicons/slack.svg new file mode 100644 index 00000000..81629c7c --- /dev/null +++ b/packages/docs/pages/public/favicons/slack.svg @@ -0,0 +1,6 @@ + diff --git a/packages/docs/pages/public/favicons/smtp.svg b/packages/docs/pages/public/favicons/smtp.svg new file mode 100644 index 00000000..57f0fa58 --- /dev/null +++ b/packages/docs/pages/public/favicons/smtp.svg @@ -0,0 +1,4 @@ + + + + diff --git a/packages/docs/pages/public/favicons/twilio.svg b/packages/docs/pages/public/favicons/twilio.svg new file mode 100644 index 00000000..7c20e190 --- /dev/null +++ b/packages/docs/pages/public/favicons/twilio.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/packages/docs/pages/public/favicons/twitter.svg b/packages/docs/pages/public/favicons/twitter.svg new file mode 100644 index 00000000..752cdc8d --- /dev/null +++ b/packages/docs/pages/public/favicons/twitter.svg @@ -0,0 +1,4 @@ + + + +