MARP-259 mattermost connector - update document (#2)

README.md

@@ -1,7 +1,7 @@
-# MY-PRODUCT-NAME
+# mattermost-connector
 
-[![CI Build](https://github.com/axonivy-market/REPO-NAME/actions/workflows/ci.yml/badge.svg)](https://github.com/axonivy-market/REPO-NAME/actions/workflows/ci.yml)
+[![CI Build](https://github.com/axonivy-market/mattermost-connector/actions/workflows/ci.yml/badge.svg)](https://github.com/axonivy-market/mattermost-connector/actions/workflows/ci.yml)
 
-"YOUR SHORT DESCRIPTION GOES HERE"
+Mattermost enhances team messaging for streamlined workflows and better collaboration.
 
-Read our [documentation](MY-PRODUCT-NAME-product/README.md).
+Read our [documentation](mattermost-connector-product/README.md).

mattermost-connector-product/README.md

@@ -1,32 +1,51 @@
-<!--
-Dear developer!     
-
-When you create your very valuable documentation, please be aware that this Readme.md is not only published on github. This documentation is also processed automatically and published on our website. For this to work, the two headings "Demo" and "Setup" must not be changed
--->
-
 # Mattermost Connector
 
-YOUR DESCRIPTION GOES HERE: Please just give a short description here without further headings.
+Axon Ivy’s mattermost connector helps you to accelerate process automation initiatives by integrating Mattermost features into your process application within no time. This connector:
 
-<!--
-The explanations under "MY-RRODUCT-NAME" are displayed  e.g. for the Connector A-Trust here: https://market.axonivy.com/a-trust#tab-description   
--->
+- Gives you full power to the [Mattermost's APIs](https://api.mattermost.com/).
+- Allow you to start the Axon Ivy process by hitting the slash command key from the mattermost's channel.
+- Allow you to send a message to the mattermost's channel from the Axon Ivy workplace.
+- Notifies users on the channel for new Axon Ivy workflow Tasks.
+- Supports you with an easy-to-copy demo implementation to reduce your integration effort.
 
 ## Demo
 
-YOUR DEMO DESCRIPTION GOES HERE
+1. Hit the slash command key on the channel's chat.
+The Axon Ivy process will be triggered and create a new task.
+The task's information will be sent to the channel by a message.
+
+![call-slash-command](images/slash-command.png)
+
+2. Click on the link, start and finish task.
+The data from this task will be sent back to the channel.
+
+![task-notification-from-ivy](images/task-notification-from-ivy.png)
 
-<!--
-We use all entries under the heading "Demo" for the demo-Tab on our Website, e.g. for the Connector A-Trust here: https://market.axonivy.com/a-trust#tab-demo  
--->
+### Setup
 
-## Setup
+Mattermost Instance
 
-YOUR SETUP DESCRIPTION GOES HERE
-<!--
-The entries under the heading "Setup" are filled in this tab, e.g. for the Connector A-Trust here: https://market.axonivy.com/a-trust#tab-setup. 
--->
+1. Ref to [Deploy Mattermost](https://docs.mattermost.com/guides/deployment.html).
+2. Create Team, User, ...
+3. Go to the System Console to enable Personal Access Tokens
+![enable-personal-access-token](images/enable-personal-access-token.png)
+4. Go to the Profile and create Personal Access Tokens on the Security tab. The Access Token is used for the ivy variable configuration.
+![create-personal-access-token](images/create-personal-access-token.png)
+5. Enable Bot Account Creation and create a bot account for sending notification to the channel Axon Ivy. E.g. axonivy-bot
+6. Create a slash command in the Integrations menu.
+![create-slash-command](images/create-slash-command.png)
+7. Create a incoming webhook for the channel that the axonivy can use and post data to the selected channel.
+![create-incoming-webhook](images/create-incoming-webhook.png)
+
+Add the following `Variables` to your `variables.yaml`:
+
+- `Variables.mattermost.baseUrl`
+- `Variables.mattermost.accessToken`
+- `Variables.mattermost.teamName`
+- `Variables.mattermost.botName`
+
+and replace the values with your given setup.
 
 ```
 @variables.yaml@
-```
+```