search

openhab / openhab-webui

Web UIs of openHAB
Eclipse Public License 2.0
213 stars 234 forks source link

Update website and doc repo links to use archived 3.4.x docs #2502

Closed florian-h05 closed 2 months ago

florian-h05 commented 2 months ago

This is required to keep add-on logos working for 3.4.x, because with the introduction of SVG logo support and the conversion of some logos, 3.4.x would not be able to display SVG logos. For the docs, it is also really helpful to link to the docs matching the version, because due to the number of breaking changes for openHAB 4.0 there are larger difference in parts of the docs. Linking the wrong could cause confusion.

florian-h05 commented 2 months ago

@stefan-hoehn I have addressed your review. Do wou want to have another look or should I merge now?

ghys commented 2 months ago

This looks good to me, but it supposes we are able to make a patch release to OH 3.4 ... @kaikreuzer can we even do that - I'm really not sure? (I'd argue that we should support 3.4 for a while still, at least for security fixes and some breaking changes, and therefore we should, but whether we're technically able to is another matter...)

because with the introduction of SVG logo support and the conversion of some logos

Wouldn't it be simpler to not remove the PNG versions so that 3.4 instances could still access them, that is, keep the 2 versions, instead of just removing the PNG when adding a SVG (as in https://github.com/openhab/openhab-docs/pull/2256)? If I understand it correctly from #2402, there is no harm in keeping the PNG version around.

florian-h05 commented 2 months ago

Wouldn't it be simpler to not remove the PNG versions so that 3.4 instances could still access them

Sure, however do I also want to change the doc links so Blockly etc link to the 3.4 docs. Blockly had major changes from 3.4 to 4.0 and I guess it can be confusing to look at the 4.1 docs (at the moment) when clicking on help on openHAB 3.4.

I think it is technically possible to release a 3.4.x patch release.

stefan-hoehn commented 2 months ago

@stefan-hoehn I have addressed your review. Do wou want to have another look or should I merge now?

Sorry, I overlooked your comment. Yes, all good now.