DOP-5078: Fix duplicate "docs" prefix in BreadcrumbList #1285
Conversation
✅ Deploy Preview for mongodb-snooty ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…repeated-docs-breadcrumbs
There was a problem hiding this comment.
can we also add a test with breadcrumbs representative of the db. these contain paths that are relative ie.
{
"baseUrl": "https://mongodb.com/docs/",
"slug": "atlas/cli/stable/",
"title": "Atlas CLI",
"projectName": "atlas-cli",
"showInProductsList": true,
"breadcrumbs": [
{
"title": "MongoDB Atlas",
"path": "/atlas"
}
]
}
There was a problem hiding this comment.
There's an existing test that includes intermediate breadcrumbs with full URLs as well as breadcrumbs with relative paths. Is that what you're looking for?
There was a problem hiding this comment.
ah i think this was not tested as this is used in DocumentBody and not caught in a snapshot (as far as Structured Data)
There was a problem hiding this comment.
Ahhh, I can add a separate test for the structured data as part of this PR on Monday
| @@ -12,6 +12,7 @@ export const useSiteMetadata = () => { | |||
| parserUser | |||
| patchId | |||
| pathPrefix | |||
| project | |||
There was a problem hiding this comment.
Trying to figure out why this was added in this PR
There was a problem hiding this comment.
When checking for usage of siteUrl, I noticed that the build metadata object we use for this hook had project, but the hook was not returning project. I added it here for completeness so it can be used properly.
It's completely out of scope for this PR, but added it as a bonus since it was a small change. Happy to create a separate PR for it if you'd prefer!
There was a problem hiding this comment.
Keep it in! Thank you for the explanation!
| @@ -22,10 +22,6 @@ const FootnoteReference = ({ nodeData: { id, refname } }) => { | |||
| const { footnotes } = useContext(FootnoteContext); | |||
| const { darkMode } = useDarkMode(); | |||
|
|
|||
| // the nodeData originates from docutils, and may be incorrect for | |||
There was a problem hiding this comment.
guessing this change is not from this PR?
There was a problem hiding this comment.
It's one of the bonus changes mentioned above. Figured I'd just lump it in this PR since it's small and I was planning on making a commit for it anyways, but happy to make it separate if needed!
…repeated-docs-breadcrumbs
@seungpark I added tests in the latest commits. Please feel free to take a look |
…repeated-docs-breadcrumbs
Stories/Links:
DOP-5078
Current Behavior:
Staging Links:
Notes:
baseUrl()included/docs/after the site URL. This meant that whenwithPrefixwas applied while constructing breadcrumbs, there'd be duplicate prefixes in the final full URL.Bonus
projectto the site metadata gql hook for completeness.README updates