From 7f717c8ab81cab96a666211f74f35a8e35e64180 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Wed, 3 Apr 2024 16:14:01 -0400 Subject: [PATCH] Adding Mattermost-supported plugins to product docs --- source/_templates/custom-index.html | 2 +- source/guides/integrate-and-extend.rst | 35 ++++++++++ source/index.rst | 1 + source/integrate/ai-copilot-plugin.rst | 3 + source/integrate/channel-export-plugin.rst | 67 +++++++++++++++++++ source/integrate/github-plugin.rst | 2 + source/integrate/gitlab-plugin.rst | 3 + source/integrate/google-calendar-plugin.rst | 0 source/integrate/jira-plugin.rst | 0 source/integrate/legal-hold-plugin.rst | 0 .../integrate/performance-metrics-plugin.rst | 0 source/integrate/servicenow-plugin.rst | 0 source/integrate/zoom-plugin.rst | 0 13 files changed, 112 insertions(+), 1 deletion(-) create mode 100644 source/guides/integrate-and-extend.rst create mode 100644 source/integrate/ai-copilot-plugin.rst create mode 100644 source/integrate/channel-export-plugin.rst create mode 100644 source/integrate/github-plugin.rst create mode 100644 source/integrate/gitlab-plugin.rst create mode 100644 source/integrate/google-calendar-plugin.rst create mode 100644 source/integrate/jira-plugin.rst create mode 100644 source/integrate/legal-hold-plugin.rst create mode 100644 source/integrate/performance-metrics-plugin.rst create mode 100644 source/integrate/servicenow-plugin.rst create mode 100644 source/integrate/zoom-plugin.rst diff --git a/source/_templates/custom-index.html b/source/_templates/custom-index.html index 79363ed4820..9dad91fa203 100644 --- a/source/_templates/custom-index.html +++ b/source/_templates/custom-index.html @@ -299,7 +299,7 @@

Contribute

diff --git a/source/guides/integrate-and-extend.rst b/source/guides/integrate-and-extend.rst new file mode 100644 index 00000000000..a2bdd49f1ca --- /dev/null +++ b/source/guides/integrate-and-extend.rst @@ -0,0 +1,35 @@ +Integrate and extend Mattermost +================================ + +.. toctree:: + :maxdepth: 1 + :hidden: + :titlesonly: + + AI Copilot plugin + Channel Export plugin + GitHub plugin + GitLab plugin + +Mattermost offers many ways to add functionality and customize the experience to suit your needs. + +.. tip:: + + Visit the `Mattermost Developer Documentation `__ for details on developing `webhooks `__, developing `custom slash commands `_, `custom plugins `__, building advanced bots and integrations using the `Mattermost REST API `__, `embedding Mattermost `__ into web browsers and web apps, `customizing the Mattermost source code `__, and developing `interactive messages `__. + +Mattermost pre-packaged plugins +------------------------------- + +Your Mattermost deployment comes with the following plugins you can configure and use: + +* :doc:`AI Copilot plugin ` - Learn how to set up, configure, and use the Mattermost AI Copilot plugin. +* :doc:`Channel Export plugin ` - Learn how to set up, configure, and use the Mattermost Channel Export plugin. +* :doc:`GitHub plugin ` - Learn how to integrate Mattermost with your GitHub instance. +* :doc:`GitLab plugin ` - Learn how to integrate Mattermost with your GitLab instance. +- Google Calendar +- Jira +- Legal hold +- Performance metrics +- Microsoft Teams +- ServiceNow +- Zoom \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 4e7f6143118..d31c8a8b41e 100644 --- a/source/index.rst +++ b/source/index.rst @@ -19,6 +19,7 @@ Mattermost product documentation Deploy Mattermost Manage Mattermost Use Mattermost + Integrate and extend Develop with Mattermost Get help with Mattermost Join our community diff --git a/source/integrate/ai-copilot-plugin.rst b/source/integrate/ai-copilot-plugin.rst new file mode 100644 index 00000000000..01e2b18ee10 --- /dev/null +++ b/source/integrate/ai-copilot-plugin.rst @@ -0,0 +1,3 @@ +AI Copilot plugin +================= + diff --git a/source/integrate/channel-export-plugin.rst b/source/integrate/channel-export-plugin.rst new file mode 100644 index 00000000000..85860f381ae --- /dev/null +++ b/source/integrate/channel-export-plugin.rst @@ -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 `__ and `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 `__ to ensure your issue is tracked properly. + +For questions, feedback, and assistance: Please join us on the `Mattermost Discussion Forum `__. + +Alternatively, join our pubic `Mattermost Community Server `__ and the `Integrations and Apps channel `__ for assistance. + +To report a bug, please open a GitHub issue against the `Mattermost Channel Export plugin GitHub repository `__. + +Customize this plugin +--------------------- + +This plugin contains both a server and web app portion. See the `Channel Export plugin README documentation `__ on GitHub for details on developing and deploying this plugin. + +Read our documentation about the `Mattermost Developer Workflow `__ and `Mattermost Developer environment setup `__ for information about developing, customizing, and extending Mattermost plugins. + + diff --git a/source/integrate/github-plugin.rst b/source/integrate/github-plugin.rst new file mode 100644 index 00000000000..22a2e1ab590 --- /dev/null +++ b/source/integrate/github-plugin.rst @@ -0,0 +1,2 @@ +GitHub plugin +============== \ No newline at end of file diff --git a/source/integrate/gitlab-plugin.rst b/source/integrate/gitlab-plugin.rst new file mode 100644 index 00000000000..ca878eba0e0 --- /dev/null +++ b/source/integrate/gitlab-plugin.rst @@ -0,0 +1,3 @@ +GitLab plugin +============= + diff --git a/source/integrate/google-calendar-plugin.rst b/source/integrate/google-calendar-plugin.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/integrate/jira-plugin.rst b/source/integrate/jira-plugin.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/integrate/legal-hold-plugin.rst b/source/integrate/legal-hold-plugin.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/integrate/performance-metrics-plugin.rst b/source/integrate/performance-metrics-plugin.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/integrate/servicenow-plugin.rst b/source/integrate/servicenow-plugin.rst new file mode 100644 index 00000000000..e69de29bb2d diff --git a/source/integrate/zoom-plugin.rst b/source/integrate/zoom-plugin.rst new file mode 100644 index 00000000000..e69de29bb2d