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

[Upgrade] Docusaurus Beta 22 support #155

Merged
merged 13 commits into from
Jul 13, 2022
Merged

[Upgrade] Docusaurus Beta 22 support #155

merged 13 commits into from
Jul 13, 2022

Conversation

blindaa121
Copy link
Collaborator

@blindaa121 blindaa121 commented Jul 12, 2022

Description

This PR introduces support for Docusaurus 2.0.0-beta.22. The following breaking changes have been resolved:

  • Updating the import for DocItemFooter component to the following path @theme/DocItem/Footer and removing previously passed down props
  • Wrapping ApiItem with DocProvider
  • Updating imports for CodeTabs, ApiTabs, and SchemaTabs utils that have been moved into @docusaurus/theme-common/internal module

TODO

Motivation and Context

Provide support and compatibility with the latest version of Docusaurus. In addition, refactoring of the ApiItem into smaller components increases the ease of maintainability and may prevent further breaking changes in the future.

How Has This Been Tested?

Tested deployed preview against the live site to ensure that there weren't any significant changes, unexpected behaviors, and all components that were refactored are functionally intact. From the UI perspective, all styles should remain consistent and unchanged prior to refactor.

Screenshots (if appropriate)

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@github-actions
Copy link

github-actions bot commented Jul 12, 2022

Visit the preview URL for this PR (updated for commit 631557e):

https://docusaurus-openapi-36b86--pr155-hdpr1rk6.web.app

(expires Fri, 12 Aug 2022 02:02:18 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@github-actions
Copy link

github-actions bot commented Jul 12, 2022

Size Change: -101 kB (-3%)

Total Size: 3.28 MB

Filename Size Change
demo/build/assets/css/styles.********.css 95.6 kB +714 B (+1%)
demo/build/assets/js/05f64ae1.********.js 2.8 kB -165 B (-6%)
demo/build/assets/js/06e5f0f0.********.js 27.1 kB -2.65 kB (-9%)
demo/build/assets/js/081bfb0d.********.js 9.79 kB -127 B (-1%)
demo/build/assets/js/09e07b87.********.js 3 kB -164 B (-5%)
demo/build/assets/js/112df51d.********.js 20.2 kB -127 B (-1%)
demo/build/assets/js/14eb3368.********.js 9.33 kB -173 B (-2%)
demo/build/assets/js/1639936b.********.js 4.05 kB -302 B (-7%)
demo/build/assets/js/1676ff52.********.js 10.2 kB -124 B (-1%)
demo/build/assets/js/16ed3e0d.********.js 19.7 kB -127 B (-1%)
demo/build/assets/js/18c41134.********.js 12.7 kB -1.83 kB (-13%) 👏
demo/build/assets/js/1be78505.********.js 10.3 kB -1.11 kB (-10%) 👏
demo/build/assets/js/1e4232ab.********.js 3.15 kB -125 B (-4%)
demo/build/assets/js/1e71f858.********.js 17.3 kB -127 B (-1%)
demo/build/assets/js/1f3711ab.********.js 17.8 kB -127 B (-1%)
demo/build/assets/js/1f818248.********.js 10.9 kB -1.08 kB (-9%)
demo/build/assets/js/21b83554.********.js 10 kB -127 B (-1%)
demo/build/assets/js/25b7fcf3.********.js 16.1 kB -127 B (-1%)
demo/build/assets/js/2610c6ee.********.js 17.8 kB -127 B (-1%)
demo/build/assets/js/2a3d8b7d.********.js 11.6 kB -127 B (-1%)
demo/build/assets/js/2b60538e.********.js 16 kB -127 B (-1%)
demo/build/assets/js/2c860537.********.js 6.92 kB -127 B (-2%)
demo/build/assets/js/2da0bfe8.********.js 17.8 kB -127 B (-1%)
demo/build/assets/js/2ee3fbbb.********.js 11.1 kB -127 B (-1%)
demo/build/assets/js/326c3861.********.js 9.59 kB -301 B (-3%)
demo/build/assets/js/36675a4b.********.js 22.3 kB -126 B (-1%)
demo/build/assets/js/374f9103.********.js 15.4 kB -127 B (-1%)
demo/build/assets/js/39d00f16.********.js 9.45 kB -300 B (-3%)
demo/build/assets/js/46afcded.********.js 8.13 kB -2.91 kB (-26%) 🎉
demo/build/assets/js/46e5c6ac.********.js 6.66 kB -1.34 kB (-17%) 👏
demo/build/assets/js/47abaca6.********.js 2.9 kB -165 B (-5%)
demo/build/assets/js/4851c287.********.js 11.2 kB -127 B (-1%)
demo/build/assets/js/4964e910.********.js 16.7 kB -127 B (-1%)
demo/build/assets/js/49d625b5.********.js 17.3 kB -127 B (-1%)
demo/build/assets/js/4bdd3fbe.********.js 15.3 kB -127 B (-1%)
demo/build/assets/js/4c5e977b.********.js 30.9 kB -459 B (-1%)
demo/build/assets/js/5103.********.js 0 B -1.37 MB (removed) 🏆
demo/build/assets/js/52efb675.********.js 10.1 kB -127 B (-1%)
demo/build/assets/js/533a09ca.********.js 2.48 kB -126 B (-5%)
demo/build/assets/js/55b55784.********.js 8.75 kB -127 B (-1%)
demo/build/assets/js/56717cba.********.js 2.96 kB -164 B (-5%)
demo/build/assets/js/58ff8b1e.********.js 20.6 kB -126 B (-1%)
demo/build/assets/js/5c868d36.********.js 3.24 kB -126 B (-4%)
demo/build/assets/js/5fb917be.********.js 2.5 kB -127 B (-5%)
demo/build/assets/js/6102b0bc.********.js 22.4 kB -127 B (-1%)
demo/build/assets/js/64ad353b.********.js 20.1 kB -803 B (-4%)
demo/build/assets/js/6b63c616.********.js 19.9 kB -804 B (-4%)
demo/build/assets/js/6dbe9da1.********.js 19.6 kB -126 B (-1%)
demo/build/assets/js/6eec44b8.********.js 8.81 kB -127 B (-1%)
demo/build/assets/js/71f1585f.********.js 11.2 kB -127 B (-1%)
demo/build/assets/js/7633a546.********.js 9.97 kB -127 B (-1%)
demo/build/assets/js/7933a256.********.js 20.1 kB -127 B (-1%)
demo/build/assets/js/7a7d82e8.********.js 17.1 kB -127 B (-1%)
demo/build/assets/js/822bd8ab.********.js 2.87 kB -126 B (-4%)
demo/build/assets/js/8287.********.js 0 B -1.09 kB (removed) 🏆
demo/build/assets/js/835a9617.********.js 11.3 kB -127 B (-1%)
demo/build/assets/js/840731c0.********.js 10.5 kB -127 B (-1%)
demo/build/assets/js/8463bcfe.********.js 16.1 kB -127 B (-1%)
demo/build/assets/js/85d3c400.********.js 2.9 kB -166 B (-5%)
demo/build/assets/js/85ec4403.********.js 4.43 kB -127 B (-3%)
demo/build/assets/js/892ce721.********.js 20 kB -803 B (-4%)
demo/build/assets/js/8ab9b16e.********.js 9.61 kB -127 B (-1%)
demo/build/assets/js/8d4e78cd.********.js 2.81 kB -165 B (-6%)
demo/build/assets/js/8f441c78.********.js 9.55 kB -300 B (-3%)
demo/build/assets/js/93304a97.********.js 4.17 kB -302 B (-7%)
demo/build/assets/js/935b44fb.********.js 17.9 kB -127 B (-1%)
demo/build/assets/js/97810f3c.********.js 16.6 kB -127 B (-1%)
demo/build/assets/js/9c58e5d3.********.js 16.6 kB -126 B (-1%)
demo/build/assets/js/9e2a7edc.********.js 22.5 kB -127 B (-1%)
demo/build/assets/js/a6cd895f.********.js 20.5 kB -127 B (-1%)
demo/build/assets/js/a6f84189.********.js 11.7 kB -127 B (-1%)
demo/build/assets/js/a728d93a.********.js 9.72 kB -127 B (-1%)
demo/build/assets/js/ab09fd5c.********.js 20.6 kB -127 B (-1%)
demo/build/assets/js/b8b62e90.********.js 19.5 kB -127 B (-1%)
demo/build/assets/js/bceea4ca.********.js 9.96 kB -127 B (-1%)
demo/build/assets/js/bead4b8e.********.js 3.05 kB -165 B (-5%)
demo/build/assets/js/bf9a5101.********.js 17.6 kB -127 B (-1%)
demo/build/assets/js/c2838c41.********.js 17.1 kB -127 B (-1%)
demo/build/assets/js/c2b8341d.********.js 17.3 kB -128 B (-1%)
demo/build/assets/js/c5c41c27.********.js 17.3 kB -127 B (-1%)
demo/build/assets/js/c7ded1cb.********.js 2.95 kB -165 B (-5%)
demo/build/assets/js/common.********.js 137 kB +12.5 kB (+10%) ⚠️
demo/build/assets/js/d63c7029.********.js 2.9 kB -165 B (-5%)
demo/build/assets/js/d69e68dd.********.js 10.3 kB -127 B (-1%)
demo/build/assets/js/d90c1c35.********.js 11 kB -127 B (-1%)
demo/build/assets/js/dbf42779.********.js 18 kB -127 B (-1%)
demo/build/assets/js/dd696920.********.js 16.5 kB -127 B (-1%)
demo/build/assets/js/dff1c289.********.js 3.88 kB -110 B (-3%)
demo/build/assets/js/e165a18a.********.js 11.2 kB -127 B (-1%)
demo/build/assets/js/e44a2883.********.js 4.53 kB -803 B (-15%) 👏
demo/build/assets/js/e53a20a4.********.js 11.8 kB -127 B (-1%)
demo/build/assets/js/e5e5340c.********.js 2.43 kB -127 B (-5%)
demo/build/assets/js/e65a1271.********.js 15.4 kB -128 B (-1%)
demo/build/assets/js/e6f78ab2.********.js 8.71 kB -126 B (-1%)
demo/build/assets/js/eff95040.********.js 20 kB -127 B (-1%)
demo/build/assets/js/f30e634b.********.js 16.7 kB -127 B (-1%)
demo/build/assets/js/f55d3e7a.********.js 2.7 kB -126 B (-4%)
demo/build/assets/js/f8409a7e.********.js 29.4 kB -3.17 kB (-10%) 👏
demo/build/assets/js/fcb807fc.********.js 10.5 kB -127 B (-1%)
demo/build/assets/js/fdd24af5.********.js 9.84 kB -126 B (-1%)
demo/build/assets/js/ffc99614.********.js 16.7 kB -127 B (-1%)
demo/build/assets/js/main.********.js 400 kB -8.98 kB (-2%)
demo/build/assets/js/runtime~main.********.js 8.68 kB -333 B (-4%)
demo/build/index.html 80 kB -88 B (0%)
demo/build/assets/js/3893.********.js 1.07 kB +1.07 kB (new file) 🆕
demo/build/assets/js/6429.********.js 1.29 MB +1.29 MB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
demo/.docusaurus/globalData.json 20.2 kB 0 B
demo/build/assets/js/06b64fc1.********.js 575 B -8 B (-1%)
demo/build/assets/js/16577668.********.js 387 B -8 B (-2%)
demo/build/assets/js/86c346b0.********.js 538 B -8 B (-1%)
demo/build/assets/js/881db345.********.js 394 B -8 B (-2%)
demo/build/assets/js/935f2afb.********.js 35.2 kB -8 B (0%)
demo/build/assets/js/a5491aaa.********.js 392 B -8 B (-2%)
demo/build/assets/js/bf271e74.********.js 393 B -8 B (-2%)
demo/build/assets/js/e2ce9793.********.js 426 B -8 B (-2%)
demo/build/assets/js/e8b309fb.********.js 577 B -8 B (-1%)
demo/build/assets/js/ecc39b49.********.js 172 B -8 B (-4%)

compressed-size-action

@blindaa121 blindaa121 self-assigned this Jul 13, 2022
Copy link
Member

@sserrata sserrata left a comment

Choose a reason for hiding this comment

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

Built and tested locally - works great. Great job with the refactor! Feel free to pass any feedback on the upgrade experience to Sebastien and team if you think it could help.

@blindaa121 blindaa121 merged commit ca833d8 into main Jul 13, 2022
@blindaa121 blindaa121 deleted the beta.22-support branch July 14, 2022 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants