Skip to content

Fetch external documentation contents through a Ruby pipeline#2749

Merged
florian-h05 merged 6 commits into
openhab:mainfrom
florian-h05:refactor-fetch-external-docs
Jul 6, 2026
Merged

Fetch external documentation contents through a Ruby pipeline#2749
florian-h05 merged 6 commits into
openhab:mainfrom
florian-h05:refactor-fetch-external-docs

Conversation

@florian-h05

@florian-h05 florian-h05 commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

This aims at replacing the combination of Maven plugins and Groovy scripts in the final branch at fetching and integrating external contents (e.g., openhab-addons) into the documentation.

Previously done through a combination of Maven plugins & Groovy scripts.

Signed-off-by: Florian Hotze <dev@florianhotze.com>
…y to prepare-docs

Signed-off-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@netlify

netlify Bot commented Jul 6, 2026

Copy link
Copy Markdown

Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Name Link
🔨 Latest commit cc64343
🔍 Latest deploy log https://app.netlify.com/projects/openhab-docs-preview/deploys/6a4bb35ca09da20009bc7970
😎 Deploy Preview https://deploy-preview-2749--openhab-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@florian-h05 florian-h05 added this to the 5.3 milestone Jul 6, 2026
@florian-h05
florian-h05 merged commit e20f713 into openhab:main Jul 6, 2026
5 checks passed
@florian-h05
florian-h05 deleted the refactor-fetch-external-docs branch July 6, 2026 14:30
florian-h05 pushed a commit to openhab/openhab-website that referenced this pull request Jul 6, 2026
Remove duplicated openhab-docs processing code from the openhab-website
repository and source the processed docs from the openhab-docs repository.

During website preprocessing, the openhab-docs repo is cloned into a
temporary directory and its processed docs and addons content is copied
over to where the website expects it. Docs preprocessing is now done entirely
in openhab-docs, the website contents that need pre-processing have access
to the processing logic from openhab-docs.
This eliminates duplication, reduces maintenance overhead, and
makes docs processing a single source of truth.

Depends on openhab/openhab-docs#2718
Depends on openhab/openhab-docs#2749.

---------

Also-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Comment thread .gitignore

# Built docs
.vuepress/thing-types.json
addons

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This line (addons) excludes the images/addons folder. I don't think that should be done?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Just pushed a fix 👍

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.

2 participants