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

Update developer-setup.md to provide no-docker setup #1351

Merged
merged 8 commits into from
Mar 28, 2024

Conversation

sinansonmez
Copy link
Contributor

Summary

Update developer-setup.md to provide no-docker setup information

@mattermost-build
Copy link
Contributor

Hello @sinansonmez,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

Copy link
Member

@cwarnermm cwarnermm left a comment

Choose a reason for hiding this comment

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

Thanks, @sinansonmez. Provided editorial feedback.

site/content/contribute/developer-setup.md Outdated Show resolved Hide resolved
site/content/contribute/developer-setup.md Outdated Show resolved Hide resolved
site/content/contribute/developer-setup.md Outdated Show resolved Hide resolved
site/content/contribute/developer-setup.md Outdated Show resolved Hide resolved
site/content/contribute/developer-setup.md Outdated Show resolved Hide resolved
Copy link
Member

@hmhealey hmhealey left a comment

Choose a reason for hiding this comment

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

When you make those changes, could you move those steps to a separate section at the bottom of the doc and change that "Install Docker" step to point the user to the new section if they don't want to use Docker? I think we should split those steps into their own section because I think people will miss that those steps are optional and go through them after installing Docker. I want to keep the main instructions simpler because I screw up complicated instructions all the time 😅

@sinansonmez
Copy link
Contributor Author

sinansonmez commented Mar 26, 2024

When you make those changes, could you move those steps to a separate section at the bottom of the doc and change that "Install Docker" step to point the user to the new section if they don't want to use Docker? I think we should split those steps into their own section because I think people will miss that those steps are optional and go through them after installing Docker. I want to keep the main instructions simpler because I screw up complicated instructions all the time 😅

@hmhealey @cwarnermm Thanks for the feedback. Unfortunately, it is not clear to me how to proceed.

Currently there are 3 main sections

  • Set up your development environment
  • Prerequisites for Windows
  • Setup the Mattermost Server

Under Setup the Mattermost Server, there are 13 steps. Should I create a new main section or add the 14th step under Setup the Mattermost Server ?

@cwarnermm
Copy link
Member

Hi @sinansonmez! The ask is to separate the Docker steps within their own section (at the top of the page as the primary way forward) from the not-using-Docker steps you're providing. @hmhealey is suggesting we move the non-Docker info to its own section elsewhere on the page to avoid reader confusion.

The reader's experience would look like this:

  • Reader reaches the Setup the Mattermost Server section.
  • Step 2 instructs them to install Docker. Step 2 also includes a link to the new non-Docker section later on the page in case the reader would prefer that approach.
  • The rest of this section is about using Docker.

Meanwhile, following the Setup the Mattermost Server section, there's a new section about setting up Mattermost Server without Docker. That's where your steps would live.

@hmhealey
Copy link
Member

Yep, that's right. So with your steps, there'd be 4 sections:

  • Set up your development environment
  • Prerequisites for Windows
  • Setup the Mattermost Server
  • Develop Mattermost without Docker

@sinansonmez
Copy link
Contributor Author

thanks for the explanation @hmhealey @cwarnermm the page is updated as requested

@cwarnermm cwarnermm added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Mar 28, 2024
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA 0fe22c7

2 similar comments
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA 0fe22c7

Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA 0fe22c7

Copy link
Member

@cwarnermm cwarnermm left a comment

Choose a reason for hiding this comment

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

Thanks, @sinansonmez!

@cwarnermm cwarnermm removed the 2: Editor Review Requires review by an editor label Mar 28, 2024
Copy link
Member

@hmhealey hmhealey left a comment

Choose a reason for hiding this comment

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

Thanks, Sinan!

@hmhealey hmhealey added 4: Reviews Complete All reviewers have approved the pull request and removed 1: Dev Review Requires review by a core commiter labels Mar 28, 2024
@hmhealey hmhealey merged commit 533aad0 into mattermost:master Mar 28, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4: Reviews Complete All reviewers have approved the pull request Contributor preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants