docs-site icon indicating copy to clipboard operation
docs-site copied to clipboard

Adding front matter to help promote the latest version of Zowe Docs articles in Google searches

Open anaxceron opened this issue 1 year ago • 1 comments

Is your request for enhancement related to a problem? Please describe.

Currently, Google is indexing older versions of Zowe Docs articles, which means that the latest version of articles are not included in search results. This can lead to Zower users getting outdated information if they're not aware that they've landed on an older version of Zowe Docs.

Describe the solution you'd like

Apply annotations to help alert Google that older versions of Zowe Docs articles should be ignored when a latest version is available.

Related doc pages

https://developers.google.com/search/docs/crawling-indexing/consolidate-duplicate-urls

Additional context

image

anaxceron avatar Mar 12 '24 19:03 anaxceron

Since removing old version links from our sitemap in https://github.com/zowe/docs-site/pull/3329 didn't help, we'll likely need to add metadata to each page as mentioned above. Rather than manually adding a "canonical" link as front matter for each page which would be tedious, we should be able to model after https://github.com/camunda/camunda-docs/pull/2577 which solved the problem by swizzling the Docusaurus Metadata component so that a "canonical" link is automatically generated for each old version page.

t1m0thyj avatar Jun 06 '24 11:06 t1m0thyj