Adding Mattermost-supported plugins to product docs #7030
Conversation
|
Newest code from cwarnermm has been published to preview environment for Git SHA 7f717c8 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 272c695 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA b063d03 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 26bd302 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA b40771e |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 702196f |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 36f370d |
…m/mattermost/docs into mattermost-supported-integrations
|
Newest code from cwarnermm has been published to preview environment for Git SHA 2046a3b |
There was a problem hiding this comment.
Great work @cwarnermm 👍
Once this PR is merged, should we update the plugin metadata so the Marketplace entries point to the docs pages? Should we also remove the duplicate information from the respective READMEs?
| * :doc:`GitLab interoperability </integrate/gitlab-interoperability>` - Connect your GitLab instance to your Mattermost instance. | ||
| * :doc:`Jira interoperability </integrate/jira-interoperability>` - Connect your Jira instance to your Mattermost instance. | ||
| * :doc:`Legal hold | ||
| * :doc:`Performance metrics |
There was a problem hiding this comment.
I wonder if we should move the Metrics plugin out of this category. It's not an integration, but more of a tool. It's more like "Calls" and less like the "GitHub" plugin.
There was a problem hiding this comment.
That's a really good point, @hanzei, and I agree with your classification of the Metrics plugin. Legal hold and channel export would also fall into this category. Perhaps the way forward is to include only the interoperability plugins here. Tool-based integrations would be documented as any other product feature. Will think on this more. Really appreciate your input here.
There was a problem hiding this comment.
Features built as plugins are documented like features; 3rd party interoperability integrations are collected together, in the docs, under Integrate & Extend from the landing page.
I agree that we'll want to update the plugin metadata so the Marketplace entries point to the docs pages -- both the in-product Marketplace as well as the external one via mm.com/marketplace. These tasks will be completed outside of this PR.
| @@ -1619,8 +1423,8 @@ In addition to the Mattermost plugin signing key built into the server, each pub | |||
| | This feature's ``config.json`` setting is ``"SignaturePublicKeyFiles": {}`` with string array input consisting of contents that are relative or absolute paths to signature files. | | |||
| +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |||
|
|
|||
| .. config:setting:: plugins-zoomchimeraoauthproxyurl | |||
| :displayname: Chimera OAuth proxy URL (Plugins - Zoom) | |||
| .. config:setting:: plugins-chimeraoauthproxyurl | |||
There was a problem hiding this comment.
It is unclear to me which plugin these belong to and when an admin should modify these values. Can we clarify that?
There was a problem hiding this comment.
The code highlighted is metadata used to return config settings in search results.
I agree that the Chimera OAuth proxy URL docs don't specify which integrations this config affects, and we can definitely add this. Can you confirm which integrations utilize this config setting, please?
|
Newest code from cwarnermm has been published to preview environment for Git SHA 7ad7a36 |
|
/update-branch |
* Update conf.py * Clarified that system roles also control access to related API endpoints (#6901) * Clarified that system roles include related API endpoints * Update source/onboard/system-admin-roles.rst Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com> --------- Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com> * Added new error codes page (#6908) * Remove legacy MySQL references (#6896) * Removed legacy references to MySQL v5.x * Added missing redirect * Removed "Sync" to align with product naming (#6898) * Clarified Ent/Pro differentiation (#6899) * Clarified that bots don't count as active users (#6902) * Added interactive demo link (#6905) * Added link to Kubernetes YAML docs via mattermost repo (#6906) * Clarified supported AllowCorsFrom values (#6897) * Updated legacy E10/E20 label text (#6900) * Updated legacy E10/E20 label text * Add example for E10/E20 label setup * Test markup for labels * Another markup test for labels * And another markup test for labels * Use raw html markup for E10/E20 labels * Updated styling for legacy E10/E20 labels * Change class name --------- Co-authored-by: emdecr <delacruz.emily@gmail.com> * Added transcription end user docs (#6910) * Added Metrics plugin * Update source/scale/performance-monitoring.rst * Removed HA modes details * dashboards-how-to (#6935) * dashboards-how-to Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Split perf monitoring into 3 parts: 3rd party integrations, plugin, & metrics * Incorporated reviewer feedback * Update source/guides/scale-mattermost.rst Co-authored-by: Ibrahim Serdar Acikgoz <serdaracikgoz86@gmail.com> * Update source/guides/scale-mattermost.rst Co-authored-by: Ibrahim Serdar Acikgoz <serdaracikgoz86@gmail.com> * Incorporated reviewer feedback, added redirects, & updated links * Fixed broken link --------- Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> Co-authored-by: Eva Sarafianou <eva.sarafianou@gmail.com> Co-authored-by: emdecr <delacruz.emily@gmail.com> Co-authored-by: Ibrahim Serdar Acikgoz <serdaracikgoz86@gmail.com>
|
Newest code from mattermost-build has been published to preview environment for Git SHA 7bd0b2d |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 4dddf1a |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 8b4ab5a |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 94ed1e9 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 2f4c7cb |
There was a problem hiding this comment.
Amazing work @cwarnermm!! Crazy how much attention to detail this took, migrating markdown to rst alone is quite the task, and organizing it all this way with everything working 👏
LGTM 🚀
| .. include:: ../_static/badges/allplans-cloud-selfhosted.rst | ||
| :start-after: :nosearch: | ||
|
|
||
| .. |product-menu| image:: ../images/products_E82F.svg |
There was a problem hiding this comment.
Maybe the file's name can be made more human-readable?
There was a problem hiding this comment.
Those filenames come directly from the mattermost/compass-icons GH repository. I've matched the filename convention in the hopes of finding a way to automate the inclusion of these icons in docs some day.
Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com>
Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com>
|
Newest code from cwarnermm has been published to preview environment for Git SHA 159cda1 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 1355e9b |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 2324697 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA d84ac27 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA a2acbaf |
Documentation for: #7005
GitHub repository README updates to de-duplicate content is managed via separate PRs:
Separate PRs are being created to manage all in-product docs links currently taking users to GH READMEs, and take them to product docs instead.
The Google Calendar plugin documentation has been migrated from the Mattermost Product Documentation to its GitHub repository README via: mattermost/mattermost-plugin-google-calendar#74
Note: Legal Hold config docs & the new v2 Survey Plugin docs will be consolidated into the Mattermost Product Documentation in a future iteration. The existing User Satisfaction Survey docs will also be reviewed and aligned in a future iteration.