docs icon indicating copy to clipboard operation
docs copied to clipboard

[MM-356]: Updated the readme for Github with added support for workflow subscription

Open Kshitij-Katiyar opened this issue 1 year ago • 11 comments
trafficstars

Summary

Updated the readme for GitHub with the details of the feature to create subscription for workflows.

To be merged once https://github.com/mattermost/mattermost-plugin-github/pull/765 is merged

Kshitij-Katiyar avatar Aug 01 '24 12:08 Kshitij-Katiyar

Thank you, @Kshitij-Katiyar! Are you open to creating a Mattermost product docs PR reflecting these same changes via https://github.com/mattermost/docs/blob/master/source/integrate/github-interoperability.rst?

cwarnermm avatar Aug 14 '24 13:08 cwarnermm

@Kshitij-Katiyar - Please update your branch with latest master so that we can merge your changes into the code base. Thanks!

cwarnermm avatar Aug 15 '24 18:08 cwarnermm

@cwarnermm Sure, we will update the branch and resolve the conflicts. But I think this PR should be merged after https://github.com/mattermost/mattermost-plugin-github/pull/765. Can you please add the Do not merge label for now?

raghavaggarwal2308 avatar Aug 16 '24 13:08 raghavaggarwal2308

Thank you, @Kshitij-Katiyar! Are you open to creating a Mattermost product docs PR reflecting these same changes via https://github.com/mattermost/docs/blob/master/source/integrate/github-interoperability.rst?

@cwarnermm I am not sure what are you asking here. Can you please provide some details?

raghavaggarwal2308 avatar Aug 16 '24 13:08 raghavaggarwal2308

@Kshitij-Katiyar - All Mattermost plugins that come pre-packaged with the Mattermost server are now documented via the Mattermost Product Documentation site, including GitHub.

Going forward, the plan is to document installation, configuration, and usage details via docs.mattermost.com, rather than the GitHub README page.

My ask of you is to create a docs PR against the product docs GitHub repo. Once the docs are updated, I'd like to ensure that duplicated content via the README file is removed. The README scope should be limited to development, release, and testing details.

Is this something you can assist with?

cwarnermm avatar Aug 16 '24 14:08 cwarnermm

@cwarnermm This PR is already in the docs. Am I misunderstanding something?

raghavaggarwal2308 avatar Aug 16 '24 16:08 raghavaggarwal2308

It's entirely me that's misunderstanding, @Kshitij-Katiyar. I apologize for the confusion (on my end). As soon as I saw README, I assumed GitHub repo, not docs! Please keep up the most excellent work and I'll do my best to keep up going forward ;)

cwarnermm avatar Aug 16 '24 16:08 cwarnermm

@cwarnermm No issues, we will also try not to use words like readme from now on

raghavaggarwal2308 avatar Aug 16 '24 17:08 raghavaggarwal2308

@Kshitij-Katiyar - I'll also do a better job of reading PRs end-to-end instead of assuming :)

cwarnermm avatar Aug 16 '24 17:08 cwarnermm

@Kshitij-Katiyar - Once you merge the latest master branch into this docs PR, we can merge it into the codebase. Thanks!

cwarnermm avatar Sep 05 '24 20:09 cwarnermm

@cwarnermm Done

raghavaggarwal2308 avatar Sep 06 '24 09:09 raghavaggarwal2308