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

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

Open
anaxceron opened this issue Mar 12, 2024 · 1 comment
Assignees
Labels
area: docs Documentation issue or issues that have documentation impact help wanted Extra attention is needed type: enhancement New feature or request

Comments

@anaxceron
Copy link
Collaborator

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 anaxceron added type: enhancement New feature or request help wanted Extra attention is needed area: docs Documentation issue or issues that have documentation impact labels Mar 12, 2024
@anaxceron anaxceron self-assigned this Mar 12, 2024
@t1m0thyj
Copy link
Member

t1m0thyj commented Jun 6, 2024

Since removing old version links from our sitemap in #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 camunda/camunda-docs#2577 which solved the problem by swizzling the Docusaurus Metadata component so that a "canonical" link is automatically generated for each old version page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Documentation issue or issues that have documentation impact help wanted Extra attention is needed type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants