-
Notifications
You must be signed in to change notification settings - Fork 133
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
fix: Update docusaurus
to 2.4.1; fix swizzled React components
#2865
Conversation
❌ Deploy Preview for zowe-docs-master failed.
|
docusaurus
to 2.4.0; fix swizzled React components
Signed-off-by: Trae Yelovich <[email protected]>
0c8118b
to
f1dc7b8
Compare
Signed-off-by: Trae Yelovich <[email protected]>
Signed-off-by: Trae Yelovich <[email protected]>
Signed-off-by: Trae Yelovich <[email protected]>
Signed-off-by: Trae Yelovich <[email protected]>
The Netlify builds are still failing from time to time. This is likely due to RAM limitations as the free runner has up to 11GB, and all 11GB is not guaranteed to be free. The site peaks around 8GB during asset processing and without disabling minification, it is difficult to avoid this much RAM usage especially when using Docusaurus v2. More info here: facebook/docusaurus#4765 Node.js has the v8 argument The best option to reduce RAM usage here is to find the optimal value for Update (5/8/23): I've removed |
Signed-off-by: Trae Yelovich <[email protected]>
Signed-off-by: Trae Yelovich <[email protected]>
…runner Signed-off-by: Trae Yelovich <[email protected]>
d483840
to
61f4048
Compare
61f4048
to
597f0c4
Compare
Signed-off-by: Timothy Johnson <[email protected]>
597f0c4
to
1009b66
Compare
Co-authored-by: Timothy Johnson <[email protected]> Signed-off-by: Trae Yelovich <[email protected]>
Signed-off-by: Trae Yelovich <[email protected]>
Going to table this for now, as although the builds now succeed, there are a couple discrepancies with the layout that was introduced as a part of updating to Docusaurus 2.4.0. Hopefully I should be able to address those soon, but for now #2868 will resolve the random build failures - thanks @t1m0thyj ! |
This reverts commit 1009b66. Signed-off-by: Trae Yelovich <[email protected]>
1d30f83
to
af336f3
Compare
Pushing up commit shortly with following fixes:
|
docusaurus
to 2.4.0; fix swizzled React componentsdocusaurus
to 2.4.1; fix swizzled React components
see PR #2865 for more info Signed-off-by: Trae Yelovich <[email protected]>
docusaurus
to 2.4.1; fix swizzled React componentsdocusaurus
to 2.4.1; fix swizzled React components
Signed-off-by: Trae Yelovich <[email protected]>
…us-fc Signed-off-by: Trae Yelovich <[email protected]>
92c983e
to
990b737
Compare
Signed-off-by: Trae Yelovich <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this -- looks great!
Your checklist for this pull request
🚨Please review the guidelines for contributing to this repository.
If the changes in this PR is part of the next future release, make this pull request against the docs-staging branch which will be published at the next release boundary. If the changes in this PR are part of the current release, use the default base branch, master. For more information about branches, see https://github.com/zowe/docs-site/tree/master#understanding-the-doc-branches.
If this PR relates to GitHub issues in
docs-site
or other repositories, please list in Description, prefixed with close, fix or resolve keywords.Description (including links to related git issues)
This PR updates Docusaurus to the latest version (2.4.1). In addition, it resolves any broken React components as a result of updating from 2.0.0-beta.3. I've also made a couple adjustments to those components so that they do not break as a result of missing data. I built a list of breaking changes that I ran into from 2.0.0-beta.3 to 2.4.1:
versionMetadata
has movedDocItem
componentuseDocsVersion
in@docusaurus/theme-common/internal
themeConfig
hideableSidebar: true
themeConfig
themeConfig {} -> docs {} -> sidebar {} -> hideable
googleAnalytics
themeConfig
@docusaurus/preset-classic
configuseAlgoliaContextualFacetFilters
import has changed@theme/hooks/useAlgoliaContextualFacetFilters
@docusaurus/theme-search-algolia/client
useVersions, useLatestVersion, useActiveDocContext
import has moved@theme/hooks/useDocs
@docusaurus/plugin-content-docs/client
InitialMDXComponents
import has moved@theme-init/MDXComponents
@theme/MDXComponents
useActiveVersion
import has moved@theme/hooks/useDocs
@docusaurus/plugin-content-docs/client
useTitleFormatter
import has moved@docusaurus/theme-common
@docusaurus/theme-common/internal
useActivePlugin
import has moved@theme/hooks/useDocs
@docusaurus/plugin-content-docs/client
useDocVersionSuggestions
import has moved@theme/hooks/useDocs
@docusaurus/plugin-content-docs/client
useTOCHighlight
import has moved@theme/hooks/useTOCHighlight
@docusaurus/theme-common/internal
colorMode.switchConfig
is deprecated- Note from docusaurus PR 6771: If you want to customize the icons for light and dark mode, swizzle
IconLightMode
,IconDarkMode
, orColorModeToggle
instead❤️Thank you!