Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ism8] Fix broken image in docs #2341

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

holgerfriedrich
Copy link
Member

@holgerfriedrich holgerfriedrich commented Jul 29, 2024

try to backport openhab/openhab-addons#17175 to stable docs, not sure if this is the right way to do it

Signed-off-by: Holger Friedrich <[email protected]>
@holgerfriedrich
Copy link
Member Author

holgerfriedrich commented Sep 29, 2024

Docs (stable) are still broken, image "Result" is empty.

@stefan-hoehn can you assist how to back-port the fix from 4.3? Is this the way to do it? Many thanks!

@stefan-hoehn
Copy link
Contributor

@holgerfriedrich
@florian-h05
@pgfeller

AFAIK, the addons content is not managed via the docs repo. Hence the path "_addons_bindings/ism8/readme.md" doesn't even exist in the repo. So at least this PR IMHO doesn't make sense.
Only when the website is built, the whole content comes together.

Patrik, Florian, do you know? How do we backport this?

Copy link
Contributor

@florian-h05 florian-h05 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

This is the correct way of backporting the doc fix to the stable docs.

Some explanation how the ism8 readme ends up inside the docs repo:
Our Jenkins CI is collecting documentation from several repos and commits to the final branch of the openhab-docs repo.
In normal cases, you fix a doc issue in the source repo and Jenkinks will pick up the fix there and bring it to openhab-docs final branch.
The final-stable branch is based of the current final branch on release and won't be updated anymore by Jenkins, so any doc fix/change needs to be done manually (like in this PR).

@stefan-hoehn
Copy link
Contributor

First of all, my bad. The path "_addons_bindings/ism8/readme.md" does exist but only in final-stable (and not in main) as these are created via the jenkins build when processing final-stable.

So, all good as mentioned by Florian.

@stefan-hoehn stefan-hoehn merged commit cbad1a8 into openhab:final-stable Oct 1, 2024
@holgerfriedrich holgerfriedrich deleted the pr-ism8 branch October 1, 2024 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants