elastic / elastic/docs

permalinks in documentation

Open
#50 5 comments 0 reactions 0 assignees View on GitHub
defer enhancement link-checking versions
Dominant language
Ruby
Stars
265
Forks
347
Avg merge
3d 15h
Merged PRs (30d)
2

Description

There are instances where linking to "current" documentation is a bad idea. For example,

http://elasticsearch-users.115913.n3.nabble.com/What-is-the-meaning-of-throttle-time-in-millis-tp4050893p4050921.html

The post points to the link for [current documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-store.html#store-throttling) which contains no info for store throttling, like the [1.7 version of the document](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/index-modules-store.html#store-throttling).

Is there a way we can encourage the use of permalinks in our documentation to avoid this problem? Sometimes it is not obvious how to obtain the permalink in Elastic documentation; [Logstash Introduction](https://www.elastic.co/guide/en/logstash/current/introduction.html#introduction) is an example.

New documentation is comes with every release and we should try to encourage those linking to the docs to only use permalinks as those links run the risk of being invalidated.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.