Skip to content

docs: add csp section to docs#8908

Open
NARSimoes wants to merge 4 commits intomasterfrom
nasimoes-docs-vm-offers
Open

docs: add csp section to docs#8908
NARSimoes wants to merge 4 commits intomasterfrom
nasimoes-docs-vm-offers

Conversation

@NARSimoes
Copy link
Copy Markdown
Contributor

@NARSimoes NARSimoes commented Apr 17, 2026

Summary

Currently supporting:

  • Azure Quick Start Evaluation
  • Mattermost Azure Native (VM Based)

Note - the naming / structure might require more discussion and alignment.

Ticket Link

https://mattermost.atlassian.net/browse/SEC-10043

@github-actions
Copy link
Copy Markdown
Contributor

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

@NARSimoes NARSimoes requested a review from esethna April 17, 2026 10:51
@esethna esethna requested a review from Combs7th April 17, 2026 19:45
@esethna
Copy link
Copy Markdown
Contributor

esethna commented Apr 17, 2026

@Combs7th can you help take a first pass review on these changes?

@NARSimoes NARSimoes requested a review from esarafianou April 20, 2026 09:46
@esarafianou
Copy link
Copy Markdown
Contributor

@esethna @Combs7th please hold off reviewing. Some implementation details have changed, we'll update the PR and mark this ready for review before any review is needed.

@esethna esethna added Guidance and removed Guidance labels May 6, 2026
NARSimoes added 2 commits May 7, 2026 21:14
Currently supporting:
- Azure Quick Start Evaluation
- Mattermost (Azure VM)
@NARSimoes NARSimoes force-pushed the nasimoes-docs-vm-offers branch from efb4885 to ee3aa45 Compare May 7, 2026 19:15
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

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

@NARSimoes NARSimoes force-pushed the nasimoes-docs-vm-offers branch from a706975 to cef6ce9 Compare May 7, 2026 20:38
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

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

@NARSimoes NARSimoes marked this pull request as ready for review May 8, 2026 10:15
Copilot AI review requested due to automatic review settings May 8, 2026 10:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new “CSP Marketplaces” area to the Deployment Guide, introducing Azure Marketplace-based deployment docs (a quick-start evaluation flow and a production-style Azure-Native offer) and wiring the new section into the Deployment Guide navigation.

Changes:

  • Adds a new “CSP Marketplaces” section to the Deployment Guide index.
  • Introduces a CSP Marketplaces landing page plus two top-level marketplace guides.
  • Adds Azure-specific included content for the evaluation VM and Azure-Native (VM-based) offer.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
source/deployment-guide/deployment-guide-index.rst Adds CSP Marketplaces to the deployment guide navigation.
source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst New index/landing page for CSP marketplace deployments.
source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst New marketplace quick-start wrapper page (currently Azure-only).
source/deployment-guide/csp-marketplaces/mattermost-azure-native-app.rst New wrapper page for Azure-Native offer content.
source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst New Azure Marketplace evaluation VM instructions (included content).
source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst New Azure Marketplace production-style deployment instructions (included content).

Comment thread source/deployment-guide/deployment-guide-index.rst
Comment thread source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst
Comment thread source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst Outdated
Comment thread source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst Outdated
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 8, 2026

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 51f7dc4f-1307-42ef-adba-90183de8eaa3

📥 Commits

Reviewing files that changed from the base of the PR and between 30a3618 and f40c4f2.

📒 Files selected for processing (6)
  • source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst
  • source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst
  • source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst
  • source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst
  • source/deployment-guide/deployment-guide-index.rst
  • source/deployment-guide/quick-start-evaluation.rst
✅ Files skipped from review due to trivial changes (6)
  • source/deployment-guide/deployment-guide-index.rst
  • source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst
  • source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst
  • source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst
  • source/deployment-guide/quick-start-evaluation.rst
  • source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst

📝 Walkthrough

Walkthrough

Adds a new "CSP Marketplaces" section to the deployment guide with wrapper pages and two Azure Marketplace documents: Quick Start Evaluation (VM) and Mattermost - Azure‑Native (VM-based), each providing Azure Marketplace wizard walkthroughs and post-deployment steps.

Changes

Azure Marketplace Deployment Documentation

Layer / File(s) Summary
Documentation Navigation
source/deployment-guide/deployment-guide-index.rst, source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst
New CSP Marketplaces entry added to the deployment guide index and a CSP Marketplaces index page with a toctree linking child documents.
Multi-Cloud Wrapper Pages
source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst, source/deployment-guide/csp-marketplaces/mattermost-azure-native-app.rst
Wrapper pages added that expose an “Azure Marketplace” tab and include Azure-specific content from csp-marketplaces/azure via include directives.
Azure Quick-Start Evaluation
source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst
New Azure quick-start doc: prerequisites, list of provisioned resources, portal basics, VM/network configuration guidance, provisioning/first-boot expectations, and instructions to access the site and create the initial System Administrator.
Azure Native App Deployment
source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst
New Azure native VM-based Marketplace guide: architecture overview and Marketplace wizard walkthrough covering plan selection, VMSS sizing, PostgreSQL Flexible Server and NFS sizing/options, networking/TLS and custom DNS, review/create behaviour, endpoint derivation, and initial admin setup.

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add csp section to docs' directly describes the main change—adding a new CSP (Cloud Service Provider) section to the documentation.
Description check ✅ Passed The description clearly relates to the changeset by identifying the CSP section additions (Azure Quick Start Evaluation and Mattermost Azure Native VM-based offers) and acknowledges potential naming/structure discussions.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nasimoes-docs-vm-offers

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 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/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst`:
- Line 62: Replace the hardcoded external URL in the "Mattermost Version" bullet
(the text containing "the Mattermost release policy
<https://docs.mattermost.com/product-overview/release-policy.html>") with the
repo's internal Sphinx link role (for example use :ref:`...` or :doc:`...`
pointing to the corresponding release policy doc/page). Edit the line containing
"Mattermost Version:" so it uses the internal reference role and the appropriate
target identifier in the docs rather than the full
https://docs.mattermost.com/... URL.

In `@source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst`:
- Line 77: The step reference in the sentence "In a browser, go to your
**HTTPS** URL..." incorrectly points to "Step 3" for where Linux credentials
were configured; update that reference to "Step 2 (Basics)" so the sentence
reads that the Linux username and password (or SSH key) were configured in Step
2; locate the exact sentence in quick-start-evaluation.rst (the paragraph
starting "In a browser, go to your **HTTPS** URL.") and replace "Step 3" with
"Step 2 (Basics)" to correct the documentation.
- Line 52: Update the imprecise scope about DNS-label uniqueness in the sentence
containing "You must set a **DNS prefix** (label) that is **globally unique** in
Azure; it forms part of your URL." — replace the clause that currently reads "it
is important that you do not already have a matching DNS name within your Azure
subscription" with wording that clarifies the DNS label must be unique across
Azure (not just within the subscription), e.g. "it must be globally unique
across Azure (not just within your subscription), otherwise deployment may
fail."

In `@source/deployment-guide/deployment-guide-index.rst`:
- Line 17: The page has a hidden toctree entry "CSP Marketplaces" but the
visible summary bullet list lacks a matching :doc: entry; update the public
bullet list (the page summary section where other :doc: bullets like the
existing CSP or marketplace entries appear) to add a new :doc:`CSP Marketplaces
</deployment-guide/csp-marketplaces/csp-marketplaces-index>` bullet, matching
the surrounding formatting and indentation style so the section is discoverable
in both the hidden toctree and the visible summary list.
🪄 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: 9a9202ea-434b-43e1-9e46-130551d552a6

📥 Commits

Reviewing files that changed from the base of the PR and between 9109a4f and cef6ce9.

📒 Files selected for processing (6)
  • source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst
  • source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst
  • source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst
  • source/deployment-guide/csp-marketplaces/mattermost-azure-native-app.rst
  • source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst
  • source/deployment-guide/deployment-guide-index.rst

Comment thread source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst Outdated
Comment thread source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst Outdated
Comment thread source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst Outdated
Comment thread source/deployment-guide/deployment-guide-index.rst
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

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/deployment-guide/quick-start-evaluation.rst`:
- Around line 12-13: In the included Azure Marketplace file
csp-marketplaces/azure/quick-start-evaluation.rst the headings currently use
level-2 underlines (`-`) and must be changed to level-3 underlines (`~`) so they
nest correctly under the "Deployment options" section; update every heading
underline in that file (e.g., for "Prerequisites", "What gets deployed", "Step
1: Select a plan and start creation", etc.) by replacing `-` underlines with `~`
underlines so the headings become level 3 and preserve document hierarchy.
🪄 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: 549b9e87-7fd1-4011-9722-e961b858e2fb

📥 Commits

Reviewing files that changed from the base of the PR and between cef6ce9 and 08c9674.

📒 Files selected for processing (6)
  • source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst
  • source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst
  • source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst
  • source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst
  • source/deployment-guide/deployment-guide-index.rst
  • source/deployment-guide/quick-start-evaluation.rst
✅ Files skipped from review due to trivial changes (4)
  • source/deployment-guide/deployment-guide-index.rst
  • source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst
  • source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst
  • source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst

Comment thread source/deployment-guide/quick-start-evaluation.rst
@NARSimoes NARSimoes force-pushed the nasimoes-docs-vm-offers branch from 08c9674 to 30a3618 Compare May 8, 2026 15:25
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst`:
- Line 116: The text currently says the Linux username/password (or SSH key)
were configured in "Step 2" but they are actually configured in "Step 3:
Application"; update the sentence in the Mattermost setup paragraph so it
references "Step 3: Application" (or simply "Step 3") instead of "Step 2" to
accurately point readers to where the Linux credentials were created.
- Around line 91-92: The "Public IP address" bullet contains an ambiguous phrase
"globally unique in Azure for that cloud/region scope"; update that sentence to
explicitly state the uniqueness scope (e.g., replace with "globally unique
within Azure public cloud" if the label must be unique across all Azure regions,
or "unique within the selected region" if uniqueness is only regional) and add a
short clarifying note that explains whether a DNS label like `mydns` in one
region will conflict with the same label in another region; change the text in
the "Public IP address" paragraph accordingly to remove the contradiction.
🪄 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: 8b10841e-6370-431c-a031-41eadcd75d32

📥 Commits

Reviewing files that changed from the base of the PR and between 08c9674 and 30a3618.

📒 Files selected for processing (6)
  • source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst
  • source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst
  • source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst
  • source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst
  • source/deployment-guide/deployment-guide-index.rst
  • source/deployment-guide/quick-start-evaluation.rst
✅ Files skipped from review due to trivial changes (4)
  • source/deployment-guide/csp-marketplaces/quick-start-evaluation.rst
  • source/deployment-guide/deployment-guide-index.rst
  • source/deployment-guide/csp-marketplaces/azure/quick-start-evaluation.rst
  • source/deployment-guide/csp-marketplaces/csp-marketplaces-index.rst
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/deployment-guide/quick-start-evaluation.rst

Comment thread source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst Outdated
Comment thread source/deployment-guide/csp-marketplaces/azure/mattermost-azure-native-app.rst Outdated
@NARSimoes NARSimoes force-pushed the nasimoes-docs-vm-offers branch from 30a3618 to f40c4f2 Compare May 8, 2026 15:46
@NARSimoes
Copy link
Copy Markdown
Contributor Author

@esethna @Combs7th it's now ready for review again, please let us know if you need additional information. Thanks.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

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

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.

4 participants