[OPS-510] Overhaul docs building #101
Merged
Conversation
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
Member
alourie
force-pushed
the
OPS-510-support-ednar
branch
from
ddb26f9 to
5e40acf
Compare
This change refactors how we build the documentation: - Introduce a new workflow, build-docs that calls docusaurus-action and builds the docs. - It can also optionally "version tag" the docs - It can also "deploy" the docs (ie build the zipped archive for later deployment). - It introduces the use of a new environment parameter called PRODUCT (to differentiate the deployment of evolve and ednar). Other workflows were adapted to use this new flow. The benefit of this refactoring is that all aspects of the documentation building are now controlled centrally via 1 flow. Additionally, it allows to easily create separate, stand-alone docs-deployment flows. Signed-off-by: Alex Lourie <[email protected]>
alourie
force-pushed
the
OPS-510-support-ednar
branch
from
5e40acf to
44257ab
Compare
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
kgreav
previously approved these changes
Nov 28, 2025
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
Signed-off-by: Alex Lourie <[email protected]>
charlta
approved these changes
Dec 1, 2025
Member
charlta
left a comment
charlta
left a comment
There was a problem hiding this comment.
Approved so you can merge if you don't need to address anything with my question.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This change refactors how we build documentation:
build-docsthat calls docusaurus-action and builds the docs.PRODUCT(to deploy evolve and ednar).Other workflows were adapted to use this new flow.
The benefit of this refactoring is that all aspects of the documentation building are now controlled centrally via 1 flow.
Testing
Currently testing the following flows:
Dependency
This will also require zepben/docusaurus-action#18 PR to be merged.
Breaking Changes
This is quite a big change and I might have missed something somewhere, so will have to be diligent and fix fast.