From 5b42398a19dcf28d508febc92b90e0d453f441b2 Mon Sep 17 00:00:00 2001 From: Pascal Holy <54705263+pascal-airy@users.noreply.github.com> Date: Thu, 18 Mar 2021 10:28:34 +0100 Subject: [PATCH] [#1263] Airy Core Components: Move to own page (#1276) Resolves #1263 --- docs/docs/getting-started/components.md | 54 +++++++++++++++++++++++ docs/docs/getting-started/introduction.md | 53 +++++----------------- docs/sidebars.js | 1 + 3 files changed, 65 insertions(+), 43 deletions(-) create mode 100644 docs/docs/getting-started/components.md diff --git a/docs/docs/getting-started/components.md b/docs/docs/getting-started/components.md new file mode 100644 index 0000000000..b07410970d --- /dev/null +++ b/docs/docs/getting-started/components.md @@ -0,0 +1,54 @@ +--- +title: Core Components +sidebar_label: Core Components +--- + +import ButtonBoxList from "@site/src/components/ButtonBoxList"; +import ButtonBox from "@site/src/components/ButtonBox"; +import DiamondSVG from "@site/static/icons/diamond.svg"; +import SpeechBalloonSVG from "@site/static/icons/speech-balloon.svg"; +import HighVoltageSVG from "@site/static/icons/high-voltage.svg"; +import ElectricPlugSVG from "@site/static/icons/electric-plug.svg"; +import FishingPoleSVG from "@site/static/icons/fishing-pole.svg"; +import GearSVG from "@site/static/icons/gear.svg"; + +The platform contains the following core components: + + + } + title='Connectors for all conversational sources' + description="Connect anything from our free open-source live chat plugin, Facebook Messenger, Google's Business Messages to your Airy Core. This is all possible through an ingestion platform that heavily relies on Apache Kafka to process incoming webhook data from different sources. We make sense of the data and reshape it into source independent contacts, conversations, and messages." + link='/sources/introduction' +/> + } + title='APIs to access your data' + description="An API to access conversational data with blazing fast HTTP endpoints." + link='/api/endpoints/introduction' +/> + } + title='WebSockets to power real-time applications' + description="A WebSocket server that allows clients to receive near real-time updates about data flowing through the system." + link='/api/websocket' +/> + } + title='Webhook integration to connect custom apps' + description="A webhook integration server that allows its users to programmatically participate in conversations by sending messages (the webhook integration exposes events users can listen to and react programmatically.)" + link='/api/webhook' +/> + } + title='UI: From an inbox to dashboards' + description="Not every message can be handled by code, this is why Airy comes with different UIs ready for you and your teams to use." + link='/apps/ui/introduction' +/> + } + title='Integrations' + description="Pre-made integrations into popular conversational tools, for example NLP tools like Rasa" + link='/integrations/rasa' +/> + diff --git a/docs/docs/getting-started/introduction.md b/docs/docs/getting-started/introduction.md index c3ff5d2e8a..b23dbfbb43 100644 --- a/docs/docs/getting-started/introduction.md +++ b/docs/docs/getting-started/introduction.md @@ -14,6 +14,7 @@ import HighVoltageSVG from "@site/static/icons/high-voltage.svg"; import ElectricPlugSVG from "@site/static/icons/electric-plug.svg"; import FishingPoleSVG from "@site/static/icons/fishing-pole.svg"; import GearSVG from "@site/static/icons/gear.svg"; +import AiryBubbleSVG from "@site/static/icons/airy-bubble.svg"; ## What is Airy Core? @@ -47,6 +48,15 @@ conversational data to wherever you need it. ## Get Started + + } + title='What is Airy?' + description='Learn about Airys messaging platform and components' + link='getting-started/components' +/> + + } @@ -73,46 +83,3 @@ We'll guide you through the following journey: - Send Messages - Use the API to list conversations - Consume directly from Kafka - -## Airy Core Components - -The platform contains the following core components: - - - } - title='Connectors for all conversational sources' - description="Connect anything from our free open-source live chat plugin, Facebook Messenger, Google's Business Messages to your Airy Core. This is all possible through an ingestion platform that heavily relies on Apache Kafka to process incoming webhook data from different sources. We make sense of the data and reshape it into source independent contacts, conversations, and messages." - link='/sources/introduction' -/> - } - title='APIs to access your data' - description="An API to access conversational data with blazing fast HTTP endpoints." - link='/api/endpoints/introduction' -/> - } - title='WebSockets to power real-time applications' - description="A WebSocket server that allows clients to receive near real-time updates about data flowing through the system." - link='/api/websocket' -/> - } - title='Webhook integration to connect custom apps' - description="A webhook integration server that allows its users to programmatically participate in conversations by sending messages (the webhook integration exposes events users can listen to and react programmatically.)" - link='/api/webhook' -/> - } - title='UI: From an inbox to dashboards' - description="Not every message can be handled by code, this is why Airy comes with different UIs ready for you and your teams to use." - link='/apps/ui/introduction' -/> - } - title='Integrations' - description="Pre-made integrations into popular conversational tools, for example NLP tools like Rasa" - link='/integrations/rasa' -/> - diff --git a/docs/sidebars.js b/docs/sidebars.js index 6ac684e00d..8cdbf6ae38 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -3,6 +3,7 @@ module.exports = { { '🚀 Getting Started': [ 'getting-started/introduction', + 'getting-started/components', { Installation: [ 'getting-started/installation/introduction',