search

elastic / elasticsearch

Free and Open Source, Distributed, RESTful Search Engine
https://www.elastic.co/products/elasticsearch
Other
1.27k stars 24.86k forks source link

Health API diagnoses should use versioned reference docs links #99617

Open DaveCTurner opened 1 year ago

DaveCTurner commented 1 year ago

Today each org.elasticsearch.health.Diagnosis.Definition includes a URL to some explanatory documentation, using shortened links such as https://ela.st/restore-snapshot which link to the current version of the docs. These links will become increasingly difficult to keep stable over time, and the current docs may provide information which is inapplicable to the version the user is running. We should migrate all of these to use a org.elasticsearch.common.ReferenceDocs instead of a bare URL string so that the resulting links are versioned and checked for validity in CI.

elasticsearchmachine commented 1 year ago

Pinging @elastic/es-data-management (Team:Data Management)