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

Document the sync feature and environment variables #171

Open
moussetc opened this issue Jan 28, 2023 · 2 comments
Open

Document the sync feature and environment variables #171

moussetc opened this issue Jan 28, 2023 · 2 comments
Labels
Difficulty/2:Medium Medium ticket Help Wanted Community help wanted Type/Enhancement New feature or improvement of existing feature Up For Grabs Ready for help from the community. Removed when someone volunteers

Comments

@moussetc
Copy link
Contributor

moussetc commented Jan 28, 2023

Currently, there is a make sync command that is supposed to help keep plugins updated with the starter template, to benefit from latest improvements&updates done to the starter.

Sadly, it is not featured in the GH repository's README, nor easy of use (it fails for me, probably because I missed some pre-required steps which is part of the missing documentation).

There are also undocumented environment variables supported by the Makefile (like MM_DEBUG, MM_SERVICESETTINGS_ENABLEDEVELOPER...) that would be worth mentioning in the README, explaining how and why to use them would be interesting. I assume from the name that they are also used for Mattermost development, but not all plugin developers have knowledge of Mattermost development (nor a local MM dev environment, because you can use Docker to test a plugin).

@moussetc moussetc changed the title Document the sync feature Document the sync feature and environment variables Jan 28, 2023
@hanzei
Copy link
Contributor

hanzei commented Feb 3, 2023

Does the documentation in https://github.com/mattermost/mattermost-plugin-starter-template/tree/master/build/sync cover your concerns about make sync?

👍 for properly documenting the env variables.

@hanzei hanzei added Help Wanted Community help wanted Up For Grabs Ready for help from the community. Removed when someone volunteers Type/Enhancement New feature or improvement of existing feature Difficulty/2:Medium Medium ticket labels Feb 3, 2023
@moussetc
Copy link
Contributor Author

moussetc commented Feb 5, 2023

Does the documentation in master/build/sync cover your concerns about make sync?

Not really, for 2 reasons:

  1. The build/sync/README.md is about the generic syncing tool, not it's application on the specific mattermost-starter-template. For example it explains how to start the syncing using go run ... instead of make sync.
  2. This README is buried in a sub-sub-folder, and no mention of the syncing feature is made on the root-level README, which it should be in my opinion (if the syncing feature is considered as mature enough, which it might not be)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty/2:Medium Medium ticket Help Wanted Community help wanted Type/Enhancement New feature or improvement of existing feature Up For Grabs Ready for help from the community. Removed when someone volunteers
Projects
None yet
Development

No branches or pull requests

2 participants