Skip to content

Commit

Permalink
Adding Mattermost-supported plugins to product docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm committed Apr 3, 2024
1 parent 90bf7e6 commit 7f717c8
Show file tree
Hide file tree
Showing 13 changed files with 112 additions and 1 deletion.
2 changes: 1 addition & 1 deletion source/_templates/custom-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ <h4>Contribute</h4>
</div>
</a>
<a
href='https://developers.mattermost.com/integrate/getting-started/'
href='guides/integrate-and-extend.html'
class="masthead-card"
>
<div class="masthead-card__icon">
Expand Down
35 changes: 35 additions & 0 deletions source/guides/integrate-and-extend.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Integrate and extend Mattermost
================================

.. toctree::
:maxdepth: 1
:hidden:
:titlesonly:

AI Copilot plugin </integrate/ai-copilot-plugin>
Channel Export plugin </integrate/channel-export-plugin>
GitHub plugin </integrate/github-plugin>
GitLab plugin </integrate/gitlab-plugin>

Mattermost offers many ways to add functionality and customize the experience to suit your needs.

.. tip::

Visit the `Mattermost Developer Documentation <https://developers.mattermost.com/integrate/getting-started/>`__ for details on developing `webhooks <https://developers.mattermost.com/integrate/webhooks>`__, developing `custom slash commands <https://developers.mattermost.com/integrate/slash-commands/custom/>`_, `custom plugins <https://developers.mattermost.com/integrate/plugins/>`__, building advanced bots and integrations using the `Mattermost REST API <https://api.mattermost.com/>`__, `embedding Mattermost <https://developers.mattermost.com/integrate/customization/embedding/>`__ into web browsers and web apps, `customizing the Mattermost source code <https://developers.mattermost.com/integrate/customization/customization/>`__, and developing `interactive messages <https://developers.mattermost.com/integrate/plugins/interactive-messages/>`__.

Mattermost pre-packaged plugins
-------------------------------

Your Mattermost deployment comes with the following plugins you can configure and use:

* :doc:`AI Copilot plugin </integrate/ai-copilot-plugin>` - Learn how to set up, configure, and use the Mattermost AI Copilot plugin.
* :doc:`Channel Export plugin </integrate/channel-export-plugin>` - Learn how to set up, configure, and use the Mattermost Channel Export plugin.
* :doc:`GitHub plugin </integrate/github-plugin>` - Learn how to integrate Mattermost with your GitHub instance.
* :doc:`GitLab plugin </integrate/gitlab-plugin>` - Learn how to integrate Mattermost with your GitLab instance.
- Google Calendar
- Jira
- Legal hold
- Performance metrics
- Microsoft Teams
- ServiceNow
- Zoom
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Mattermost product documentation
Deploy Mattermost <guides/deployment>
Manage Mattermost <guides/administration>
Use Mattermost <guides/use-mattermost>
Integrate and extend <guides/integrate-and-extend>
Develop with Mattermost <https://developers.mattermost.com/>
Get help with Mattermost <guides/get-help>
Join our community <guides/community-chat>
Expand Down
3 changes: 3 additions & 0 deletions source/integrate/ai-copilot-plugin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
AI Copilot plugin
=================

67 changes: 67 additions & 0 deletions source/integrate/channel-export-plugin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Channel Export plugin
=====================

.. include:: ../_static/badges/ent-cloud-selfhosted.rst
:start-after: :nosearch:

The Mattermost Channel Export plugin enables system administrators to archive, back up, or submit the contents of a channel into other systems to fulfill reporting and auditability requirements as needed.

Enable
------

Mattermost Cloud deployments enable the Channel Export plugin by default. For self-hosted deployments, a system admin must enable the Channel Export plugin in the System Console.

1. Go to **System Console > Plugins > Plugin Management**.
2. Under **Installed Plugins**, scroll to the Channel Export plugin, and select **Enable**.

Once the plugin is enabled, the Channel Export plugin has its own page of configuration settings in the System Console under **Plugins**.

Configure
---------

Go to **System Console > Plugins > Plugin Management > Channel Export** to manage configuration settings for this plugin.

.. tip::

You can also reach the plugin's configuration page from **System Console > Plugins > Plugin Management** by selecting **Settings**.

Outstanding Engineering question: Does the experimental `Export output directory <https://docs.mattermost.com/configure/experimental-configuration-settings.html#export-output-directory>`__ and `Export retention days <https://docs.mattermost.com/configure/experimental-configuration-settings.html#export-retention-days>`__ config settings apply to this plugin?

Upgrade
--------

When a new version of the plugin is released, Mattermost prompts you to update your current version of the plugin to the newest one. There may be a warning shown if there is a major version change that may affect the installation. Generally, updates are seamless and don't interrupt the user experience in Mattermost.

^ is this true for the Channel Export plugin?

Usage
------

Use the ``/export`` slash command in a channel to export the current channel's message data into a CSV-formatted file.

Engineering questions: who can run this slash command -- admins only? what data is/isn't included? Is the admin prompted to download the CSV file?

Frequently asked questions
---------------------------

TBD

Get help
--------

For Mattermost customers: Please open a `Mattermost support case <https://mattermost.zendesk.com/hc/en-us/requests/new>`__ to ensure your issue is tracked properly.

For questions, feedback, and assistance: Please join us on the `Mattermost Discussion Forum <https://forum.mattermost.org/c/plugins>`__.

Alternatively, join our pubic `Mattermost Community Server <https://community.mattermost.com/>`__ and the `Integrations and Apps channel <https://community.mattermost.com/core/channels/integrations>`__ for assistance.

To report a bug, please open a GitHub issue against the `Mattermost Channel Export plugin GitHub repository <https://github.com/mattermost/mattermost-plugin-channel-export>`__.

Customize this plugin
---------------------

This plugin contains both a server and web app portion. See the `Channel Export plugin README documentation <https://github.com/mattermost/mattermost-plugin-channel-export?tab=readme-ov-file#development>`__ on GitHub for details on developing and deploying this plugin.

Read our documentation about the `Mattermost Developer Workflow <https://developers.mattermost.com/extend/plugins/developer-workflow/>`__ and `Mattermost Developer environment setup <https://developers.mattermost.com/extend/plugins/developer-setup/>`__ for information about developing, customizing, and extending Mattermost plugins.


2 changes: 2 additions & 0 deletions source/integrate/github-plugin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
GitHub plugin
==============
3 changes: 3 additions & 0 deletions source/integrate/gitlab-plugin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
GitLab plugin
=============

Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.

0 comments on commit 7f717c8

Please sign in to comment.