MARP-259 mattermost connector - update document

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 is a messaging platform for teams, providing channels for organized communication and collaboration in workplaces. It's known for its ease of use and integration with other tools, helping teams streamline their workflows.
 
-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,39 @@
-<!--
-Dear developer!     
+# Mattermost Connector
 
-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 is a messaging platform for teams, providing channels for organized communication and collaboration in workplaces. It's known for its ease of use and integration with other tools, helping teams streamline their workflows.
 
-# Mattermost Connector
+## Demo
 
-YOUR DESCRIPTION GOES HERE: Please just give a short description here without further headings.
+1. Call Slash command on the masttermost instance's chat
+![call-slash-command](images/slash-command.png)
+2. Click on the link, start and finish task.
+![task-notification-from-ivy](images/task-notification-from-ivy.png)
 
-<!--
-The explanations under "MY-RRODUCT-NAME" are displayed  e.g. for the Connector A-Trust here: https://market.axonivy.com/a-trust#tab-description   
--->
+### Setup
 
-## Demo
+Mattermost Instance
 
-YOUR DEMO DESCRIPTION GOES HERE
+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)
 
-<!--
-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  
--->
+Add the following `Variables` to your `variables.yaml`:
 
-## Setup
+- `Variables.mattermost.baseUrl`
+- `Variables.mattermost.accessToken`
+- `Variables.mattermost.teamName`
+- `Variables.mattermost.botName`
 
-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. 
--->
+and replace the values with your given setup.
 
 ```
 @variables.yaml@
-```
+```