Skip to content
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

Update Docusaurus Version #862

Merged
merged 5 commits into from
Oct 19, 2021
Merged

Update Docusaurus Version #862

merged 5 commits into from
Oct 19, 2021

Conversation

JKarlavige
Copy link
Collaborator

@JKarlavige JKarlavige commented Oct 14, 2021

Description & motivation

Asana Task

This is an effort to upgrade Docusaurus to the latest version (v2.0.0-beta.6) in order to utilize newer features on the platform.

Notes on a couple changes and new features:

  • The new version has a new Algolia search, which functions a bit differently than the current search. This is visually different on both mobile and desktop as well.
  • There is also broken link checkers, which causes the build to fail by default. Since we have a 'bad-link' example on the /styles page, I changed this check to only warn of broken links. This allows the build to succeed. Using this link check, I updated/fixed all broken links which were flagged.
  • The new version has some updated styles as well. I made adjustments to mirror our current site as much as possible, but some slight differences may be noticeable, for example with element padding/breakpoints/etc.
  • Now that we will be on the latest version, it may be a good time to review the docs again to see what new features are available. A couple examples include the live coding component, as well as the ability to add a title to code examples (which we currently use a custom component for.)
  • A number of duplicate slug warnings occur as well, both on this version and the live site. I will let these remain as is due to not knowing which version of the url should be used.

A side note:
The new Docusaurus requires a Node Version of > 12. This site was originally built on Node v10. I had to add a NODE_VERSION env variable to update the node version for this site. Just want to note that this is when that env variable was set.

Pre-release docs

Is this change related to an unreleased version of dbt?

  • No: please ensure the base branch is current

Link to preview

Copy link
Contributor

@krevitt krevitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did a styling review and all looked good, outside of one link styling issue noted above.

@JKarlavige JKarlavige requested a review from krevitt October 14, 2021 17:18
@JKarlavige JKarlavige merged commit 036723e into current Oct 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants