mattermost / mattermost-developer-documentation

Mattermost developer documentation.
https://developers.mattermost.com
BSD 3-Clause "New" or "Revised" License
80 stars 398 forks source link

Help Wanted: Documentation Enhancement in Plugin Developer Setup #1194

Open shadowshot-x opened 1 year ago

shadowshot-x commented 1 year ago

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.

cwarnermm commented 1 year ago

Thanks for raising this issue, @shadowshot-x! Are you open to creating a PR that details where to find the configuration file?