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

feat(theme): show unlisted/draft banners in dev mode #10376

Merged
merged 14 commits into from
Aug 8, 2024
Merged

Conversation

OzakIOne
Copy link
Contributor

@OzakIOne OzakIOne commented Aug 6, 2024

Motivation

Fix #8285

Test Plan

ci & unit test & argos

Test links

Deploy preview: https://deploy-preview-10376--docusaurus-2.netlify.app/

image image image image image image

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Aug 6, 2024
Copy link

netlify bot commented Aug 6, 2024

[V2]

Name Link
🔨 Latest commit 60cea96
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/66b50f1be8d2180008d77a8e
😎 Deploy Preview https://deploy-preview-10376--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Aug 6, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🟠 70 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🟠 59 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 75 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 70 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🔴 48 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 69 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 75 🟢 100 🟢 100 🟠 86 Report

Copy link

github-actions bot commented Aug 6, 2024

Size Change: -638 B (-0.01%)

Total Size: 11.5 MB

Filename Size Change
website/build/assets/js/main.********.js 676 kB +33 B (0%)
website/build/docs/styling-layout.html 141 kB +370 B (+0.26%)
ℹ️ View Unchanged
Filename Size Change
website/.docusaurus/codeTranslations.json 2 B 0 B
website/.docusaurus/docusaurus.config.mjs 27.7 kB 0 B
website/.docusaurus/globalData.json 30 kB 0 B
website/.docusaurus/i18n.json 930 B 0 B
website/.docusaurus/registry.js 153 kB 0 B
website/.docusaurus/routes.js 73.6 kB 0 B
website/.docusaurus/routesChunkNames.json 80.4 kB 0 B
website/.docusaurus/site-metadata.json 2.17 kB 0 B
website/build/assets/css/styles.********.css 113 kB 0 B
website/build/blog.html 61.9 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus.html 74.7 kB -14 B (-0.02%)
website/build/blog/2018/04/30/How-I-Converted-Profilo-To-Docusaurus.html 47.2 kB -1 B (0%)
website/build/blog/2018/09/11/Towards-Docusaurus-2.html 51.6 kB -1 B (0%)
website/build/blog/2018/12/14/Happy-First-Birthday-Slash.html 33.1 kB -14 B (-0.04%)
website/build/blog/2019/12/30/docusaurus-2019-recap.html 39.5 kB -14 B (-0.04%)
website/build/blog/2020/01/07/tribute-to-endi.html 33.9 kB -14 B (-0.04%)
website/build/blog/2021/01/19/docusaurus-2020-recap.html 48.8 kB -14 B (-0.03%)
website/build/blog/2021/03/09/releasing-docusaurus-i18n.html 45 kB -14 B (-0.03%)
website/build/blog/2021/05/12/announcing-docusaurus-two-beta.html 51.8 kB -14 B (-0.03%)
website/build/blog/2021/11/21/algolia-docsearch-migration.html 52.8 kB -1 B (0%)
website/build/blog/2022/01/24/docusaurus-2021-recap.html 44.4 kB -14 B (-0.03%)
website/build/blog/2022/08/01/announcing-docusaurus-2.0.html 142 kB -14 B (-0.01%)
website/build/blog/2022/09/01/docusaurus-2.1.html 50.8 kB -14 B (-0.03%)
website/build/blog/archive.html 24.6 kB 0 B
website/build/blog/authors.html 46.4 kB 0 B
website/build/blog/authors/j-marcey.html 74.9 kB 0 B
website/build/blog/authors/josh-cena.html 45.7 kB 0 B
website/build/blog/authors/lex-111.html 57.3 kB 0 B
website/build/blog/authors/slorber.html 62.1 kB 0 B
website/build/blog/authors/slorber/authors/2.html 64.6 kB 0 B
website/build/blog/authors/slorber/authors/3.html 86.1 kB 0 B
website/build/blog/authors/slorber/authors/4.html 37 kB 0 B
website/build/blog/authors/yangshun.html 64.9 kB 0 B
website/build/blog/authors/zpao.html 46.2 kB 0 B
website/build/blog/page/2.html 65.1 kB 0 B
website/build/blog/page/3.html 82.8 kB 0 B
website/build/blog/page/4.html 58.3 kB 0 B
website/build/blog/page/5.html 39.1 kB 0 B
website/build/blog/preparing-your-site-for-docusaurus-v3.html 138 kB -14 B (-0.01%)
website/build/blog/releases/2.2.html 49.5 kB -13 B (-0.03%)
website/build/blog/releases/2.3.html 60.7 kB -13 B (-0.02%)
website/build/blog/releases/2.4.html 65.2 kB -13 B (-0.02%)
website/build/blog/releases/3.0.html 111 kB -1 B (0%)
website/build/blog/releases/3.1.html 51.9 kB -12 B (-0.02%)
website/build/blog/releases/3.2.html 48.7 kB -13 B (-0.03%)
website/build/blog/releases/3.3.html 55.4 kB -13 B (-0.02%)
website/build/blog/releases/3.4.html 55.5 kB -6 B (-0.01%)
website/build/blog/tags.html 28.4 kB 0 B
website/build/blog/upgrading-frontend-dependencies-with-confidence-using-visual-regression-testing.html 128 kB -13 B (-0.01%)
website/build/docs.html 49.4 kB -4 B (-0.01%)
website/build/docs/advanced.html 31.1 kB -13 B (-0.04%)
website/build/docs/advanced/architecture.html 30.7 kB -9 B (-0.03%)
website/build/docs/advanced/client.html 76 kB -13 B (-0.02%)
website/build/docs/advanced/plugins.html 58.6 kB -13 B (-0.02%)
website/build/docs/advanced/routing.html 73.9 kB -5 B (-0.01%)
website/build/docs/advanced/ssg.html 81.5 kB -13 B (-0.02%)
website/build/docs/api/docusaurus-config.html 200 kB -13 B (-0.01%)
website/build/docs/api/misc/@docusaurus/eslint-plugin.html 48.3 kB -9 B (-0.02%)
website/build/docs/api/misc/@docusaurus/eslint-plugin/no-html-links.html 38.1 kB -13 B (-0.03%)
website/build/docs/api/misc/@docusaurus/eslint-plugin/no-untranslated-text.html 37 kB -13 B (-0.04%)
website/build/docs/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading.html 38.3 kB -9 B (-0.02%)
website/build/docs/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages.html 41.9 kB -13 B (-0.03%)
website/build/docs/api/misc/@docusaurus/logger.html 39.8 kB -13 B (-0.03%)
website/build/docs/api/misc/create-docusaurus.html 34.9 kB -12 B (-0.03%)
website/build/docs/api/plugin-methods.html 67.4 kB -9 B (-0.01%)
website/build/docs/api/plugin-methods/extend-infrastructure.html 63 kB -9 B (-0.01%)
website/build/docs/api/plugin-methods/i18n-lifecycles.html 60.6 kB -9 B (-0.01%)
website/build/docs/api/plugin-methods/lifecycle-apis.html 170 kB -13 B (-0.01%)
website/build/docs/api/plugin-methods/static-methods.html 46.5 kB -9 B (-0.02%)
website/build/docs/api/plugins.html 31.6 kB -13 B (-0.04%)
website/build/docs/api/plugins/@docusaurus/plugin-client-redirects.html 62.6 kB 0 B
website/build/docs/api/plugins/@docusaurus/plugin-content-blog.html 198 kB -7 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-content-docs.html 202 kB -4 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-content-pages.html 78 kB -13 B (-0.02%)
website/build/docs/api/plugins/@docusaurus/plugin-debug.html 50.5 kB -13 B (-0.03%)
website/build/docs/api/plugins/@docusaurus/plugin-google-analytics.html 51.5 kB -13 B (-0.03%)
website/build/docs/api/plugins/@docusaurus/plugin-google-gtag.html 51 kB -17 B (-0.03%)
website/build/docs/api/plugins/@docusaurus/plugin-google-tag-manager.html 49.8 kB -13 B (-0.03%)
website/build/docs/api/plugins/@docusaurus/plugin-ideal-image.html 51.1 kB -9 B (-0.02%)
website/build/docs/api/plugins/@docusaurus/plugin-pwa.html 122 kB -9 B (-0.01%)
website/build/docs/api/plugins/@docusaurus/plugin-sitemap.html 68.5 kB -7 B (-0.01%)
website/build/docs/api/plugins/@docusaurus/plugin-vercel-analytics.html 42.2 kB -1 B (0%)
website/build/docs/api/themes.html 30.4 kB -13 B (-0.04%)
website/build/docs/api/themes/@docusaurus/theme-classic.html 46.4 kB -9 B (-0.02%)
website/build/docs/api/themes/@docusaurus/theme-live-codeblock.html 38.6 kB -9 B (-0.02%)
website/build/docs/api/themes/@docusaurus/theme-mermaid.html 37.5 kB -9 B (-0.02%)
website/build/docs/api/themes/@docusaurus/theme-search-algolia.html 34.7 kB -13 B (-0.04%)
website/build/docs/api/themes/configuration.html 256 kB -6 B (0%)
website/build/docs/blog.html 219 kB -7 B (0%)
website/build/docs/browser-support.html 51 kB -13 B (-0.03%)
website/build/docs/category/getting-started.html 28.3 kB 0 B
website/build/docs/category/guides.html 36.4 kB 0 B
website/build/docs/cli.html 63.8 kB -12 B (-0.02%)
website/build/docs/configuration.html 98.5 kB -9 B (-0.01%)
website/build/docs/create-doc.html 65.3 kB -1 B (0%)
website/build/docs/creating-pages.html 59.1 kB -12 B (-0.02%)
website/build/docs/deployment.html 211 kB -4 B (0%)
website/build/docs/docs-introduction.html 53.6 kB -13 B (-0.02%)
website/build/docs/docs-multi-instance.html 78.7 kB -9 B (-0.01%)
website/build/docs/docusaurus-core.html 245 kB -13 B (-0.01%)
website/build/docs/guides/whats-next.html 32.8 kB -13 B (-0.04%)
website/build/docs/i18n/crowdin.html 151 kB -1 B (0%)
website/build/docs/i18n/git.html 82.6 kB -9 B (-0.01%)
website/build/docs/i18n/introduction.html 50.7 kB -13 B (-0.03%)
website/build/docs/i18n/tutorial.html 171 kB 0 B
website/build/docs/installation.html 73 kB -1 B (0%)
website/build/docs/introduction/index.html 280 B 0 B
website/build/docs/markdown-features.html 83.2 kB -12 B (-0.01%)
website/build/docs/markdown-features/admonitions.html 118 kB -9 B (-0.01%)
website/build/docs/markdown-features/assets.html 93.5 kB -11 B (-0.01%)
website/build/docs/markdown-features/code-blocks.html 245 kB -9 B (0%)
website/build/docs/markdown-features/diagrams.html 56 kB +1 B (0%)
website/build/docs/markdown-features/head-metadata.html 52.8 kB -13 B (-0.02%)
website/build/docs/markdown-features/links.html 43.1 kB -13 B (-0.03%)
website/build/docs/markdown-features/math-equations.html 95.4 kB -2 B (0%)
website/build/docs/markdown-features/plugins.html 101 kB -5 B (0%)
website/build/docs/markdown-features/react.html 144 kB -13 B (-0.01%)
website/build/docs/markdown-features/tabs.html 148 kB -13 B (-0.01%)
website/build/docs/markdown-features/toc.html 88.8 kB -9 B (-0.01%)
website/build/docs/migration.html 43 kB -14 B (-0.03%)
website/build/docs/migration/v2.html 41.2 kB -13 B (-0.03%)
website/build/docs/migration/v2/automated.html 42.6 kB -13 B (-0.03%)
website/build/docs/migration/v2/manual.html 207 kB -13 B (-0.01%)
website/build/docs/migration/v2/translated-sites.html 52.8 kB -13 B (-0.02%)
website/build/docs/migration/v2/versioned-sites.html 67.2 kB -13 B (-0.02%)
website/build/docs/migration/v3.html 218 kB -12 B (-0.01%)
website/build/docs/playground.html 32.5 kB -13 B (-0.04%)
website/build/docs/resources/index.html 325 B 0 B
website/build/docs/search.html 121 kB -1 B (0%)
website/build/docs/seo.html 93 kB 0 B
website/build/docs/sidebar.html 136 kB -9 B (-0.01%)
website/build/docs/sidebar/autogenerated.html 156 kB 0 B
website/build/docs/sidebar/items.html 188 kB -13 B (-0.01%)
website/build/docs/sidebar/multiple-sidebars.html 67.1 kB -9 B (-0.01%)
website/build/docs/static-assets.html 56.2 kB -9 B (-0.02%)
website/build/docs/support/index.html 319 B 0 B
website/build/docs/swizzling.html 120 kB +1 B (0%)
website/build/docs/team/index.html 310 B 0 B
website/build/docs/typescript-support.html 65.4 kB -13 B (-0.02%)
website/build/docs/using-plugins.html 115 kB 0 B
website/build/docs/versioning.html 87.1 kB 0 B
website/build/index.html 37.8 kB 0 B

compressed-size-action

@slorber slorber changed the title feat: show unlisted/draft banners in dev mode feat(theme): show unlisted/draft banners in dev mode Aug 8, 2024
@slorber slorber added the pr: new feature This PR adds a new API or behavior. label Aug 8, 2024
@slorber
Copy link
Collaborator

slorber commented Aug 8, 2024

LGTM thanks

Did some refactoring to cleanup but this works well

@slorber slorber added the Argos Add this label to run UI visual regression tests. See argos.yml GH action. label Aug 8, 2024
Copy link

argos-ci bot commented Aug 8, 2024

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Aug 8, 2024, 6:38 PM

@slorber slorber merged commit 95ab9f8 into main Aug 8, 2024
37 checks passed
@slorber slorber deleted the ozaki/devbanner branch August 8, 2024 18:48
@B4nan
Copy link
Contributor

B4nan commented Aug 11, 2024

FYI this broke our builds since we were using overrides for DocItem/Layout that had import to @theme/Unlisted. Not sure if you consider that breaking or not, just wanted to let you know, we'll change the import on our end.

@slorber
Copy link
Collaborator

slorber commented Aug 11, 2024

@B4nan it's not marked as a safe component to swizzle so we keep the right to do refactors like this one in minor versions.

I'll see how we could make it easier for those like you who swizzle unsafe components. Maybe listing changes in our release notes would be helpful?

ptgott added a commit to gravitational/docs-website that referenced this pull request Oct 24, 2024
The module declaration was changed in
facebook/docusaurus#10376
ptgott added a commit to gravitational/docs-website that referenced this pull request Oct 24, 2024
- Upgrade Docusaurus packages to `^3.5.0`
- Fix `@theme/Unlisted` import, since the module declaration was changed
  in facebook/docusaurus#10376.
- Update imports to reflect the movement of some exports from
  `@docusaurus/theme-common/internal` into
  `@docusaurus/plugin-content-docs/client`. See
  facebook/docusaurus#10316.
ptgott added a commit to gravitational/docs-website that referenced this pull request Oct 24, 2024
- Upgrade Docusaurus packages to `^3.5.0`
- Fix `@theme/Unlisted` import, since the module declaration was changed
  in facebook/docusaurus#10376.
- Update imports to reflect the movement of some exports from
  `@docusaurus/theme-common/internal` into
  `@docusaurus/plugin-content-docs/client`. See
  facebook/docusaurus#10316.

Also updates config.json to correct branch names.
mmcallister pushed a commit to gravitational/docs-website that referenced this pull request Oct 24, 2024
- Upgrade Docusaurus packages to `^3.5.0`
- Fix `@theme/Unlisted` import, since the module declaration was changed
  in facebook/docusaurus#10376.
- Update imports to reflect the movement of some exports from
  `@docusaurus/theme-common/internal` into
  `@docusaurus/plugin-content-docs/client`. See
  facebook/docusaurus#10316.

Also updates config.json to correct branch names.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Argos Add this label to run UI visual regression tests. See argos.yml GH action. CLA Signed Signed Facebook CLA pr: new feature This PR adds a new API or behavior.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposal: add unlisted/draft banners in dev mode
4 participants