Docs: Add SAML provider type & Enterprise search documentation for Support Packets #8590
Conversation
Document new SAML provider type identification feature in Support Packets for Mattermost v11.1.1+. This enhancement helps administrators quickly identify SAML Identity Provider types and provides diagnostic context for troubleshooting authentication issues. - Added SAML provider type identification section - Documented enhanced authentication diagnostics - Explained troubleshooting workflow improvements - Listed benefits for support teams and administrators Relates to engineering PR #34378 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
|
Newest code from mattermost has been published to preview environment for Git SHA c4fdf46 |
|
Newest code from mattermost has been published to preview environment for Git SHA 9701de0 |
…into a single docs PR
cwarnermm
changed the title
|
Newest code from mattermost has been published to preview environment for Git SHA 8554814 |
cwarnermm
added
1: Dev Review
|
@hanzei I think you worked on this, correct? |
|
Newest code from mattermost has been published to preview environment for Git SHA 324414b |
source/administration-guide/manage/admin/generating-support-packet.rst
Outdated
Show resolved
Hide resolved
| Enterprise search | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| From Mattermost v11.2, the Support Packet ``diagnostics.yaml`` file includes connection testing for configured :doc:`enterprise search engines </administration-guide/scale/enterprise-search>`, including both :doc:`Elasticsearch </administration-guide/scale/elasticsearch-setup>` and :doc:`AWS OpenSearch </administration-guide/scale/opensearch-setup>`. Any connection errors encountered during testing are included to help diagnose enterprise search configuration issues. | ||
|
|
||
| SAML provider type | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| From Mattermost v11.2, the Support Packet ``diagnostics.yaml`` file includes SAML provider details to help administrators and support teams quickly identify the SAML Identity Provider (IdP) in use and provides additional diagnostic context for troubleshooting authentication issues. When SAML SSO is configured, SAML details include provider type, provider-specific diagnostic information to accelerate troubleshooting of SAML authentication flows, and relevant metadata about the SAML provider to help identify common configuration patterns and potential issues. |
There was a problem hiding this comment.
I appreciate that you documented by changes. Though, I wonder if we really need to document these fields. diagnostics.yaml doesn't have a detailed, per-field documentation and I'm not sure it needs one.
There was a problem hiding this comment.
Thanks, @hanzei. I agree with your feedback and have updated this section in my latest commit.
…cket.rst Co-authored-by: Ben Schumacher <ben.schumacher@mattermost.com>
|
Newest code from mattermost has been published to preview environment for Git SHA 8d97053 |
|
Newest code from mattermost has been published to preview environment for Git SHA 3b81258 |
|
Newest code from mattermost has been published to preview environment for Git SHA 32d30f6 |
Document new SAML provider type identification and Enterprise Search in Support Packets for Mattermost v11.2.
Relates to engineering PR #34378 & 34377
Fixes #8571
🤖 Generated with Claude Code