Refactored integration skeleton

ical4j · Dec 17, 2023 · 299247d · 299247d
1 parent e632732
commit 299247d
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 8 deletions.
diff --git a/docs/integration/chat.md b/docs/integration/chat.md
@@ -0,0 +1,14 @@
+# iCal4j Integration - Chat
+
+Chat applications are at the centre of a growing movement to use chat as an interface to other tools and applications
+(i.e. ChatOps/Chatbots).
+
+iCal4j provides integration with specific chat applications to support query and other functions related to
+calendaring and scheduling.
+
+Supported chat applications include:
+
+* XMPP
+* Slack
+* Google
+* Microsoft
diff --git a/docs/integration/email.md b/docs/integration/email.md
@@ -1,3 +1,7 @@
-# Email Integration
+# iCal4j Integration - Email
+
+Email is typically used to implement the iCalendar iTIP scheduling specification for sharing and negotiating events
+such as meetings, etc.
+
+iCal4j provides support for both sending and receiving iTIP attachments via email.
 
-TBD.
diff --git a/docs/integration/index.md b/docs/integration/index.md
@@ -12,9 +12,13 @@ Email is the most widely supported transport for calendaring systems, however th
 * AWS SNS, SQS, etc. - Cloud-native messaging support
 * JMS - support for Java messaging
 
+## Reactive Streams
 
+iCal4j Integration includes support for [Reactive Streams](http://www.reactive-streams.org/), via the Java 9
+implementation.
 
-### Apache Camel
+
+## Apache Camel
 
 Added the ical4j-integration dependency to your project and configure your routes:
 

diff --git a/docs/integration/reactive.md b/docs/integration/reactive.md
diff --git a/docs/integration/webhooks.md b/docs/integration/webhooks.md
@@ -0,0 +1,12 @@
+# iCal4j Integration - Webhooks
+
+Webhooks are the provision of endpoints that may be used to post content updates from specific tools and applications.
+
+iCal4j provides support for webhooks compatible with specific tools, including:
+
+* Zapier
+* IFTT
+* JIRA
+* Confluence
+* ...
+
diff --git a/docs/integration/websub.md b/docs/integration/websub.md
@@ -0,0 +1,7 @@
+# iCal4j Integration - Websub
+
+Websub is a W3C standard for a publish/subscribe pattern online. Subscription is managed via an intermediary Hub,
+such that when a publisher sends updates to the Hub it is redistributed to subscribers.
+
+iCal4j supports publishing content to a Websub Hub, as well as support for a subscriber callback (i.e. a webhook)
+for consuming Hub content.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -90,7 +90,9 @@ nav:
   - Integration:
     - Overview: integration/index.md
     - Email: integration/email.md
-    - Reactive Streams: integration/reactive.md
+    - Websub: integration/websub.md
+    - Webhooks: integration/webhooks.md
+    - Chat: integration/chat.md
   - Serializer: serializer.md
   - Command:
     - Overview: command/index.md