You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains 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
Looks like custom components now require capital-case. Renamed this component from detailsToggle to DetailsToggle and updated component usage on all pages.
With the upgrade, there are a number of warnings in the build logs for broken anchor links. MDX v3 improves the built-in linting. I sorted out all formatting errors causing build failures as part of this PR. I don't see these as a blocker to this PR, as they also exist on the live site. However, these warnings should still be cleaned up at some point. The docs team can now see these broken anchor links and sort out as needed. Example from the log below:
Broken anchor on source page path = /reference/resource-configs/spark-configs:
-> linking to #databricks-setup (resolved as: /reference/resource-configs/spark-configs#databricks-setup)
Docusaurus provides a command to check for MDX formatting errors as well, which can help when writing content locally: npx docusaurus-mdx-checker
Removed the swizzled CodeBlock MDX component, which we customized (over 3 years ago) to support markdown links within code blocks.
Removed the FAQList custom component as it was causing errors and is not used anywhere on the site.
An additional benefit with the upgrade is it looks like the build times improved. They now take ~3.5-4 minutes to complete, rather than 7-8 minutes.
The reason will be displayed to describe this comment to others. Learn more.
Went through a ton of pages. All is looking good aside from the two items I called out in comments above. Let me know if you have any questions on those.
@john-rock Nice finds, both of these should now be fixed.
@runleonarun Is there anything else you and the team would like to check with this upgrade before we go live? If not, we can likely go live by tomorrow.
contentImprovements or additions to contentdeveloper blogThis content fits on the developer blog.guidesKnowledge best suited for Guidessize: largeThis change will more than a week to address and might require more than one person
6 participants
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.
github-actions
bot
added
content
What are you changing in this pull request and why?
Upgrades Docusaurus to latest version (3.4.0). This PR includes:
See full Docusaurus upgrade details here
Previews
Verify cards correctly show
hoverSnippetfrontmatter property if set, and that the full description shows on the card:Verify page with
detailscomponent loads without error:Verify trusted adapters page matches live site after removing
MSCalloutcomponent which does not exist. This was added in PR #4874:Fix import for
RowsAffectedsnippet:Verify FAQs show at the bottom of this page:
Verify snippets still work (first paragraph on the following page):
Verify built-in partials still work:
TODO Before Merge
{props.type}) was causing a build errordetailsToggletoDetailsToggleand updated component usage on all pages.Notes
Removed the
Snapshots/snapshot-target-schemafaq from the following pages, as this faq does not exist and is empty on the live site:With the upgrade, there are a number of warnings in the build logs for broken anchor links. MDX v3 improves the built-in linting. I sorted out all formatting errors causing build failures as part of this PR. I don't see these as a blocker to this PR, as they also exist on the live site. However, these warnings should still be cleaned up at some point. The docs team can now see these broken anchor links and sort out as needed. Example from the log below:
Docusaurus provides a command to check for MDX formatting errors as well, which can help when writing content locally:
npx docusaurus-mdx-checkerRemoved the swizzled
CodeBlockMDX component, which we customized (over 3 years ago) to support markdown links within code blocks.Removed the
FAQListcustom component as it was causing errors and is not used anywhere on the site.An additional benefit with the upgrade is it looks like the build times improved. They now take ~3.5-4 minutes to complete, rather than 7-8 minutes.