Sitelet https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/47
Skip to content

[WIP] Refactor docusaurus-openapi plugin - #47

Closed
sserrata wants to merge 36 commits into
panw-mainfrom
refactor-plugin
Closed

sserrata wants to merge 36 commits into
panw-mainfrom
refactor-plugin

Conversation

@sserrata

@sserrata sserrata commented Apr 12, 2022 •

Copy link
Copy Markdown
Member

Description

Major refactor of docusaurus-openapi:

  • Eliminates need for sidebars and docs modules.
  • docusaurus-plugin-openapi now writes MDX files to plugin-content-docs path.
  • ApiItem now supports all plugin-content-docs features, including breadcrumbs, pagination, TOC, etc.
  • Potential to support fully-automated sidebars, SidebarGenerator or custom sidebar slices

Remaining items to implement:

Motivation and Context

Although nearing “feature complete”, our current OpenAPI docs solution is highly susceptible and vulnerable to breaking changes introduced by new Docusaurus releases. Such changes impede our ability to upgrade Docusaurus in order to take advantage of bug fixes and new features. Overcoming these breaking changes requires additional development work on our part in order to refactor our plugin for compatibility with the new Docusaurus release.

How Has This Been Tested?

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • 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

github-actions Bot commented Apr 12, 2022 •

Copy link
Copy Markdown

Size Change: -437 kB (-17%) 👏

Total Size: 2.08 MB

Filename Size Change
demo/.docusaurus/globalData.json 8.72 kB +6.5 kB (+293%) 🆘
demo/build/assets/css/styles.********.css 84.1 kB -3.59 kB (-4%)
demo/build/assets/js/010b0d5d.********.js 0 B -1.38 kB (removed) 🏆
demo/build/assets/js/021c2319.********.js 0 B -12.9 kB (removed) 🏆
demo/build/assets/js/09ead32c.********.js 0 B -10.2 kB (removed) 🏆
demo/build/assets/js/0c270917.********.js 0 B -7.59 kB (removed) 🏆
demo/build/assets/js/0cb18c9d.********.js 0 B -11.7 kB (removed) 🏆
demo/build/assets/js/1181d397.********.js 0 B -6.41 kB (removed) 🏆
demo/build/assets/js/16abef02.********.js 0 B -6.6 kB (removed) 🏆
demo/build/assets/js/17896441.********.js 1.55 kB -11.1 kB (-88%) 🏆
demo/build/assets/js/1bbda95d.********.js 0 B -19.8 kB (removed) 🏆
demo/build/assets/js/1be78505.********.js 10.8 kB -350 B (-3%)
demo/build/assets/js/22648341.********.js 0 B -1.28 kB (removed) 🏆
demo/build/assets/js/2391.********.js 0 B -10.1 kB (removed) 🏆
demo/build/assets/js/25013e4a.********.js 0 B -4.76 kB (removed) 🏆
demo/build/assets/js/26fa5e84.********.js 0 B -1.3 kB (removed) 🏆
demo/build/assets/js/2c32bac3.********.js 0 B -1.73 kB (removed) 🏆
demo/build/assets/js/2d2458d1.********.js 0 B -12.9 kB (removed) 🏆
demo/build/assets/js/2ee8962c.********.js 0 B -1.5 kB (removed) 🏆
demo/build/assets/js/31d12231.********.js 0 B -1.61 kB (removed) 🏆
demo/build/assets/js/341550c5.********.js 0 B -5.52 kB (removed) 🏆
demo/build/assets/js/3620.********.js 0 B -1.1 MB (removed) 🏆
demo/build/assets/js/3914806c.********.js 0 B -4.83 kB (removed) 🏆
demo/build/assets/js/428b4c57.********.js 0 B -9.61 kB (removed) 🏆
demo/build/assets/js/42c07454.********.js 0 B -3.83 kB (removed) 🏆
demo/build/assets/js/466dcb64.********.js 0 B -1.45 kB (removed) 🏆
demo/build/assets/js/4c5e977b.********.js 33.2 kB -2.87 kB (-8%) ✅
demo/build/assets/js/4eeb3c5d.********.js 0 B -4.46 kB (removed) 🏆
demo/build/assets/js/51e890c3.********.js 0 B -9.55 kB (removed) 🏆
demo/build/assets/js/52c4b3e2.********.js 0 B -6.6 kB (removed) 🏆
demo/build/assets/js/52d34678.********.js 0 B -1.02 kB (removed) 🏆
demo/build/assets/js/5388d76b.********.js 0 B -13.3 kB (removed) 🏆
demo/build/assets/js/54843f7d.********.js 0 B -5.75 kB (removed) 🏆
demo/build/assets/js/5aa5a9cd.********.js 0 B -2.89 kB (removed) 🏆
demo/build/assets/js/60b38b8e.********.js 0 B -1.42 kB (removed) 🏆
demo/build/assets/js/60e13cef.********.js 0 B -10.2 kB (removed) 🏆
demo/build/assets/js/6119.********.js 0 B -1.02 kB (removed) 🏆
demo/build/assets/js/6533f3d7.********.js 0 B -6.78 kB (removed) 🏆
demo/build/assets/js/69ba2909.********.js 0 B -5.53 kB (removed) 🏆
demo/build/assets/js/6a7cf16d.********.js 0 B -12.3 kB (removed) 🏆
demo/build/assets/js/6ce157fc.********.js 0 B -5.75 kB (removed) 🏆
demo/build/assets/js/6ed40b15.********.js 0 B -1.72 kB (removed) 🏆
demo/build/assets/js/72390392.********.js 0 B -6.4 kB (removed) 🏆
demo/build/assets/js/79147915.********.js 0 B -11.2 kB (removed) 🏆
demo/build/assets/js/7a5457fa.********.js 0 B -7.81 kB (removed) 🏆
demo/build/assets/js/7cc518f2.********.js 0 B -2.81 kB (removed) 🏆
demo/build/assets/js/8826c0db.********.js 0 B -9.87 kB (removed) 🏆
demo/build/assets/js/8e36997c.********.js 0 B -12.3 kB (removed) 🏆
demo/build/assets/js/8e44c742.********.js 0 B -11.2 kB (removed) 🏆
demo/build/assets/js/94214df4.********.js 0 B -12.6 kB (removed) 🏆
demo/build/assets/js/98463c12.********.js 0 B -4.48 kB (removed) 🏆
demo/build/assets/js/9a562316.********.js 0 B -1.06 kB (removed) 🏆
demo/build/assets/js/9f85b634.********.js 0 B -1.46 kB (removed) 🏆
demo/build/assets/js/a172e59e.********.js 0 B -10.6 kB (removed) 🏆
demo/build/assets/js/a30588cf.********.js 0 B -7.86 kB (removed) 🏆
demo/build/assets/js/a356afa7.********.js 0 B -10.6 kB (removed) 🏆
demo/build/assets/js/a5c48ae3.********.js 0 B -6.77 kB (removed) 🏆
demo/build/assets/js/a6966617.********.js 0 B -10.2 kB (removed) 🏆
demo/build/assets/js/ac3cc3f5.********.js 0 B -10.9 kB (removed) 🏆
demo/build/assets/js/af70375d.********.js 0 B -9.56 kB (removed) 🏆
demo/build/assets/js/b5257597.********.js 0 B -4.17 kB (removed) 🏆
demo/build/assets/js/b5efbc84.********.js 0 B -1.42 kB (removed) 🏆
demo/build/assets/js/b68d1b59.********.js 0 B -9.62 kB (removed) 🏆
demo/build/assets/js/b9572ad5.********.js 0 B -1.66 kB (removed) 🏆
demo/build/assets/js/ba5ac426.********.js 0 B -5.94 kB (removed) 🏆
demo/build/assets/js/bac076bc.********.js 0 B -13.3 kB (removed) 🏆
demo/build/assets/js/bde5d56a.********.js 0 B -9.43 kB (removed) 🏆
demo/build/assets/js/be3e95ec.********.js 0 B -5.57 kB (removed) 🏆
demo/build/assets/js/c4403e14.********.js 0 B -8.56 kB (removed) 🏆
demo/build/assets/js/c76c11f6.********.js 0 B -998 B (removed) 🏆
demo/build/assets/js/c87b34e1.********.js 0 B -9.42 kB (removed) 🏆
demo/build/assets/js/common.********.js 125 kB -34 B (0%)
demo/build/assets/js/d01652cd.********.js 0 B -12.6 kB (removed) 🏆
demo/build/assets/js/d38d1999.********.js 0 B -8.54 kB (removed) 🏆
demo/build/assets/js/d6cb8c6d.********.js 0 B -1.65 kB (removed) 🏆
demo/build/assets/js/dd1a1797.********.js 0 B -9.88 kB (removed) 🏆
demo/build/assets/js/dd2855f3.********.js 0 B -5.95 kB (removed) 🏆
demo/build/assets/js/e4da18c0.********.js 0 B -10.2 kB (removed) 🏆
demo/build/assets/js/e91d46ba.********.js 0 B -1.66 kB (removed) 🏆
demo/build/assets/js/ee030bdf.********.js 0 B -1.55 kB (removed) 🏆
demo/build/assets/js/f13f1da7.********.js 0 B -19.9 kB (removed) 🏆
demo/build/assets/js/f6149237.********.js 0 B -5.58 kB (removed) 🏆
demo/build/assets/js/fd1ce97f.********.js 0 B -1.55 kB (removed) 🏆
demo/build/assets/js/fefa319c.********.js 0 B -11.7 kB (removed) 🏆
demo/build/assets/js/main.********.js 390 kB -19.5 kB (-5%) ✅
demo/build/assets/js/runtime~main.********.js 6.35 kB -1.9 kB (-23%) 🎉
demo/build/index.html 72.6 kB +62 B (0%)
demo/build/assets/js/066d920b.********.js 2.74 kB +2.74 kB (new file) 🆕
demo/build/assets/js/0de0d9d3.********.js 2.82 kB +2.82 kB (new file) 🆕
demo/build/assets/js/0f5373df.********.js 2.32 kB +2.32 kB (new file) 🆕
demo/build/assets/js/11cd04f0.********.js 3.86 kB +3.86 kB (new file) 🆕
demo/build/assets/js/18927b64.********.js 5.9 kB +5.9 kB (new file) 🆕
demo/build/assets/js/1f41b3da.********.js 11.2 kB +11.2 kB (new file) 🆕
demo/build/assets/js/2695.********.js 1.02 kB +1.02 kB (new file) 🆕
demo/build/assets/js/2c9e856c.********.js 4.73 kB +4.73 kB (new file) 🆕
demo/build/assets/js/3372.********.js 11.5 kB +11.5 kB (new file) 🆕
demo/build/assets/js/42c7b392.********.js 6.43 kB +6.43 kB (new file) 🆕
demo/build/assets/js/46a8ec8c.********.js 3 kB +3 kB (new file) 🆕
demo/build/assets/js/477c195c.********.js 4.71 kB +4.71 kB (new file) 🆕
demo/build/assets/js/4a47cb6d.********.js 1.34 kB +1.34 kB (new file) 🆕
demo/build/assets/js/4c9d5d90.********.js 5.71 kB +5.71 kB (new file) 🆕
demo/build/assets/js/4e8c00d7.********.js 2.25 kB +2.25 kB (new file) 🆕
demo/build/assets/js/5456.********.js 10 kB +10 kB (new file) 🆕
demo/build/assets/js/5c2e4ff8.********.js 4.37 kB +4.37 kB (new file) 🆕
demo/build/assets/js/6ab70d68.********.js 2.5 kB +2.5 kB (new file) 🆕
demo/build/assets/js/6d9cbd66.********.js 6.64 kB +6.64 kB (new file) 🆕
demo/build/assets/js/71d92ba4.********.js 2.17 kB +2.17 kB (new file) 🆕
demo/build/assets/js/7608cde2.********.js 1.31 kB +1.31 kB (new file) 🆕
demo/build/assets/js/8084356f.********.js 2.93 kB +2.93 kB (new file) 🆕
demo/build/assets/js/846aa161.********.js 4.41 kB +4.41 kB (new file) 🆕
demo/build/assets/js/888b62d9.********.js 1.49 kB +1.49 kB (new file) 🆕
demo/build/assets/js/8dd270d8.********.js 10.9 kB +10.9 kB (new file) 🆕
demo/build/assets/js/9719473f.********.js 1.24 kB +1.24 kB (new file) 🆕
demo/build/assets/js/9852.********.js 1.08 MB +1.08 MB (new file) 🆕
demo/build/assets/js/9e4087bc.********.js 1.61 kB +1.61 kB (new file) 🆕
demo/build/assets/js/a9d8a64b.********.js 1.71 kB +1.71 kB (new file) 🆕
demo/build/assets/js/b0e6d8b9.********.js 1.65 kB +1.65 kB (new file) 🆕
demo/build/assets/js/b2f554cd.********.js 121 B +121 B (new file) 🆕
demo/build/assets/js/bb0d0959.********.js 1.63 kB +1.63 kB (new file) 🆕
demo/build/assets/js/bd766368.********.js 2.14 kB +2.14 kB (new file) 🆕
demo/build/assets/js/c3d13055.********.js 2.03 kB +2.03 kB (new file) 🆕
demo/build/assets/js/ce11f325.********.js 2.92 kB +2.92 kB (new file) 🆕
demo/build/assets/js/d03381af.********.js 4.42 kB +4.42 kB (new file) 🆕
demo/build/assets/js/da717792.********.js 3.67 kB +3.67 kB (new file) 🆕
demo/build/assets/js/dc10a35a.********.js 3.94 kB +3.94 kB (new file) 🆕
demo/build/assets/js/dde745ce.********.js 4.69 kB +4.69 kB (new file) 🆕
demo/build/assets/js/e1362e6d.********.js 1.37 kB +1.37 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
demo/build/assets/js/0e384e19.********.js 2.39 kB -17 B (-1%)
demo/build/assets/js/18c41134.********.js 14.7 kB -20 B (0%)
demo/build/assets/js/1e4232ab.********.js 3.45 kB -17 B (0%)
demo/build/assets/js/1f391b9e.********.js 2.6 kB -20 B (-1%)
demo/build/assets/js/393be207.********.js 921 B -5 B (-1%)
demo/build/assets/js/533a09ca.********.js 2.8 kB -17 B (-1%)
demo/build/assets/js/5c868d36.********.js 3.52 kB -17 B (0%)
demo/build/assets/js/822bd8ab.********.js 3.19 kB -17 B (-1%)
demo/build/assets/js/935f2afb.********.js 3.54 kB 0 B
demo/build/assets/js/c4f5d8e4.********.js 72.3 kB -14 B (0%)
demo/build/assets/js/dff1c289.********.js 4.2 kB -19 B (0%)
demo/build/assets/js/e44a2883.********.js 5.45 kB -19 B (0%)
demo/build/assets/js/f55d3e7a.********.js 3.01 kB -17 B (-1%)

compressed-size-action

@github-actions

github-actions Bot commented Apr 12, 2022 •

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit 594d766):

https://docusaurus-openapi-36b86--pr47-9r6n85sx.web.app

(expires Fri, 13 May 2022 20:55:00 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata

Copy link
Copy Markdown
Member Author

Using this PR for tracking purposes only as changes already merged via #48.

@sserrata

Copy link
Copy Markdown
Member Author

🎉 Achievement unlocked. 🎉

@sserrata sserrata closed this Apr 25, 2022
@sserrata
sserrata deleted the refactor-plugin branch April 29, 2022 15:25
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.

3 participants