Refactor port tables to use list-table format and improve clarity#9028
Refactor port tables to use list-table format and improve clarity#9028hanzei wants to merge 5 commits into
Conversation
Replaces the single wide table (which caused horizontal scrolling) with separate inbound and outbound list-tables for Mattermost Server and Push Proxy. Drops the redundant Direction column since direction is now conveyed by the section heading.
|
Newest code from mattermost has been published to preview environment for Git SHA 57ea8ed |
📝 WalkthroughWalkthroughThis PR corrects an apostrophe in the File Storage bullet and restructures the Mattermost services ports section: replacing grid tables with Sphinx ChangesApplication Architecture Documentation
🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
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/deployment-guide/reference-architecture/application-architecture.rst`:
- Around line 169-174: Update the two listener entries ("Metrics" and "Push
Proxy") to explicitly state direction, protocol, source/destination scope, and
whether access is required: for Metrics (MetricsSettings.ListenAddress, port
8067) mark it as TCP, inbound to the application from internal/trusted
monitoring hosts only (internal-only, optional for external access), and for
Push Proxy (port 8066) mark it as TCP, inbound from trusted proxy servers or
internal components only (internal-only and required if using a proxy); apply
the same wording changes to the other occurrence referencing these listeners so
admins clearly understand the allowed source IPs, that these are not open to the
public internet, and whether enabling is mandatory or optional.
🪄 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: b3763b62-98c0-4baf-bbc5-b184d07160e6
📒 Files selected for processing (1)
source/deployment-guide/reference-architecture/application-architecture.rst
Metrics (8067) should only be reachable by trusted monitoring hosts (e.g. Prometheus), not exposed broadly. Push Proxy (8066) should only be reachable from Mattermost Server nodes.
|
Newest code from mattermost has been published to preview environment for Git SHA 637e3d8 |
|
Newest code from mattermost has been published to preview environment for Git SHA 46ffb44 |
|
Newest code from mattermost has been published to preview environment for Git SHA 5c86d86 |
|
Newest code from mattermost has been published to preview environment for Git SHA aa6d500 |
Summary
Restructured the Mattermost services ports documentation to improve readability and maintainability by converting from RST grid tables to the more flexible list-table format, while also enhancing the content organization and clarity.
Key Changes
Implementation Details
https://claude.ai/code/session_01KteMBCm721b5vmwTqyoxDZ