Update website and doc repo links to use archived 3.4.x docs #2502
Conversation
florian-h05
force-pushed
the
3.4.x-docs-link
branch
2 times, most recently
from
27e0b66
to
3a136a5
Compare
bundles/org.openhab.ui/web/src/assets/openhab-js-tern-defs.json
Outdated
Show resolved
Hide resolved
bundles/org.openhab.ui/web/src/assets/openhab-js-tern-defs.json
Outdated
Show resolved
Hide resolved
bundles/org.openhab.ui/web/src/pages/developer/blocks/blocks-edit.vue
Outdated
Show resolved
Hide resolved
| @@ -143,8 +143,7 @@ export default { | |||
| }, | |||
| imageUrl () { | |||
| if (this.addon.imageLink) return this.addon.imageLink.replace(/^\/\//, 'https://') | |||
| let docsBranch = 'final' | |||
| if (this.$store.state.runtimeInfo.buildString === 'Release Build') docsBranch = 'final-stable' | |||
| let docsBranch = 'final-3.4.x' | |||
There was a problem hiding this comment.
In general I don't like the idea of the hardcoded branch name here but in main this part is gone anyway.
There was a problem hiding this comment.
The hard-coded branch name is however needed here, as this whole PR is just there to make the already releases 3.4.x version access the archived docs. main is a. unaffected and b. has improved the whole website link and add-on logo code, so that if we ever need to fix the docs version again after a future release, we have to change less code.
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
florian-h05
force-pushed
the
3.4.x-docs-link
branch
from
bf55169
to
262b3fd
Compare
|
@stefan-hoehn I have addressed your review. |
|
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?
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 openhab/openhab-docs#2256)? If I understand it correctly from #2402, there is no harm in keeping the PNG version around. |
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. |
Sorry, I overlooked your comment. Yes, all good now. |
florian-h05
added
patch
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.