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

Help Wanted: Documentation Enhancement in Plugin Developer Setup #1194

Open
shadowshot-x opened this issue Jan 6, 2023 · 1 comment
Open

Comments

@shadowshot-x
Copy link

shadowshot-x commented Jan 6, 2023

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.

@amyblais amyblais transferred this issue from mattermost/mattermost Jan 6, 2023
@cwarnermm
Copy link
Member

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

@cwarnermm cwarnermm added the Awaiting Submitter Action Blocked on the author label Feb 1, 2023
@cwarnermm cwarnermm changed the title Documentation Enhancement in Plugin Developer Setup Help Wanted: Documentation Enhancement in Plugin Developer Setup Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants