[DOCS] Link to `current release document` should point to current page in the current docs, when possible.
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the versioned Elasticsearch Guide page at the reproduction URL and trace how its notification banner builds the current release document link. Verify the behavior for a matching current page and for a page that no longer exists, with completion defined as preserving the corresponding page when possible and providing an appropriate fallback.
Written by the indexing model from the issue text.
Description
I consider some of this unexpected behavior a bug, but I've added some improvement suggestions that could be a feature.
Description of the problem including expected versus actual behavior:
Often I find docs via a Google search. The top result doesn't often land on the current version of Elastic. The banner that appears on top of the doc page suggests to go to the current release document. Unfortunately this often redirects the main index of the docs. Then I have to find the corresponding page via the index or go back to the original landing page and flip the version on the side drop-down or edit the url accordingly. I'd expect this link to send me to the same doc in the current version and if no longer valid go to the index of the page. Ideally, if it is no longer valid, it could include a deprecated message in the banner since going to the current docs would be misleading without at least a warning.
Steps to reproduce:
- Go to a document page that isn't the current version, such as https://www.elastic.co/guide/en/elasticsearch/reference/6.x/geoip-processor.html
- Observe the notification banner suggesting to go to the
current release document. - Click
current release documentlink. - Notice you get sent to https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
Workaround scenario:
- Go to a document page that isn't the current version, such as https://www.elastic.co/guide/en/elasticsearch/reference/6.x/geoip-processor.html
- Select
Elasticsearch Guidedrop-down and select7.12 (current), or whatever version is current at the time you look at this.
- Dominant language
- Ruby
- Stars
- 265
- Forks
- 347
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
-
docs-build
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
TheOdinProject/curriculum#31408 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
notch8/utk_knapsack#148 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Homebrew/homebrew-cask#288729 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100