Help Wanted: Add minimum server version in Webapp plugin reference

[chetanyakan]

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.

[cwarnermm]

@aaronrothschild - Does this documentation request continue to be valid?

[aaronrothschild]

I don't know. @hanzei thoguhts?

[hanzei]

Yes, this is still valid.

[TomerPacific]

@cwarnermm , I'd like to help out. What would be the minimum server version?

[cwarnermm]

@neflyte - Are you open to providing @TomerPacific with guidance on this developer documentation ticket based on your knowledge of our plugins and apps framework technologies and our developer doc set?

[TomerPacific]

@cwarnermm - Any update on this?

[cwarnermm]

@TomerPacific - We'll have an update next week on this ticket. Unfortunately, we likely won't have an update in time for this ticket to be eligible for Hacktoberfest.

[TomerPacific]

@cwarnermm - I don't want to be a bother, but am wondering if you still need help here?

[cwarnermm]

Not a bother at all, @TomerPacific. I appreciate you checking back and for your patience. I'm in the process of investigating the answers needed for this ticket internally. I recommend that this ticket is left paused until more information is known.

[hanzei]

Yes, this ticket is still valid.

[TomerPacific]

@cwarnermm - Seeing as a month has passed by, checking in to see if there is any new information?

[neflyte]

@TomerPacific @cwarnermm I apologize for dropping the ball on this.

The webapp plugin reference is dynamically generated from code comments in the mattermost-webapp repo when the docs are built. The code comments come from this file: https://github.com/mattermost/mattermost-webapp/blob/master/plugins/registry.ts

The code comments in that file need to be updated to show the required server version for each component.

I'm not sure it's feasible to try adding that information to the docs after they've been dynamically generated.

[TomerPacific]

@neflyte - Thanks for your reply. @cwarnermm , so what are you suggesting in regards to this feature (if it is indeed not possible)?

[TomerPacific]

@cwarnermm ?

[cwarnermm]

@hanzei - Are you open to guiding @TomerPacific on how to resolve this help wanted ticket?

[hanzei]

The code in https://developers.mattermost.com/integrate/plugins/components/webapp/reference/ is not auto-generated. It can be modified here in the repo.

[TomerPacific]

@cwarnermm , @hanzei - thanks for the update. So what would be the minimum server version required?

I noticed this changelog -> https://docs.mattermost.com/upgrade/version-archive.html

[hanzei]

Well, that is the tricky part of the ticket. You need to track the changelog or the git history down the the individual server releases that added a webapp method.