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 to 2.0 #485

Merged
merged 7 commits into from
Aug 11, 2022
Merged

Update Docusaurus to 2.0 #485

merged 7 commits into from
Aug 11, 2022

Conversation

korthout
Copy link
Member

@korthout korthout commented Aug 10, 2022

Description

Apart from updating to the newer stable docusaurus 2.0, this also fixes the DocSearch indexing via Angolia.

  • updates @docusaurus/core and @docusaurus/presets-classic to the latest version: 2.0.1
  • updates the package-lock file to v2 format
  • configures the new Angolia app settings, which re-enables indexing of the docs for DocSearch (it seems the index was frozen and no longer updated)
  • updates GHA workflows to use node v18, to fix the doc CI

Related issues

NA

The new package-lock version contains more details and is more explicit.
Before updating packages with npm it makes sense to update this.
This fixes the following error at startup:

> [ERROR] ValidationError: themeConfig.hideableSidebar has been moved to
> themeConfig.docs.sidebar.hideable.
This was a new requirement from DocSearch. See
https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration for
more details.
It seems the urls are resolved differently now. The previous urls caused
compilation errors during `npm start`. Removing the `feel-scala` prefix
fixed these errors.
@korthout korthout requested a review from saig0 August 10, 2022 08:49
Copy link
Member

@saig0 saig0 left a comment

Choose a reason for hiding this comment

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

@korthout we're up-to-date again. Thank you 🚀

@saig0 saig0 merged commit 0664f8d into master Aug 11, 2022
@saig0 saig0 deleted the korthout-docusaurus-2-0 branch August 11, 2022 03:59
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.

2 participants