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

fix(v2): navbar doc item fallback: search doc in lastVersion #4985

Merged
merged 1 commit into from
Jun 16, 2021

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Jun 16, 2021

Motivation

When using a navbar doc item like:

        {
          type: 'doc',
          docId: 'myDocId',
        },

It was previously required that myDocId exist in ALL docs versions of the sites, so that we can always link to the currently active version.

This PR makes it more fail-safe, and falls-back to looking for the doc in lastVersion, so that older versions are not forced to contain a doc with id: myDocId (ie we can more easily introduce a navbar link to an existing versioned site)

Fix #4972

Have you read the Contributing Guidelines on pull requests?

yes

Test Plan

local :'( we don't have much test infra on the theme code and no dogfooding possible

…he target doc, as long as the lastVersion contains it
@slorber slorber added the pr: bug fix This PR fixes a bug in a past release. label Jun 16, 2021
@slorber slorber requested a review from lex111 as a code owner June 16, 2021 10:56
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 16, 2021
@netlify
Copy link

netlify bot commented Jun 16, 2021

✔️ [V2]

🔨 Explore the source changes: 653cc5d

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/60c9d8c614c06a0008636036

😎 Browse the preview: https://deploy-preview-4985--docusaurus-2.netlify.app

@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 56
🟢 Accessibility 97
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4985--docusaurus-2.netlify.app/

@github-actions
Copy link

Size Change: 0 B

Total Size: 624 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 87.6 kB 0 B
website/build/assets/js/main.********.js 445 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 63.3 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B
website/build/index.html 28.1 kB 0 B

compressed-size-action

@slorber slorber merged commit aa17627 into master Jun 16, 2021
@slorber slorber deleted the slorber/navbar-doc-item-more-failsafe branch August 17, 2021 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Navbar doc link versions support
3 participants