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.

Sign up for GitHub

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

Jump to bottom

feat(docs): uplift Docusaurus to v3 #28345

Merged
merged 9 commits into from May 6, 2024
Merged

feat(docs): uplift Docusaurus to v3 #28345

merged 9 commits into from May 6, 2024

Conversation

hainenber
Copy link
Contributor

@hainenber hainenber commented May 5, 2024 •
edited

feat(docs): uplift Docusaurus to v3

SUMMARY

Uplift Docusaurus to v3 and its related dependencies, most notably React. There are some additional changes

  • Specify Node version to be used in docs/ in .nvmrc, currently pinned at latest LTS version.
  • Upgrade React 17 to 18 and fix resulting type-check error
  • Fix various broken links and anchors.
  • Run yarn write-translation

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Visual and functionality stays the same. Expect no changes

TESTING INSTRUCTIONS

Run all yarn commands in docs/package.json and no command exits with non-zero signal.
Run yarn build && yarn serve, everything stays identical to https://superset.apache.org/docs/intro/

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@hainenber
chore(docs): specify latest LTS Node version
6561de1 
Signed-off-by: hainenber <[email protected]>
@hainenber
feat(docs): uplift Docusaurus to v3
29b14c4 
React version is uplift to v18
Update TS config with new path

Signed-off-by: hainenber <[email protected]>
@hainenber
feat(docs/api): remove non-im/export clause for mdx migration 1 -> 2
5053073 
Signed-off-by: hainenber <[email protected]>
@hainenber
chore(docs/src): remove React import due to automatic JSX runtime in …
e463bff 
…React 18

Signed-off-by: hainenber <[email protected]>
@hainenber
fix(docs/src/component): fix typecheck error after React 18 upgrade
7cfbd1f 
Signed-off-by: hainenber <[email protected]>
@hainenber
fix(docs): escape potential *.mdx expression
05a3232 
Signed-off-by: hainenber <[email protected]>
@hainenber
fix(docs): fix various broken links and anchors
a72043b 
Signed-off-by: hainenber <[email protected]>
@hainenber
chore(docs/i18n): run yarn write-translations
d408ada 
Signed-off-by: hainenber <[email protected]>
@github-actions github-actions bot added the doc Namespace | Anything related to documentation label May 5, 2024
@github-actions github-actions bot added the github_actions Pull requests that update GitHub Actions code label May 5, 2024
@john-bodley john-bodley requested a review from sfirke May 6, 2024 16:53
mistercrunch
mistercrunch approved these changes May 6, 2024
View reviewed changes
Copy link
Member

@mistercrunch mistercrunch left a comment

Choose a reason for hiding this comment

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

I pulled the branch, and ran yarn && yarn start and validated that everything builds and looks as expected.

@mistercrunch mistercrunch merged commit a2f0b98 into apache:master May 6, 2024
30 checks passed
@hainenber hainenber deleted the uplift-docusaurus-to-v3 branch May 7, 2024 01:16
imancrsrk pushed a commit to imancrsrk/superset that referenced this pull request May 10, 2024
@hainenber
feat(docs): uplift Docusaurus to v3 (apache#28345)
8d8cba9 
Signed-off-by: hainenber <[email protected]>
jzhao62 pushed a commit to jzhao62/superset that referenced this pull request May 16, 2024
@hainenber @jzhao62
feat(docs): uplift Docusaurus to v3 (apache#28345)
e724715 
Signed-off-by: hainenber <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mistercrunch mistercrunch mistercrunch approved these changes

@villebro villebro Awaiting requested review from villebro villebro is a code owner

@geido geido Awaiting requested review from geido geido is a code owner

@eschutho eschutho Awaiting requested review from eschutho eschutho is a code owner

@rusackas rusackas Awaiting requested review from rusackas rusackas is a code owner

@betodealmeida betodealmeida Awaiting requested review from betodealmeida betodealmeida is a code owner

@nytai nytai Awaiting requested review from nytai nytai is a code owner

@craig-rueda craig-rueda Awaiting requested review from craig-rueda craig-rueda is a code owner

@john-bodley john-bodley Awaiting requested review from john-bodley john-bodley is a code owner

@kgabryje kgabryje Awaiting requested review from kgabryje kgabryje is a code owner

@dpgaspar dpgaspar Awaiting requested review from dpgaspar dpgaspar is a code owner

@sfirke sfirke Awaiting requested review from sfirke

Assignees
No one assigned
Labels
doc Namespace | Anything related to documentation github_actions Pull requests that update GitHub Actions code size/XXL
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@hainenber @mistercrunch