Skip to content

Commit

Permalink
Updated the readme to include the new features (#19)
Browse files Browse the repository at this point in the history
* Updated the readme

* fixed review comments

* Fixed lint errors
  • Loading branch information
ayusht2810 authored Feb 12, 2024
1 parent 789389f commit 8650c09
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 11 deletions.
1 change: 0 additions & 1 deletion .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ linters:
- ineffassign
- misspell
- nakedret
- revive
- staticcheck
- stylecheck
- typecheck
Expand Down
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,17 @@ A Mattermost plugin for Confluence. Supports Confluence Cloud, Server, and Data
With the Confluence plugin, you can subscribe to a variety of events in Confluence, and specify which channels the associated notifications will appear in.

- In a Mattermost channel, setup subscriptions to get updates from Confluence and manage your notification subscriptions directly within Mattermost.
- Notify a channel whenever something occurs on a Confluence object:
- Confluence spaces, including those created, updated, deleted, and restored, and those with added comments.
- Confluence pages, including those created, updated, deleted, restored, and those with added, deleted, or updated comments.
- Notify a channel whenever something occurs on a Confluence object, we support the following events:
- space_updated
- page_created
- page_restored
- page_trashed
- page_updated
- comment_created
- comment_updated
- Users can only create subscriptions for the spaces and pages for which they have permission and same for the notifications as well.
- Admins can change permissions for both Mattermost and Confluence side from the plugin configuration.
![image](https://github.com/Brightscout/mattermost-plugin-confluence-fork/assets/90389917/b94fbf84-f345-4ded-aa8d-21de1b870062)

## Configure notifications

Expand All @@ -46,9 +54,13 @@ With the Confluence plugin, you can subscribe to a variety of events in Confluen
![image](https://github.com/mattermost/mattermost-plugin-confluence/assets/74422101/9314abd2-8562-456e-9661-7f23c91db206)

- `Events` are the internal confluence events that will trigger a notification from Confluence. The following events are currently included:
- Confluence spaces, including those created, updated, deleted, and restored, and those with added comments.
- Confluence pages, inlcuidng those created, updated, deleted, restored, and those with added, deleted, or updated comments.

- space_updated
- page_created
- page_restored
- page_trashed
- page_updated
- comment_created
- comment_updated
Example of a configured notification:

![image](https://github.com/mattermost/mattermost-plugin-confluence/assets/74422101/33bc67f8-8d36-4e79-a386-7791f4dcd1ee)
Expand Down
2 changes: 1 addition & 1 deletion plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"key": "RolesAllowedToEditConfluenceSubscriptions",
"display_name": "Mattermost Roles Allowed to Edit Confluence Subscriptions:",
"type": "radio",
"help_text": "Mattermost users who can subscribe channels to confluence space or page.",
"help_text": "Mattermost users who can subscribe channels to Confluence space or page.",
"placeholder": "",
"default": "system_admin",
"options": [
Expand Down
2 changes: 1 addition & 1 deletion server/get_subscription.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

var GetChannelSubscription = &Endpoint{
RequiresAdmin: true,
RequiresAdmin: false,
Path: "/{channelID:[A-Za-z0-9]+}/subscription",
Method: http.MethodGet,
Execute: handleGetChannelSubscription,
Expand Down
2 changes: 1 addition & 1 deletion server/manifest.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion webapp/src/manifest.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const manifest = JSON.parse(`
"key": "RolesAllowedToEditConfluenceSubscriptions",
"display_name": "Mattermost Roles Allowed to Edit Confluence Subscriptions:",
"type": "radio",
"help_text": "Mattermost users who can subscribe channels to confluence space or page.",
"help_text": "Mattermost users who can subscribe channels to Confluence space or page.",
"placeholder": "",
"default": "system_admin",
"options": [
Expand Down

0 comments on commit 8650c09

Please sign in to comment.