-
Notifications
You must be signed in to change notification settings - Fork 609
Split comprehensive IG into child pages #8435
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Newest code from mattermost has been published to preview environment for Git SHA 56ee20e |
Newest code from mattermost has been published to preview environment for Git SHA 6adcbaf |
Newest code from mattermost has been published to preview environment for Git SHA 5bcff35 |
Newest code from mattermost has been published to preview environment for Git SHA 6bb48f6 |
|
||
Pre-built plugins | ||
^^^^^^^^^^^^^^^^^ | ||
Learn more about :doc:`Mattermost plugins </integrations-guide/plugins>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we move the learn more links into the sub sections that go directly to the appropriate pages?
ie
pre-built plugins
custom plugins
incoming webhooks
outgoing webhooks
built in slash commands
custom slash commands
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, though I've added the links to each description, leaving the top-level "learn more" links in each section to take users to more details.
|
||
Source code customizations | ||
--------------------------- | ||
Learn more about additional :doc:`no-code automation options </integrations-guide/no-code-automation>` available in Mattermost. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be a sub section on it's own (probably above Playbooks).
No-code automation Platforms
Platforms like n8n, Zapier, or Make provide powerful visual editors that support thousands of connected tools, with triggers and actions that integrate Mattermost to external services, enabling teams to build complex workflows without writing code. Admins migrating from tools like Slack Workflow Builder can recreate familiar automations in Mattermost using these platforms.
Learn more about additional :doc:no-code automation options </integrations-guide/no-code-automation>
available in Mattermost.
|
||
- **Security incident enrichment** | ||
Typing a keyword like ``ioc`` (indicator of compromise) in a security channel can trigger an outgoing webhook that queries a threat intelligence platform. The response can return a formatted message attachment with reputation scores, related incidents, and quick-action buttons for escalating, investigating, or dismissing the alert. | ||
Additionally, Mattermost webhook payloads are :ref:`fully compatible <integrations-guide/incoming-webhooks:slack compatibility>` with Slack’s webhook format to make migration easier. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be part of incoming webhooks rather than outgoing
|
||
- **Knowledge retrieval** | ||
A command like ``/docs search authentication`` queries your documentation system and returns a list of relevant articles as interactive message attachments with links. | ||
You can create custom slash commands that run preconfigured commands that can return a response, such as plain text, rich message content, interactive buttons or forms, directly into a channel. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add as new paragraph to this sub section:
Mattermost's slash command format is Slack compatible, so you can easily migrate your commands from Slack.
Forward new support ticket notifications from systems like Zendesk or ServiceNow into a support channel, ensuring the team can respond quickly to incoming requests. | ||
:doc:`Incoming webhooks </integrations-guide/incoming-webhooks>` allow external applications to post messages into Mattermost channels and direct messages. They are a simple way to receive notifications and data from other services in real-time and require only basic setup. | ||
|
||
Outgoing Webhooks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this brochure version the outgoing webhooks section feels a bit verbose and long. Perhaps we move this content back to the dedicated doc and make this more summarized
Mattermost is an open source, self-hosted alternative to proprietary SaaS services that lock in the data of users and customers. | ||
|
||
While you're welcome to use the Mattermost source code under its open source license, Mattermost, Inc. does not offer support or technical advice for proprietary SaaS projects that result in customers potentially being paywalled from their data should they stop paying SaaS fees. | ||
:doc:`Mattermost Playbooks </end-user-guide/workflow-automation>` lets you define and execute repeatable processes without any coding. Playbooks are often used for incident response, onboarding checklists, or any workflow that involves multiple steps, owners, and notifications. With Playbooks, you can automate certain actions in the process. For instance, a playbook can be configured to automatically open a dedicated channel for an incident, send template messages or task checklists to that channel, update subscribers on status changes, and so on, all through configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The playbooks section also feels verbose for the brochure guide. Perhaps we can summarize it better
Mattermost provides a variety of methods to integrate with your favorite tools, automate critical workflows, and extend the capabilities of the platform. This guide provides a high-level overview of integration options and the level of technical skills required :ref:`(no-code, low-code, or pro-code) <integrations-guide/faq:what is meant by no-code, low-code, and pro-code?>`, and links to detailed documentation for each. | ||
|
||
Choose Your Path | ||
----------------- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This table is a bit hard to read. Wonder if it would make sense to put each item under "best options" on a new line, then in the examples column each line corresponds to the associated example of that option.
ie
no code | Pre-built plugins | Connect Jira, GitHub, Zoom
| No code automation | Automate with Zapier
|
||
Mattermost provides a variety of methods to integrate with your favorite tools, automate critical workflows, and extend the capabilities of the platform. This guide provides a high-level overview of integration options and the level of technical skills required :ref:`(no-code, low-code, or pro-code) <integrations-guide/faq:what is meant by no-code, low-code, and pro-code?>`, and links to detailed documentation for each. | ||
|
||
Choose Your Path |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Honestly given the fact there aren't an overwhelming number of options in this "brochure", we could almost use this table as the TOC. Meaning each subsection of this doc has a row in the "best options" column of the table and an associated example in the examples column.
@esethna, my latest commit incorporates your feedback in this PR. |
Newest code from mattermost has been published to preview environment for Git SHA f74863b |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Carrie, looks good to me
No description provided.