docs: update deployment guide to support an updated azure plan / offer#8863
docs: update deployment guide to support an updated azure plan / offer#8863
Conversation
|
Newest code from mattermost has been published to preview environment for Git SHA a83aecb |
a83aecb to
48e1c94
Compare
|
Newest code from mattermost has been published to preview environment for Git SHA 48e1c94 |
Editor tweaks
esethna
left a comment
There was a problem hiding this comment.
Thanks @NARSimoes. Committed a few editor tweaks.
|
Adding the label to hold merge until you confirm the offering is available and someone can test these steps in production. |
|
Newest code from mattermost has been published to preview environment for Git SHA d4f063c |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughUpdated a single documentation file to replace generic phrasing with specific details about the "Quick Start Evaluation (VM)" Azure Marketplace offer. Reorganised content into Prerequisites, "What gets deployed," and "Basic Configuration" sections, adding explicit input parameters, VM specifications, and post-deployment guidance while clarifying the distinction between browser-based and Linux administrator credentials. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
source/deployment-guide/quick-start-evaluation.rst (2)
33-67: Add explicit success checks after each key step.Steps are clearer now, but key checkpoints are still implicit. Add one short “Success check” line after Step 1/2/3 (for example: plan selected, validation passed, DNS preview visible) so admins can verify progress before continuing.
As per coding guidelines, "Include expected output or a success check after each key step so readers can verify progress before continuing".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/deployment-guide/quick-start-evaluation.rst` around lines 33 - 67, After each major section titled "Step 1: Select a plan and start creation", "Step 2: Basic Configuration", and "Step 3: Virtual Machine Settings and Network Configuration" add one short "Success check" line that administrators can verify before proceeding (e.g., after Step 1: "Success check: Plan selected and Create button enabled"; after Step 2: "Success check: Basics validation passed and required fields (Subscription, Resource group, Region, VM name, Username, Email) populated"; after Step 3: "Success check: VM size chosen and Public IP DNS preview visible/unique"). Keep each check one sentence and place it immediately after the corresponding step’s instructions.
25-25: Define first-use jargon inline (reverse proxy,TLS).These terms appear without quick inline definitions. Add brief parenthetical explanations on first use to reduce friction for junior admins.
As per coding guidelines, "Define technical terms briefly inline on first use rather than assuming familiarity with jargon like 'reverse proxy', 'environment variables', 'SSL certificate', or 'Docker'".
Also applies to: 49-49, 79-79
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/deployment-guide/quick-start-evaluation.rst` at line 25, Update the quick-start-evaluation.rst text to add short parenthetical definitions on first use of jargon: e.g., change the "reverse proxy" mention in the list item to "reverse proxy (a server that forwards client requests to backend services)" and add a brief definition for "TLS" where it first appears; also scan and add similar inline parentheticals for other first-use terms listed in the comment such as "environment variables", "SSL certificate", and "Docker" at the other flagged occurrences (lines referenced in the review: the instances around 49 and 79) so each technical term has a one-sentence parenthetical definition on its first occurrence.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@source/deployment-guide/quick-start-evaluation.rst`:
- Line 84: Fix the broken bold markdown and clarify the sentence by changing the
fragment "which becomes the System Administrator**." to "which becomes the
**System Administrator** account." Update the line containing "System
Administrator**" so the bold markers are balanced and the phrase explicitly
reads "**System Administrator** account" for clarity.
- Line 56: Replace the UI label typo by changing the phrase "On **Virtual
Machine Settings** tag" to "On **Virtual Machine Settings** tab" so the
documentation uses the correct Azure portal terminology; update the exact string
containing "Virtual Machine Settings" (the occurrence "On **Virtual Machine
Settings** tag") in the quick-start-evaluation content.
---
Nitpick comments:
In `@source/deployment-guide/quick-start-evaluation.rst`:
- Around line 33-67: After each major section titled "Step 1: Select a plan and
start creation", "Step 2: Basic Configuration", and "Step 3: Virtual Machine
Settings and Network Configuration" add one short "Success check" line that
administrators can verify before proceeding (e.g., after Step 1: "Success check:
Plan selected and Create button enabled"; after Step 2: "Success check: Basics
validation passed and required fields (Subscription, Resource group, Region, VM
name, Username, Email) populated"; after Step 3: "Success check: VM size chosen
and Public IP DNS preview visible/unique"). Keep each check one sentence and
place it immediately after the corresponding step’s instructions.
- Line 25: Update the quick-start-evaluation.rst text to add short parenthetical
definitions on first use of jargon: e.g., change the "reverse proxy" mention in
the list item to "reverse proxy (a server that forwards client requests to
backend services)" and add a brief definition for "TLS" where it first appears;
also scan and add similar inline parentheticals for other first-use terms listed
in the comment such as "environment variables", "SSL certificate", and "Docker"
at the other flagged occurrences (lines referenced in the review: the instances
around 49 and 79) so each technical term has a one-sentence parenthetical
definition on its first occurrence.
🪄 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: 7eb7a4d6-8bb6-4eb6-8a20-e99e254593a5
📒 Files selected for processing (1)
source/deployment-guide/quick-start-evaluation.rst
|
Newest code from mattermost has been published to preview environment for Git SHA 2efd0e2 |
|
Newest code from mattermost has been published to preview environment for Git SHA bb8b5d0 |
| * Under **Essentials**, note the **DNS name**. Your site URL is: | ||
|
|
||
| Once the deployment is complete: | ||
| ``https://<dns-label>.<region>.cloudapp.azure.com`` |
There was a problem hiding this comment.
| ``https://<dns-label>.<region>.cloudapp.azure.com`` | |
| ``https://<dns-label>.<region>.cloudapp.azure.com``. |
Summary
Ticket Link