feat: added documentation for premium notifications

.github/workflows/build-docs.yml

@@ -15,22 +15,22 @@ jobs:
  runs-on: ubuntu-latest
 
  steps:
- - uses: actions/checkout@v2
- - name: Set up Python 3.9
- uses: actions/setup-python@v2
- with:
- python-version: 3.9
- - name: Install dependencies
- run: |
- python -m pip install --upgrade pip
- - name: Run build script
- run: |
- ./build-docs.sh
- - name: Deploy to github pages
- # run this step only if its a push on the master(main) branch
- # and not a PR from a fork
- if: github.event_name == 'push' 
- uses: peaceiris/actions-gh-pages@v3
- with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_dir: ./site
+  - uses: actions/checkout@v2
+  - name: Set up Python 3.9
+  uses: actions/setup-python@v2
+  with:
+  python-version: 3.9
+  - name: Install dependencies
+  run: |
+  python -m pip install --upgrade pip
+  - name: Run build script
+  run: |
+  ./build-docs.sh
+  - name: Deploy to github pages
+  # run this step only if its a push on the master(main) branch
+  # and not a PR from a fork
+  if: github.event_name == 'push'
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+  github_token: ${{ secrets.GITHUB_TOKEN }}
+  publish_dir: ./site

.gitignore

@@ -1,3 +1,4 @@
 _build
 site
 mkdocs_out
+.idea

docs-md/users/premium-services.md

@@ -0,0 +1,66 @@
+# Ambianic Premium Services
+
+Ambianic Premium Services provide added value and convenience, such as Premium Notifications that minimize the effort required to integrate with third party cloud services. <br /> <br />
+Ambianic Premium Services can be accessed by creating a user account through the [Ambianic PWA](https://github.com/ambianic/ambianic-ui) and selecting a paid subscription plan.
+<br />
+<br />
+
+## User Management
+You only need to create an Ambianic Premium Service account once through the [Ambianic PWA](https://github.com/ambianic/ambianic-ui), You can then sign in to your Ambianic account from any other client device you own..
+
+The following steps highlight the process for creating an Ambianic Premium Service account.
+
+- From the [Ambianic PWA](https://github.com/ambianic/ambianic-ui) NavBar, click the <b>UPGRADE TO PREMIUM</b> button to navigate to the authentication page where you provide your Name, Email and Password details to either create a new account or Sign in to an existing account. Existing Social accounts such as a [Google](https://www.google.com/), [Apple](https://www.apple.com/ng/), [Facebook](https://www.facebook.com/) and [GitHub](https://github.com/) can also be used to quickly create an Ambianic Account. 
+
+ ![Authentication page](../assets/images/signup-screen.png)
+
+With an account created using the step above, you can now purchase the Ambianic Premium Subscription on your account and manage it through the [Ambianic PWA](https://github.com/ambianic/ambianic-ui).
+
+### User Subscription
+
+Premium services within Ambianic are made available to users with an active subscription.
+This subscription which is associated with a user's account, costs a fixed price of <b> $5 dollar</b> and is billed <b> every month </b> on a recurring basis. 
+
+The following steps below highlight the process of purchasing a subscription for your user account using the PWA;
+
+1. From the [Ambianic PWA](https://github.com/ambianic/ambianic-ui) NavBar, click the avatar of the logged-in user to open the user management dropdown modal.
+
+ ![User Management Menu](../assets/images/user-management-menu.png)
+
+2. Click the <b>Add Premium Subscription </b> text within the user management dropdown to open the Premium Subscription modal. 
+ ![Premium Subscription Menu](../assets/images/premium-subscription-menu.png) 
+
+3. Input your credit card details into the appropriate fields within the Premium Subscription modal and confirm the details to purchase the subscription.
+
+You can view all details about your purchased subscription by clicking the user avatar to open the User Management Dropdown modal. 
+These details include `Subscription name`, `expiry date`, and `subscription status`.
+ ![User Management Bar With Subscription](../assets/images/subscription-bar.png) 
+
+!!! note
+ Premium subscriptions would be automatically renewed after expiry, if unsuccessful,
+ a <b>Renew</b> button would be provided in the User Management Dropdown, with which you can use to manually renew your subscription.
+
+!!! warning
+ Clicking the <b>Cancel</b> button would stop the automatic renewal of an active subscription and delete the subscription from the user's account after it's expiry. 
+
+## Premium Notifications
+
+Premium Notifications provides a subscribed user with the feature of receiving notifications about event detections directly from the running edge device, even when not connected to the [Ambianic PWA](https://github.com/ambianic/ambianic-ui).
+<br />
+<br />
+Rather than manually configuring this functionality, Premium Notifications automatically configures the connected Edge Device with Ambianic bearing the costs incurred when notifications are sent. 
+
+!!! note
+ Currently, notifications are sent via email messages to the subscribed user's email address. 
+ However, there are [plans](https://github.com/ambianic/ambianic-subscriptions/issues/15) to also deliver premium notifications via SMS.
+
+<br />
+### Configuring Premium Notifications on Edge Device
+The process to configure the Premium Notifications feature is automatically initiated after a successful subscription or after a previously subscribed user is authenticated with their existing Ambianic Account.
+
+!!! warning
+ The Edge Device is what is configured by the Ambianic PWA, hence a running Edge Device must be connected before the configuration process can be initiated. 
+
+During the configuration process, the Ambianic PWA displays the Edge Configuration modal as shown below and informs the connected Edge Device where the notifications should be sent to.
+
+![Edge Device Sync](../assets/images/ambianic-edge-sync.png) 

docs-md/users/quickstart.md

@@ -65,7 +65,7 @@ The installer will start the service for you. To manage the runtime you can use
 ### Ambianic UI app
 
 [Ambianic UI](https://ui.ambianic.ai/) is a
-modern prorgressive web application (PWA) that provides Plug-and-Play pairing and remote access
+modern progressive web application (PWA) that provides Plug-and-Play pairing and remote access
 to an Ambianic Edge device.
 
 Ambianic UI shows a timeline view with
@@ -74,7 +74,7 @@ timeline screenshot.
 
 ![Timeline](../assets/images/timeline-screen.png)
 
-### Pairing Ambanic UI with Ambianic Edge
+### Pairing Ambianic UI with Ambianic Edge
 
 You can easily pair up your Ambianic UI with Ambianic Edge. It works similar to Airdrop.
 
@@ -98,6 +98,12 @@ The pairing information is persisted on your Ambianic UI client device and you c
 
 When you are ready to explore more advanced capabilities, continue to the next section.
 
+### Ambianic Premium Services
+
+Ambianic provides premium value added services such as email notifications for users who prefer the convenience of automatic integration with third party cloud services.
+
+Read on: [Using Ambianic Premium Services](premium-services.md)
+
 ### Configuration
 
 Ambianic provides flexible configuration options via a configuration YAML file. You can customize: pipelines, input sources, AI models, notification channels and more.

mkdocs.yml

@@ -7,6 +7,7 @@ nav:
  - Quick Start: users/quickstart.md
  - Ambianic Box: users/ambianicbox.md
  - Configuration: users/configure.md
+ - Premium Services: users/premium-services.md
 # - FAQ: users/faq.md
 # - Web UI: users/webui.md
 # - Mobile UI: users/mobileui.md
@@ -34,12 +35,18 @@ nav:
  - p2p architecture: https://webrtchacks.com/private-home-surveillance-with-the-webrtc-datachannel/
  - peerjs-python: https://github.com/ambianic/peerjs-python
  - ambianic-pnp: https://github.com/ambianic/ambianic-pnp
-
+ - Premium Service Cloud API:
+ - Cloud API Documentation: https://github.com/vickywane/ambianic-subscriptions.github.io/tree/main/openapi-docs#installation
+ - OpenAPI Documentation: https://ambianic.github.io/ambianic-subscriptions.github.io/
+
 theme:
  name: mkdocs
  custom_dir: custom_theme/
 copyright: Ambianic.ai © 2019-2021
 docs_dir: docs-md
+
+markdown_extensions:
+ - admonition
 # extra_css:
 # - assets/flowchart.css
 # extra_javascript: