Skip to content

Add Azure Blob to TOC#9095

Closed
amyblais wants to merge 1 commit into
masterfrom
amyblais-azurefix
Closed

Add Azure Blob to TOC#9095
amyblais wants to merge 1 commit into
masterfrom
amyblais-azurefix

Conversation

@amyblais

@amyblais amyblais commented Jul 16, 2026

Copy link
Copy Markdown
Member

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/.

@amyblais amyblais added the 2: Editor Review Requires review by an editor label Jul 16, 2026
@amyblais amyblais changed the title Add Azure Blog to TOC Add Azure Blob to TOC Jul 16, 2026
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The server administration guide now includes navigation links to the Azure Blob Storage file store configuration documentation.

Changes

Azure Blob Storage documentation navigation

Layer / File(s) Summary
Add Azure Blob Storage navigation links
source/administration-guide/manage/admin/server-configuration.rst
Adds the Azure Blob Storage file store page to the guide’s toctree and related navigation list.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No description was provided, so there is no meaningful summary to evaluate. Add a brief description of the TOC/navigation update for Azure Blob Storage documentation.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately summarizes the main change: adding Azure Blob Storage documentation to the table of contents.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch amyblais-azurefix

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9ea246c and daf8249.

📒 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 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.

Suggested change
* :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

@github-actions

Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA daf8249

@amyblais

Copy link
Copy Markdown
Member Author

Closing in favor of #9096

@amyblais amyblais closed this Jul 16, 2026
@amyblais
amyblais deleted the amyblais-azurefix branch July 16, 2026 08:02
@amyblais amyblais removed the 2: Editor Review Requires review by an editor label Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants