Add Azure Blob to TOC#9095
Conversation
📝 WalkthroughWalkthroughThe server administration guide now includes navigation links to the Azure Blob Storage file store configuration documentation. ChangesAzure Blob Storage documentation navigation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds an Azure Blob Storage documentation entry to the Server Configuration guide navigation so admins can find the new file-store configuration content from the admin TOC.
Changes:
- Added an “Configure Azure Blob Storage as the Mattermost file store” entry to the hidden
toctree. - Added the same link to the visible bullet navigation list, with a short description.
| SSL client certificate setup </administration-guide/onboard/ssl-client-certificate> | ||
| Connected workspaces </administration-guide/onboard/connected-workspaces> | ||
| Telemetry </administration-guide/manage/telemetry> | ||
| Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage> |
| * :doc:`SSL client certificate setup </administration-guide/onboard/ssl-client-certificate>` - Learn how to set up SSL client certificates for Mattermost. | ||
| * :doc:`Connected workspaces </administration-guide/onboard/connected-workspaces>` - Learn how to connect Mattermost workspaces. | ||
| * :doc:`Telemetry </administration-guide/manage/telemetry>` - Learn about Mattermost telemetry and data collection. | ||
| * :doc:`Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage>` - Learn about Mattermost Azure Storage account. |
| * :doc:`SSL client certificate setup </administration-guide/onboard/ssl-client-certificate>` - Learn how to set up SSL client certificates for Mattermost. | ||
| * :doc:`Connected workspaces </administration-guide/onboard/connected-workspaces>` - Learn how to connect Mattermost workspaces. | ||
| * :doc:`Telemetry </administration-guide/manage/telemetry>` - Learn about Mattermost telemetry and data collection. | ||
| * :doc:`Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage>` - Learn about Mattermost Azure Storage account. |
| SSL client certificate setup </administration-guide/onboard/ssl-client-certificate> | ||
| Connected workspaces </administration-guide/onboard/connected-workspaces> | ||
| Telemetry </administration-guide/manage/telemetry> | ||
| Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage> |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@source/administration-guide/manage/admin/server-configuration.rst`:
- Line 48: Update the Azure Blob Storage navigation entry description to clearly
state that the linked page explains how to configure Azure Blob Storage as the
Mattermost file store, replacing the grammatically incomplete wording while
leaving the document link and title unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e505ac65-a32f-4722-9551-b2beddfbb84c
📒 Files selected for processing (1)
source/administration-guide/manage/admin/server-configuration.rst
| * :doc:`SSL client certificate setup </administration-guide/onboard/ssl-client-certificate>` - Learn how to set up SSL client certificates for Mattermost. | ||
| * :doc:`Connected workspaces </administration-guide/onboard/connected-workspaces>` - Learn how to connect Mattermost workspaces. | ||
| * :doc:`Telemetry </administration-guide/manage/telemetry>` - Learn about Mattermost telemetry and data collection. | ||
| * :doc:`Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage>` - Learn about Mattermost Azure Storage account. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Clarify the navigation description.
“Learn about Mattermost Azure Storage account” is grammatically incomplete and does not clearly describe the linked topic. Use wording consistent with the title, such as “Learn how to configure Azure Blob Storage as the Mattermost file store.”
Suggested wording
-* :doc:`Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage>` - Learn about Mattermost Azure Storage account.
+* :doc:`Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage>` - Learn how to configure Azure Blob Storage as the Mattermost file store.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * :doc:`Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage>` - Learn about Mattermost Azure Storage account. | |
| * :doc:`Configure Azure Blob Storage as the Mattermost file store </administration-guide/configure/azure-blob-storage>` - Learn how to configure Azure Blob Storage as the Mattermost file store. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@source/administration-guide/manage/admin/server-configuration.rst` at line
48, Update the Azure Blob Storage navigation entry description to clearly state
that the linked page explains how to configure Azure Blob Storage as the
Mattermost file store, replacing the grammatically incomplete wording while
leaving the document link and title unchanged.
Source: Coding guidelines
|
Newest code from mattermost has been published to preview environment for Git SHA daf8249 |
|
Closing in favor of #9096 |
I opened this PR as I'm not sure why the changes from #8976 are not live on the docs site https://docs.mattermost.com/.