diff --git a/README.md b/README.md index 5c1c1c6..0ba0d12 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# mattermost-connector +# MY-PRODUCT-NAME -[![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) +[![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) -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. +"YOUR SHORT DESCRIPTION GOES HERE" -Read our [documentation](mattermost-connector-product/README.md). +Read our [documentation](MY-PRODUCT-NAME-product/README.md). \ No newline at end of file diff --git a/mattermost-connector-product/README.md b/mattermost-connector-product/README.md index d659560..8a278ea 100644 --- a/mattermost-connector-product/README.md +++ b/mattermost-connector-product/README.md @@ -1,39 +1,32 @@ -# Mattermost Connector + -## Demo +# Mattermost Connector -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) +YOUR DESCRIPTION GOES HERE: Please just give a short description here without further headings. -### Setup + -Mattermost Instance +## Demo -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) +YOUR DEMO DESCRIPTION GOES HERE -Add the following `Variables` to your `variables.yaml`: + -- `Variables.mattermost.baseUrl` -- `Variables.mattermost.accessToken` -- `Variables.mattermost.teamName` -- `Variables.mattermost.botName` +## Setup -and replace the values with your given setup. +YOUR SETUP DESCRIPTION GOES HERE + ``` @variables.yaml@ -``` +``` \ No newline at end of file diff --git a/mattermost-connector-product/images/create-incoming-webhook.png b/mattermost-connector-product/images/create-incoming-webhook.png deleted file mode 100644 index da63144..0000000 Binary files a/mattermost-connector-product/images/create-incoming-webhook.png and /dev/null differ diff --git a/mattermost-connector-product/images/create-personal-access-token.png b/mattermost-connector-product/images/create-personal-access-token.png deleted file mode 100644 index c4e10b0..0000000 Binary files a/mattermost-connector-product/images/create-personal-access-token.png and /dev/null differ diff --git a/mattermost-connector-product/images/create-slash-command.png b/mattermost-connector-product/images/create-slash-command.png deleted file mode 100644 index 64dfee8..0000000 Binary files a/mattermost-connector-product/images/create-slash-command.png and /dev/null differ diff --git a/mattermost-connector-product/images/enable-personal-access-token.png b/mattermost-connector-product/images/enable-personal-access-token.png deleted file mode 100644 index 37546be..0000000 Binary files a/mattermost-connector-product/images/enable-personal-access-token.png and /dev/null differ diff --git a/mattermost-connector-product/images/slash-command.png b/mattermost-connector-product/images/slash-command.png deleted file mode 100644 index d9db6ef..0000000 Binary files a/mattermost-connector-product/images/slash-command.png and /dev/null differ diff --git a/mattermost-connector-product/images/task-notification-from-ivy.png b/mattermost-connector-product/images/task-notification-from-ivy.png deleted file mode 100644 index 1dac1e4..0000000 Binary files a/mattermost-connector-product/images/task-notification-from-ivy.png and /dev/null differ