Move documentation into src and make docs processing a single source of truth#2718
Draft
jimtng wants to merge 11 commits into
Draft
Move documentation into src and make docs processing a single source of truth#2718jimtng wants to merge 11 commits into
jimtng wants to merge 11 commits into
Conversation
…of truth This lets openhab-website use the same script when it clones openhab-docs during its preprocessing and load the latest processing logic instead of duplicating it. Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
✅ 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).Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
@florian-h05 this is what we discussed earlier about deduplicating the processing scripts between website and docs. Also see its counterpart in openhab/openhab-website#560 |
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
jimtng
force-pushed
the
refactor-prepare-docs
branch
from
5cdc904 to
ea46ce4
Compare
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
jimtng
force-pushed
the
refactor-prepare-docs
branch
from
ea46ce4 to
d8db01b
Compare
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>
Contributor
Author
|
The web site build that relies on this new PR is green now! This PR must be merged after being rebased on the latest main so that we can pick up and migrate the latest documents into |
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>
Contributor
Author
|
I won't have a lot of availability in the next month. Switching this to draft for now. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Move repository documentation into a new src/ layout and add tooling to support the migration and source-driven docs pipeline. Centralize docs-processing logic so other repos (notably openhab-website) can source the processing code from openhab-docs, removing duplicated processing logic and ensuring the website build always uses the latest processing logic.
Highlights:
scripts/docs/directory.