This plugin makes it easy to mark messages in Mattermost for further documentation so we can try to keep improving our shared knowledge. Known as doc'ing up. It is meant to work with documentation that lives in GitHub.
Here's how the plug-in looks in the user interface:
Marking something for documentation, otherwise known as doc'ing up, will create a GitHub issue with the title Request for Documentation: <Short_Title> in the corresponding repository for the documentation type that is selected. This GitHub issue can then be picked up by someone to edit and submit a pull request to update our official documentation.
Here's what a generated GitHub issue looks like:
Creating a pull request requires intricate knowledge of our documentation repositories, making it difficult for someone not familiar to know exactly where to place the documentation. Creating an issue gives our writers and editors a list of items needing documenation while at the same time making a raw form of the documentation, in the GitHub issue, immediately searchable on the web.
The plugin is in alpha and is intended for use by Mattermost and its community.
Simply upload the plugin bundle from the releases page to your Mattermost server and configure the fields on the settings page.
You will need to a GitHub Personal Access Token that has write permissions to the repositories you configure in the settings.
Click 'Doc Up' in a post dropdown menu:
Fill out the fields and click 'Mark for Documentation':
A post is created linking to the new GitHub issue:
A GitHub issue is created in the appropriate repo:
In the plugin settings area, you can configure the repos for:
- Admin Repository
- Developer Docs Repository
- Handbook Repository
You can also specify which Labels are applied to each newly created DocUp issues in GitHub.