mattermost / mattermost/mattermost-developer-documentation

Help Wanted: Documentation Enhancement in Plugin Developer Setup

Open
#1,194 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

difficulty/2:Medium Up For Grabs
Dominant language
CSS
Stars
90
Forks
460
Avg merge
9d 23h
Merged PRs (30d)
2

Description

Summary

As a new reader, when setting up plugin developer setup, the user might not be aware about where the configuration file is on mattermost server. It would be good clear this up in the documentation page itself.

Steps to reproduce

Navigate to https://developers.mattermost.com/integrate/plugins/developer-setup/#set-up-your-environment-to-deploy-plugins and the change can be made in the first paragraph.

Expected behavior

As a new contributor earlier to the project, I was stuck on where to find the mattermost configuration file as in the mattermost server, the config file is embedded with code files and so is not clearly visible. The config file, as per me, should be kept visible and easy to find.

It would help new developers to mention where the configuration file is in the documentation. Eg:-

Edit your server configuration ** in the folder config/config.yaml ** as follows:
Observed behavior (that appears unintentional)
Screenshot 2023-01-06 at 1 27 01 PM
Possible fixes

We can simply add details on where to find the configuration file in the documentation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the developer setup page at the linked “Set up your environment to deploy plugins” section and read the first paragraph. Clarify where Mattermost’s server configuration file is located, using the proposed config/config.yaml path if accurate. Done means a new plugin developer can find the configuration file from this paragraph.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.