DOP-4916: Implement SoftwareSourceCode structured data #1258
Conversation
| background-color: ${palette.black}; | ||
| color: ${palette.gray.light3}; | ||
| .dark-theme & { | ||
| border-color: ${palette.gray.dark2}; |
There was a problem hiding this comment.
No CSS changes actually applied here
src/components/Video/index.js
Outdated
| <script id={`video-object-sd-${url}`} type="application/ld+json"> | ||
| {JSON.stringify(structuredData)} | ||
| </script> | ||
| {videoObjectSd.isValid() && ( |
There was a problem hiding this comment.
Matt had suggested doing this in the memo and returning ! 👍
There was a problem hiding this comment.
Makes sense. Done. Thanks for flagging (and to Matt for suggesting)
src/utils/get-language.js
Outdated
| return undefined; | ||
| } | ||
|
|
||
| const fullLangName = LANGUAGE_NAMES[lang]; |
There was a problem hiding this comment.
[minor] - can we check for hasOwnProperty here for cases like 'constructor' 😬
There was a problem hiding this comment.
I hope nobody is using constructor as a programming language. Done
src/components/Code/Code.js
Outdated
| @@ -85,77 +86,89 @@ const Code = ({ | |||
| reportAnalytics('CodeblockCopied', { code }); | |||
| }, [code]); | |||
|
|
|||
| const softwareSourceCodeSd = useMemo(() => new SoftwareSourceCodeSd({ code, lang }), [code, lang]); | |||
There was a problem hiding this comment.
same minor point here for checking validity and returning !
src/components/Code/Output.js
Outdated
| <script | ||
| type="application/ld+json" | ||
| dangerouslySetInnerHTML={{ | ||
| __html: softwareSourceCodeSd.toString(), |
There was a problem hiding this comment.
Do we need toString() here? Isn't it already stringified above?
There was a problem hiding this comment.
Yes! Thank you for catching! Removed!
src/components/Video/index.js
Outdated
| <script | ||
| type="application/ld+json" | ||
| dangerouslySetInnerHTML={{ | ||
| __html: videoObjectSd.toString(), |
@seungpark You are correct! The comment above was just to flag that nothing was actually changed since the diff seemed to suggest variables and stuff were being changed |
Stories/Links:
DOP-4916
Current Behavior:
Staging Links:
Google doesn't care about
SoftwareSourceCode, so they're not present in Rich Results.Notes:
SoftwareSourceCodestructured data for code blocks, withprogrammingLanguageas optional. A new mapping of different full language names has been added here to help map languages from code blocks to more SEO-friendly names. Since we don't currently have a formal list of supported languages, I'm basing this off of what I've seen and what LeafyGreen supports.Ideally, these would be separate PRs, but I've added a few bonus changes based on related work. Let me know if you'd like me to create separate PRs!
VideoObjectbecause the Docs Landing SD had it, but it seems like it's not actually used for anything. Less code to worry about!VideoObjectto adopt newStructuredDataclass introduced in DOP-4915: Add Tech Article Structured Data to page #1249.BreadcrumbContainerprop type. This reduces noisy console errors for local dev.README updates