Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deployment documentation updates #7731

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

nickmisasi
Copy link
Contributor

Summary

I took a pass of each of the main installation methods, and performed a dry run on a new EC2 instance for each. I have made some documentation updates. For most of these updates, it's primarily for clarity. I also made some adjustments to split out some things that are repeatedly written between the various deployment methods to be more DRY.

The most major change was the overhaul of the Docker deployment. The current docs "for production use" have the reader deploy Mattermost and its database on the same instance. This isn't the best advice in production. I've split the documentation into 2 paths here - Quick Start (essentially the existing docs), and Production Use (adjustments to only deploy the Mattermost application container, suggesting external hosting for db and storage). These changes require

Ticket Link

https://mattermost.atlassian.net/browse/CLD-8785
https://mattermost.atlassian.net/browse/CLD-8848
https://mattermost.atlassian.net/browse/CLD-8849
https://mattermost.atlassian.net/browse/CLD-8850
https://mattermost.atlassian.net/browse/CLD-8851
https://mattermost.atlassian.net/browse/CLD-8852
https://mattermost.atlassian.net/browse/CLD-8853

Copy link

github-actions bot commented Feb 6, 2025

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

@cwarnermm cwarnermm self-requested a review February 6, 2025 16:37
@cwarnermm cwarnermm added the 2: Editor Review Requires review by an editor label Feb 6, 2025
Copy link

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

@cwarnermm
Copy link
Member

This is a great docs PR, @nickmisasi! I pulled your branch down and applied fixes to build errors and warnings where needed. Remind me: what's the goal of this docs update? What are we trying to achieve? That will help me formulate potential next step recommendations.

Copy link

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

@nickmisasi
Copy link
Contributor Author

@cwarnermm High level, this is intended to make it easier to deploy Mattermost. The main focus was on clarity, as well as making sure that our recommendations are not only correct, but actually work (without prior knowledge of deploying Mattermost itself)

@cwarnermm
Copy link
Member

@nickmisasi - Thank you! From my perspective, the content of this docs PR is excellent. No concerns at all. I know our structure and navigation needs work, but that's beyond the scope of this lift. Does it make sense to add customer-facing stakeholders as additional technical reviewers at this time? Are there specific perspectives you're looking for prior to us publishing these details?

@cwarnermm
Copy link
Member

@nickmisasi - One outstanding thing we'll need to address in this docs PR is H2 redirects. This is something we'll do last, once all stakeholder input is incorporated. I can help with this final step.

@nickmisasi
Copy link
Contributor Author

@cwarnermm I think it's a good idea to get some stakeholders to view this. Particularly I'd like eyes from @mrckndt, as he has some past work on Docker docs and is probably most familiar with RHEL. I'm open to others if you have anyone in mind. I'll also loop in @toninis as we discussed the Docker docs updates in Hub.

@cwarnermm cwarnermm added the 1: Dev Review Requires review by a core commiter label Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants