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 docs on how to add new releases #100

Merged
merged 4 commits into from
Sep 7, 2020
Merged

Update docs on how to add new releases #100

merged 4 commits into from
Sep 7, 2020

Conversation

hanzei
Copy link
Collaborator

@hanzei hanzei commented Aug 11, 2020

Summary

generator add should be used to add releases for all not predefined plugins. This PR updated the documentation to make this clear.

Ticket Link

Fixes #74

@hanzei hanzei added the 2: Dev Review Requires review by a core committer label Aug 11, 2020
@hanzei hanzei requested review from larkox and jfrerich August 11, 2020 09:01
Copy link
Contributor

@larkox larkox left a comment

Choose a reason for hiding this comment

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

LGTM. Only thing that comes to my mind is that mattermod automated message after a version cut ask to run "make plugins.json", instead cmd add. Should that also be changed?

@hanzei
Copy link
Collaborator Author

hanzei commented Aug 11, 2020

Good question @larkox. Given that sometime make plugins.json should be used and sometime generator add I'm not quite sure what mattermod should output. Maybe link this documentation?

@larkox
Copy link
Contributor

larkox commented Aug 11, 2020

It would break the flow for those that just want to copy paste those lines, but yes, link to this documentation may be needed. I wonder whether a small explanation on the message (for those that have done it over and over but fail to remember the syntax) on the two options would be nice too.

Copy link
Contributor

@jfrerich jfrerich left a comment

Choose a reason for hiding this comment

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

Thanks for adding the additional instructions! I added some suggestions for wording organization.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@hanzei
Copy link
Collaborator Author

hanzei commented Aug 28, 2020

@jfrerich @larkox After thinking a bit more about this PR, I don't consider supporting two ways of adding a release valuable any longer. Hence, I'm leaning toward deprecating make plugins.json in favour of using generate add. I've updated the doc to reflect that proposal. Let me know what you think.

README.md Outdated Show resolved Hide resolved
@hanzei hanzei added 4: Reviews Complete All reviewers have approved the pull request and removed 2: Dev Review Requires review by a core committer labels Sep 7, 2020
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document generator add
3 participants