Consideration for Standardising the Compatibility Matrix

[cruse1977]

What should be added/changed?

Hey,

Im trying to standardise some documentation around plugins in the NetBox Plugin catalogue, ideally to include a matrix like the below in the primary github readme. The matrix in the readthedocs link is good, but ideally, in the readme but would be better.

Also, consideration around "multi version" support. We saw an issue recently whereas v3.2 of the plugin caused issues on v4.3 of netbox which required an upgrade to v3.3 - in a VM deployment this is fairly trivial but in a managed or k8s environment considerably more difficult - hence consideration of 1 track per netbox version.

Minor things, but appreciated if they could be considered and thanks for a great plugin

Motivation

Standardisation around plugins within the NetBox plugin catalogue

[amyasnikov]

We saw an issue recently whereas v3.2 of the plugin caused issues on v4.3 of netbox

This was caused by breaking changes within one of the NetBox v4.3.x bugfix releases. Validity 3.2 and initial v4.3 releases worked well.

which required an upgrade to v3.3

Well, if one plugin version had supported exactly one NB release, in this situation you would have had to upgrade both NetBox + Validity which obviously would have been more painful than just the plugin upgrade.

[amyasnikov]

ideally to include a matrix like the below in the primary github readme

To be honest, I've never liked these giant tables in the readme. I think they take inappropriate amount of space (and keep growing) on the main page of the project.

standardise some documentation around plugins

In my opinion, if some web page existed where you could select a version of NetBox and instantly got plugins list with the most appropriate versions, this would be really great from user's perspective, much more handy than the table stuff. I'd love to give a link to that page from my readme.md