-
Notifications
You must be signed in to change notification settings - Fork 109
feat(*): [MUK-CLI] Import ODS Components Documentation in Manager-wiki #19783
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
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
anooparveti
approved these changes
Oct 17, 2025
aboungnaseng-ovhcloud
approved these changes
Oct 17, 2025
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19480 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19481 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19481 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19481 Signed-off-by: helabenkhalfallah <[email protected]>
ref: #MANAGER-19481 Signed-off-by: helabenkhalfallah <[email protected]>
1d8a9ae
to
7f6e599
Compare
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 PR introduces a complete Design System documentation synchronization pipeline to the
manager-muk-cli
tool.Ticket Reference: #MANAGER-19481
✨ New Command
--add-components-documentation
A new CLI command that automatically fetches, streams, and synchronizes ODS component documentation (
.mdx
files) from the official ovh/design-system GitHub repository into the internalmanager-wiki
.🧠 Key Features
Fully streaming extraction pipeline
Uses Node.js streams and async queues for low-memory, high-performance tarball processing.
Automatic cache layer (7-day TTL)
Caches downloaded ODS tarballs (
.tar.gz
) and extracted documentation to avoid redundant network requests.Component-level synchronization
Streams documentation for each ODS component into its corresponding wiki folder:
Smart directory initialization
Detects existing components, creates missing ones, and safely refreshes their
base-component-doc
structure without overwriting unrelated files.Automatic import rewriting
Applies path rewrites for compatibility with the Manager codebase:
../../../src/
→../../../base-documents/
ods-react/src/
→@ovhcloud/ods-react
Verbose emoji logging
Clear, progressive feedback for each operation (ideal for CI/CD observability).
⚙️ Architecture Overview
✅ Example Output
Additional Information
DISABLE_ODS_DOCS_CACHE
).--check-versions
,--check-components
, and--add-components
.