mattermost / mattermost/mattermost-developer-documentation

Help Wanted: Add minimum server version in Webapp plugin reference

Open
#434 18 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Content difficulty/2:Medium Help Wanted Up For Grabs
Dominant language
CSS
Stars
90
Forks
460
Avg merge
9d 23h
Merged PRs (30d)
2

Description

In the webapp plugin reference page, the minimum server version required to register various components is not mentioned.

If the minimum server version requirements are not met, the mattermost webapp shows a blank page with an error in console.
This is for all users including system admins.
The only way to disable the plugin is from editing the config.json file manually.

It would be better if the webapp reference mentioned the minimum server version required, so plugins can add a check to avoid this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the webapp plugin reference page linked in the issue and inspect its component registration entries. Identify the minimum Mattermost server version for each relevant component, then document those requirements so plugin authors can add compatibility checks; the reference should clearly show the version needed for every affected component.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.