Skip to content

Centralize docs processing in openhab-docs#560

Draft
jimtng wants to merge 15 commits into
openhab:mainfrom
jimtng:dry-ruby-scripts
Draft

Centralize docs processing in openhab-docs#560
jimtng wants to merge 15 commits into
openhab:mainfrom
jimtng:dry-ruby-scripts

Conversation

@jimtng
Copy link
Copy Markdown
Contributor

@jimtng jimtng commented May 8, 2026

Remove duplicated openhab-docs processing code from the openhab-website
repository and source the logic from the openhab-docs repository.

During website preprocessing the openhab-docs repo is cloned into a
temporary directory and its docs-processing code is loaded from that
clone, ensuring the website build always uses the latest processing
logic. This eliminates duplication, reduces maintenance overhead, and
makes docs processing a single source of truth.

Depends on openhab/openhab-docs#2718

This PR currently performs copying temporary shims to successfully build while the docs PR is not yet merged. Once the docs PR is merged and an openhabian docs get pushed with the updated action from openhab/openhab-docs#2718 we can update this to remove the additional process, although it should be harmless if it isn't removed immediately.

jimtng added 5 commits May 8, 2026 23:20
Remove duplicated openhab-docs processing code from the openhab-website
repository and source the logic from the openhab-docs repository.

During website preprocessing the openhab-docs repo is cloned into a
temporary directory and its docs-processing code is loaded from that
clone, ensuring the website build always uses the latest processing
logic. This eliminates duplication, reduces maintenance overhead, and
makes docs processing a single source of truth.

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
@jimtng jimtng force-pushed the dry-ruby-scripts branch from 9032094 to a3bc413 Compare May 8, 2026 13:20
jimtng added 7 commits May 8, 2026 23:25
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
@jimtng jimtng force-pushed the dry-ruby-scripts branch from 114bf0a to f437d58 Compare May 9, 2026 12:34
@jimtng
Copy link
Copy Markdown
Contributor Author

jimtng commented May 9, 2026

Deploy was successful. Deploy preview: https://deploy-preview-560--openhab.netlify.app/

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
@jimtng jimtng marked this pull request as ready for review May 9, 2026 13:19
@jimtng
Copy link
Copy Markdown
Contributor Author

jimtng commented May 9, 2026

Note: future cleanup of process_markdown method could be done after it's merged, since some of the things it's trying to fix could've been fixed directly at the source documents. Some are no longer applicable since they've been fixed at source.

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
@jimtng jimtng force-pushed the dry-ruby-scripts branch from a301708 to 992c8e6 Compare May 10, 2026 03:16
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
@jimtng jimtng marked this pull request as draft May 11, 2026 02:45
@jimtng
Copy link
Copy Markdown
Contributor Author

jimtng commented May 11, 2026

I won't have a lot of availability in the next month. Switching this to draft for now.

@florian-h05
Copy link
Copy Markdown
Contributor

Once I am finished with reviewing everything that we want in 5.2, I can test and finish this.

@jimtng
Copy link
Copy Markdown
Contributor Author

jimtng commented May 11, 2026

Feel free to continue on it. I think it's done pending review. I won't be completely offline. Also I hope @ccutrer can help review the ruby bits.

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