Skip to content
This repository has been archived by the owner on Feb 21, 2024. It is now read-only.

feat: update to docusaurs 3.0 #152

Merged
merged 7 commits into from
Nov 9, 2023
Merged

feat: update to docusaurs 3.0 #152

merged 7 commits into from
Nov 9, 2023

Conversation

tomarra
Copy link
Contributor

@tomarra tomarra commented Nov 2, 2023

Status

In Development

Description

With Docusaurs 3.0 out now, updating our template to use the newest version. This is going to need a decent amount of testing but overall it seems to be up and running without much issue.

Fixes #134

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

@tomarra tomarra marked this pull request as ready for review November 6, 2023 19:21
@tomarra tomarra mentioned this pull request Nov 6, 2023
1 task
@alestiago alestiago requested a review from a team as a code owner November 8, 2023 09:36
@alestiago
Copy link
Contributor

alestiago commented Nov 8, 2023

I cloned the directory and generated a documentation site with the new brick.

I got 3 deprecation warnings:

npm WARN deprecated stable@0.1.8: Modern JS already guarantees Array#sort() is a stable sort, so this library is deprecated. See the compatibility table on MDN: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#browser_compatibility
npm WARN deprecated @babel/plugin-proposal-object-rest-spread@7.12.1: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
npm WARN deprecated trim@0.0.1: Use String.prototype.trim() instead

And I got 22 vulnerabilities:

added 1239 packages, and audited 1240 packages in 1m

219 packages are looking for funding
  run `npm fund` for details

22 vulnerabilities (4 moderate, 18 high)

To address issues that do not require attention, run:
  npm audit fix

To address all issues (including breaking changes), run:
  npm audit fix --force

I was able to build (npm run build) and serve (npm run serve) the website without any problem .

I'm happy with merging as is but if so, we should follow-up with a Pull Requests fixing the deprecation and vulnerabilities.

@tomarra
Copy link
Contributor Author

tomarra commented Nov 8, 2023

I got 3 deprecation warnings:

These I'm not sure if we can/should do much about but let me look

And I got 22 vulnerabilities:

Let me run the audit fix and see if we can get that a little cleaner

@tomarra tomarra merged commit 4f863f9 into main Nov 9, 2023
2 checks passed
@tomarra tomarra deleted the feat/update-docu-3.0 branch November 9, 2023 15:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: support docussaurus v3
2 participants