Revert "Bump docusaurus to v3.9 latest (#945)" #960
Closed
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
github-actions
bot
requested review from
akashraj4261,
dariavladykina and
jillian-maroket
This reverts commit 39c3df1. Signed-off-by: Martin Dekov <martin.dekov@suse.com>
martindekov
force-pushed
the
revert9791
branch
from
ecaa676 to
53ea29d
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reverts the Docusaurus upgrade from v3.9 to v2.4 due to Algolia search compatibility issues encountered with the newer version.
Changes:
- Downgraded all Docusaurus core packages and plugins from v3.9.0 to v2.4.0
- Reverted configuration files and imports to v2.x API compatibility
- Updated markdown syntax in documentation files to work with v2.x MDX parser
Reviewed changes
Copilot reviewed 16 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Downgraded all Docusaurus packages from v3.9.0 to v2.4.0, including related dependencies (MDX, prism-react-renderer, image-zoom, openapi-docs plugins) |
| docusaurus.config.js | Reverted configuration to v2.x API: changed prism-react-renderer imports, replaced future.v4 flags with webpack config, reverted markdown config structure |
| babel.config.js | Re-added babel configuration file required for v2.x |
| sidebars.js | Changed API sidebar reference from TypeScript (.ts) to JavaScript (.js) file format used by v2.x openapi-docs plugin |
| src/theme/DocVersionBanner/index.js | Updated imports to use v2.x paths: moved useDocsVersion and useDocsPreferredVersion from plugin-content-docs/client to theme-common/internal |
| docs/troubleshooting/installation.md | Changed <VIP> markdown syntax from backticks to escaped brackets for v2.x MDX compatibility |
| versioned_docs/version-v1.*/troubleshooting/installation.md | Applied same markdown syntax fix across all versioned documentation |
| docs/api/category.json | Re-added category configuration file required for v2.x API sidebar structure |
| versioned_docs/version-v1.*/api/category.json | Re-added category configuration files for all versioned API directories |
| README.md | Updated documentation reference from "Docusaurus 3" to "Docusaurus 2" and restored PDF generation instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
jillian-maroket
requested review from
Yu-Jack
and removed request for
akashraj4261 and
dariavladykina
Contributor
Author
|
Merged the fix: #961 closing this one |
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.
This reverts commit 39c3df1.
Problem:
Algolia search has problems with the docosaurus 3.9
Solution:
This commit reverts the bump to docosaurus 3.9 back to 2.4 while we seek alternative or fix the solution. Quick fix is not available as this is null pointer bug in one of the downstream components.
Related Issue(s):
harvester/harvester#9791
Test plan:
N/A - this is a revert
Additional documentation or context
Docsearch is throwing somewhere inside null pointer, changing from algolia search to alternative easyops-cn/docusaurus-search-local seems to avoid the issue, but migrating to other compatible searching solution is not a "quick fix" more details in note here:
https://docusaurus.io/blog/releases/3.9#docsearch-v4
Alternatives like:
Are very slow so not sure if it's possible to even replace the algolia plugin