-
Notifications
You must be signed in to change notification settings - Fork 24
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 add_plugin.md #210
Update add_plugin.md #210
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for keeping the docs in sync 👍
@hanzei, this file is now aligned with: mattermost/mattermost-developer-documentation#747. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that mattermost/mattermost-developer-documentation#747 was closed, is this PR still valid? The docs in the repo and the dev docs should be in sync.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
||
**Documentation requirements (checked by a Technical Writer)** | ||
|
||
- [ ] The plugin must include detailed usage documentation with at least one screenshot of the plugin in action, list of features, and a development guide. This is typically a `README` file or a landing page on the web. The link to the documentation is set as `homepage_url` in the manifest. A great example is the [`README` of the GitHub plugin](https://github.com/mattermost/mattermost-plugin-github/blob/master/README.md). Typical components of documentation include: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we put the development guide as a separate linked .MD file? Of the hundreds of people who read it, only a small fraction will ever custom code or contribute. and ittakes up a large section. I'd be happy to put a "How to Contribute" link higher up in the doc more prominently if it was linked out. Otherwise, I say sink it to the bottom of the readme.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at this, I agree with you. It's too wordy. I believe we have this documented elsewhere but if not it certainly can be moved. I'll address this in a separate PR. Thank you!
Updates to align with: mattermost/mattermost-developer-documentation#747.