zowe/docs-site

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

Open

#3,527 opened on Mar 12, 2024

View on GitHub
 (9 comments) (2 reactions) (1 assignee)JavaScript (145 forks)github user discovery
Size: Larea: docshelp wantedtype: enhancement

Repository metrics

Stars
 (75 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Investigate how to add canonical links or noindex tags to older versions of Zowe Docs articles. Refer to Google's guide on consolidating duplicate URLs.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHTML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80