-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
revert things that are related to document
- Loading branch information
1 parent
77dbbe8
commit dc72f03
Showing
8 changed files
with
24 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,32 @@ | ||
# Mattermost Connector | ||
<!-- | ||
Dear developer! | ||
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. | ||
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 | ||
--> | ||
|
||
## 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 | ||
<!-- | ||
The explanations under "MY-RRODUCT-NAME" are displayed e.g. for the Connector A-Trust here: https://market.axonivy.com/a-trust#tab-description | ||
--> | ||
|
||
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`: | ||
<!-- | ||
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 | ||
--> | ||
|
||
- `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 | ||
<!-- | ||
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. | ||
--> | ||
|
||
``` | ||
@variables.yaml@ | ||
``` | ||
``` |
Binary file not shown.
Binary file removed
BIN
-49.6 KB
mattermost-connector-product/images/create-personal-access-token.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.