Mattermost-server: Organize the plugin server reference documentation with tags

[mattermod]

The API documentation at https://developers.mattermost.com/extend/plugins/server/reference/ is hard to follow: all the API methods are grouped together in the order they are defined in https://github.com/mattermost/mattermost-server/blob/master/plugin/api.go.

Let's support multiple, optional tags in the comments on the API interface to group methods together:

// GetUsers a list of users based on search options.
//
// @memberof Users
// Minimum server version: 5.10
GetUsers(options **model.UserGetOptions) ([]*model.User, **model.AppError)

The script at https://github.com/mattermost/mattermost-developer-documentation/blob/master/scripts/plugin-godocs.go should automatically parse these comments, discover the top-level sections, and render the API methods organized by the tag named provided.

Suggested tags:

• Users
• Bots
• Teams
• Channels
• Posts
• Plugins
• KeyValueStore
• Logging

Any method missing a tag should render at the top before the tag breakout. Tags should be rendered in alphabetical order, with methods within the tag rendered in the order they appear in the API interface specification. It should be possible to apply more than one tag per method, allowing it to appear under multiple tags, but this should not be overused.

---

If you're interested please comment here and come join our "Contributors" community channel on our daily build server, where you can discuss questions with community members and the Mattermost core team. For technical advice or questions, please join our "Developers" community channel.

New contributors please see our Developer's Guide.

JIRA: https://mattermost.atlassian.net/browse/MM-18676

[hanzei]

@lieut-data Would you please add the appropriate labels to this ticket?

[cinlloc]

I'm interested to work on it.

[hanzei]

Thanks for taking a shot @cinlloc :+1:

[cinlloc]

A first PR proposal here: https://github.com/mattermost/mattermost-developer-documentation/pull/383