Upgrade to Docusaurus V3 by lee00678 · Pull Request #486 · f5/unovis

lee00678 · 2024-11-21T22:32:52Z

This PR addresses the dependency vulnerabilities by upgrading to docusaurus v3.

It's a pretty big change, it includes some root folder package.json update as well. In order to use react and reactdom@18 (required for v3), we need to remove packages/website/package-loc.json from install:clean script. This way we can ensure the build uses react@18.

defaultProps in our mdx file will cause an error/warning message. This is caused by MDX scanning the docs and look for words like defaultProps, we don't actually use them in our doc, they are just javascript objects. So renamed the example props.

Added a new authors.yml file under releases, this way we no longer to copy over all the author information for each release article.

To test: In the root folder do a npm run install:clean, npm run build, then run npm run website.

rokotyan

Looks good! You may also want to update the Contributing section to mention Solid.

rokotyan · 2024-11-25T15:26:50Z

 @zerollup/ts-transform-paths       perpetual       MIT           1.7.18             Stefan Zerkalica [email protected]
-react                              perpetual       MIT           16.14.0            n/a
-react-dom                          perpetual       MIT           16.14.0            n/a
+react                              perpetual       MIT           18.3.1             n/a


Surprised to see the React version change without any package.json updates

Yea, good question. I think, based on my understanding, the react version gets hoisted to the parent level, so because of the later version in packages/website/package-lock.json, this become a later version.

rokotyan · 2024-11-25T15:31:27Z

-  x: d=>d.x,
-  y: d=>d.y,
-});
+export const MyComponent = ({ type = "XYWrapper", n = 10, name = "StackedBar", x = (d) => d.x, y = (d) => d.y, data=generateDataRecords(n), ...customProps }) => {


I like this idea, but I find the name MyComponent sound a little bit too generic. Maybe DocsStackedBar instead?

rokotyan · 2024-11-25T15:40:08Z

defaultProps in our mdx file will cause an error/warning message. We need to start using defaultParams. I updated only the StackedBar.mdx as a test, once we agree on the approach, I will update the rest of the files.

@lee00678 Can you tell more about the defaultProps problem? What kind of error / warning?

lee00678 · 2024-11-25T20:22:54Z

defaultProps in our mdx file will cause an error/warning message. We need to start using defaultParams. I updated only the StackedBar.mdx as a test, once we agree on the approach, I will update the rest of the files.

@lee00678 Can you tell more about the defaultProps problem? What kind of error / warning?

@rokotyan This is warning we are getting caused by defaultProps. It occurs on pages where defaultProps are used. Component pages, for example.

rokotyan · 2024-11-27T00:19:00Z

@lee00678 I believe this error comes from React and is related to React's defaultProps, not to our defaultProps` which are just simple JavaScript objects.

The only place where Unovis uses it is here:

unovis/packages/react/src/composites/time-series/index.tsx

Lines 107 to 112 in 793277d

    
           VisTimeSeries.defaultProps = { 
        
             margin: { top: 10, bottom: 10, left: 10, right: 10 }, 
        
             autoMargin: true, 
        
             padding: {}, 
        
             x: (d: VisTimeSeriesDatum) => d.timestamp,

But this component part is not being used anywhere. I thought of releasing something like this to give our users slightly more complex components, but now I don't think it's a good idea (I would rather share it as an example).

I've tried commenting it out but still seeing the warning, so maybe some our our or Docusaurus dependencies uses defaultProps

lee00678 · 2024-12-02T18:24:42Z

Looks good! You may also want to update the Contributing section to mention Solid.

Resolved in a separate PR: #491

lee00678 · 2024-12-02T18:43:39Z

@lee00678 I believe this error comes from React and is related to React's defaultProps, not to our defaultProps` which are just simple JavaScript objects.

The only place where Unovis uses it is here:

unovis/packages/react/src/composites/time-series/index.tsx

Lines 107 to 112 in 793277d

VisTimeSeries.defaultProps = {

margin: { top: 10, bottom: 10, left: 10, right: 10 },

autoMargin: true,

padding: {},

x: (d: VisTimeSeriesDatum) => d.timestamp,

But this component part is not being used anywhere. I thought of releasing something like this to give our users slightly more complex components, but now I don't think it's a good idea (I would rather share it as an example).

I've tried commenting it out but still seeing the warning, so maybe some our our or Docusaurus dependencies uses defaultProps

I actually think this issue maybe simply caused by the fact we are calling them defaultProps, because for Line.mdx, we call it lineProps and the page is not erroring out. We could update the doc to avoid defaultProps and set to scatterProps etc. Since what we have is javascript object, maybe this is a better solution?

rokotyan · 2024-12-02T18:46:45Z

@lee00678 Maybe, let's try it

lee00678 · 2024-12-02T20:14:36Z

@lee00678 Maybe, let's try it

That seems to fix all the defaultProps warnings.

rokotyan · 2024-12-02T22:56:19Z

@lee00678 Great! I didn't have any other comments so I think we can go ahead and merge this

…m install:clean Website | Upgrade: Latest docusaurus V3 Svelte | Update: Name fix for docusaurus.config.js

…e note

…ow; Remove overrides in package.json

lee00678 marked this pull request as draft November 21, 2024 22:34

rokotyan approved these changes Nov 25, 2024

View reviewed changes

rokotyan reviewed Nov 25, 2024

View reviewed changes

Comment thread packages/website/package.json Outdated

lee00678 force-pushed the qian/upgrade-docusaurus branch 3 times, most recently from 81eb7d3 to 741ccf7 Compare November 25, 2024 19:20

lee00678 marked this pull request as ready for review December 2, 2024 19:54

lee00678 requested a review from sumitkumar25 December 3, 2024 00:02

lee00678 force-pushed the qian/upgrade-docusaurus branch from 237bc7b to 7be54cd Compare December 3, 2024 21:14

sumitkumar25 previously approved these changes Dec 3, 2024

View reviewed changes

lee00678 dismissed sumitkumar25’s stale review via 41fe402 December 4, 2024 19:42

sumitkumar25 previously approved these changes Dec 4, 2024

View reviewed changes

lee00678 added 7 commits December 4, 2024 12:39

Misc | Upgrade: Update dev dependencies

160ee4d

Core | Build: No longer remove packages/website/package-lock.json fro…

ebc5447

…m install:clean Website | Upgrade: Latest docusaurus V3 Svelte | Update: Name fix for docusaurus.config.js

Website | Author: Add authors.yml to avoid duplication in each releas…

8c3647d

…e note

Website | Build: Fix install:clean script

b2297d2

Website | Update: Fix all broken links, set onBrokenLinks back to thr…

e7836c5

…ow; Remove overrides in package.json

Website | Fix: Reaname defaultProps

a291c4b

Website | Blog: Update titles in authors.yml

c810d44

lee00678 dismissed sumitkumar25’s stale review via c810d44 December 4, 2024 20:45

lee00678 force-pushed the qian/upgrade-docusaurus branch from 41fe402 to c810d44 Compare December 4, 2024 20:45

sumitkumar25 approved these changes Dec 5, 2024

View reviewed changes

sumitkumar25 merged commit 5eda7bf into main Dec 5, 2024

Navigation Menu

Uh oh!

Upgrade to Docusaurus V3 - #486

Upgrade to Docusaurus V3#486
sumitkumar25 merged 7 commits into
mainfrom
qian/upgrade-docusaurus

lee00678 commented Nov 21, 2024 •

edited

Loading

Uh oh!

rokotyan left a comment

Uh oh!

Uh oh!

rokotyan Nov 25, 2024

Uh oh!

lee00678 Nov 25, 2024 •

edited

Loading

Uh oh!

rokotyan Nov 25, 2024

Uh oh!

Uh oh!

rokotyan commented Nov 25, 2024

Uh oh!

lee00678 commented Nov 25, 2024 •

edited

Loading

Uh oh!

rokotyan commented Nov 27, 2024

Uh oh!

lee00678 commented Dec 2, 2024

Uh oh!

lee00678 commented Dec 2, 2024

Uh oh!

rokotyan commented Dec 2, 2024

Uh oh!

lee00678 commented Dec 2, 2024

Uh oh!

rokotyan commented Dec 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

lee00678 commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rokotyan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rokotyan Nov 25, 2024

Choose a reason for hiding this comment

Uh oh!

lee00678 Nov 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rokotyan Nov 25, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rokotyan commented Nov 25, 2024

Uh oh!

lee00678 commented Nov 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rokotyan commented Nov 27, 2024

Uh oh!

lee00678 commented Dec 2, 2024

Uh oh!

lee00678 commented Dec 2, 2024

Uh oh!

rokotyan commented Dec 2, 2024

Uh oh!

lee00678 commented Dec 2, 2024

Uh oh!

rokotyan commented Dec 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lee00678 commented Nov 21, 2024 •

edited

Loading

lee00678 Nov 25, 2024 •

edited

Loading

lee00678 commented Nov 25, 2024 •

edited

Loading