Add descriptions to table.csv and update link texts#6096
Add descriptions to table.csv and update link texts#6096charlotte-hoblik wants to merge 4 commits intomainfrom
table.csv and update link texts#6096Conversation
kosabogi
left a comment
There was a problem hiding this comment.
I'm not sure if refining the link texts and making them more consistent is within the scope of this PR. If not, please feel free to ignore this comment (and a lot of my suggestions).
I think we could generally use two different patterns depending on the type of page the link points to:
-
If the link points to a more conceptual or descriptive page, we could use phrasing like Learn more about [concept].
For example:
https://www.elastic.co/docs/reference/text-analysis/character-filter-reference → Learn more about character filtering -
If the link points to an API page, it might be clearer to explicitly reference the API name in the link text.
For example, for the following API page:
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segmentsA link text like Learn more about index segments could be misleading, because it sounds like it would lead to a conceptual description rather than an API reference page.
specification/_doc_ids/table.csv
Outdated
| analyze-repository,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/repo-analysis-api.html,Learn more about analyzing a snapshot repository | ||
| analyzer-anatomy,https://www.elastic.co/docs/manage-data/data-store/text-analysis/anatomy-of-an-analyzer,[use-doc-url],,Learn more about analyzers | ||
| analyzer-update-existing,https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices,[use-doc-url],,Learn more about specifying an analyzer | ||
| anthropic-max-tokens,https://docs.claude.com/en/api/messages#body-max-tokens,[use-doc-url],,Learn more about messages - Claude API Reference |
There was a problem hiding this comment.
| anthropic-max-tokens,https://docs.claude.com/en/api/messages#body-max-tokens,[use-doc-url],,Learn more about messages - Claude API Reference | |
| anthropic-max-tokens,https://docs.claude.com/en/api/messages#body-max-tokens,[use-doc-url],,Learn more about messages - Claude API reference |
specification/_doc_ids/table.csv
Outdated
| analyzer-anatomy,https://www.elastic.co/docs/manage-data/data-store/text-analysis/anatomy-of-an-analyzer,[use-doc-url],,Learn more about analyzers | ||
| analyzer-update-existing,https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices,[use-doc-url],,Learn more about specifying an analyzer | ||
| anthropic-max-tokens,https://docs.claude.com/en/api/messages#body-max-tokens,[use-doc-url],,Learn more about messages - Claude API Reference | ||
| anthropic-messages,https://docs.anthropic.com/en/api/messages,[use-doc-url],,Learn more about messages - Claude API Reference |
There was a problem hiding this comment.
| anthropic-messages,https://docs.anthropic.com/en/api/messages,[use-doc-url],,Learn more about messages - Claude API Reference | |
| anthropic-messages,https://docs.anthropic.com/en/api/messages,[use-doc-url],,Learn more about messages - Claude API reference |
specification/_doc_ids/table.csv
Outdated
| analyzer-update-existing,https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices,[use-doc-url],,Learn more about specifying an analyzer | ||
| anthropic-max-tokens,https://docs.claude.com/en/api/messages#body-max-tokens,[use-doc-url],,Learn more about messages - Claude API Reference | ||
| anthropic-messages,https://docs.anthropic.com/en/api/messages,[use-doc-url],,Learn more about messages - Claude API Reference | ||
| anthropic-models,https://docs.anthropic.com/en/docs/about-claude/models/all-models#model-names,[use-doc-url],,Learn more about Models overview - Claude API Docs |
There was a problem hiding this comment.
| anthropic-models,https://docs.anthropic.com/en/docs/about-claude/models/all-models#model-names,[use-doc-url],,Learn more about Models overview - Claude API Docs | |
| anthropic-models,https://docs.anthropic.com/en/docs/about-claude/models/all-models#model-names,[use-doc-url],,Learn more about models - Claude API reference |
specification/_doc_ids/table.csv
Outdated
| ccs-privileges,https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs,[use-doc-url],,Learn more about adding remote clusters using TLS certificate | ||
| cef-processor,https://www.elastic.co/docs/reference/enrich-processor/cef-processor,[use-doc-url],,Learn more about CEF processor | ||
| chunking-strategies,https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies,[use-doc-url],,Learn more about inference integrations | ||
| clean-up-snapshot-repo,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-cleanup,[use-doc-url],,Learn more about managing snapshot repositories in self-managed |
There was a problem hiding this comment.
| clean-up-snapshot-repo,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-cleanup,[use-doc-url],,Learn more about managing snapshot repositories in self-managed | |
| clean-up-snapshot-repo,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-cleanup,[use-doc-url],,Learn more about managing snapshot repositories in self-managed deployments |
specification/_doc_ids/table.csv
Outdated
| clear-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-trained-model-deployment-cache.html,Learn more about clearing trained model deployment cache | ||
| cluster-allocation-explain,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-allocation-explain.html,Learn more about explaining the shard allocations | ||
| cluster-allocation-explain-examples,https://www.elastic.co/docs/troubleshoot/elasticsearch/cluster-allocation-api-examples,[use-doc-url],,Learn more about using the cluster allocation API | ||
| cluster-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-get-settings.html,Learn more abou cluster-wide settings |
There was a problem hiding this comment.
| cluster-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-get-settings.html,Learn more abou cluster-wide settings | |
| cluster-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-get-settings.html,Learn more about cluster-wide settings |
specification/_doc_ids/table.csv
Outdated
| indices-recovery,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-recovery.html,Learn more about index recovery information | ||
| indices-refresh,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-refresh,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html,Learn more about Refresh an index | ||
| indices-refresh-disable,https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval,[use-doc-url],,Learn more about Tune for indexing speed | ||
| indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html,Learn more about Reload search analyzers |
There was a problem hiding this comment.
| indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html,Learn more about Reload search analyzers | |
| indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html,Learn more about the Reload search analyzers API |
specification/_doc_ids/table.csv
Outdated
| indices-refresh,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-refresh,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html,Learn more about Refresh an index | ||
| indices-refresh-disable,https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval,[use-doc-url],,Learn more about Tune for indexing speed | ||
| indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html,Learn more about Reload search analyzers | ||
| indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-cluster-api.html,Learn more about Resolve the cluster |
There was a problem hiding this comment.
| indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-cluster-api.html,Learn more about Resolve the cluster | |
| indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-cluster-api.html,Learn more about the Resolve the cluster API |
specification/_doc_ids/table.csv
Outdated
| indices-refresh-disable,https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval,[use-doc-url],,Learn more about Tune for indexing speed | ||
| indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html,Learn more about Reload search analyzers | ||
| indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-cluster-api.html,Learn more about Resolve the cluster | ||
| indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-resolve-index,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-index-api.html,Learn more about Resolve indices |
There was a problem hiding this comment.
| indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-resolve-index,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-index-api.html,Learn more about Resolve indices | |
| indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-resolve-index,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-index-api.html,Learn more about the Resolve indices API |
specification/_doc_ids/table.csv
Outdated
| indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html,Learn more about Reload search analyzers | ||
| indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-cluster-api.html,Learn more about Resolve the cluster | ||
| indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-resolve-index,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-index-api.html,Learn more about Resolve indices | ||
| indices-rollover-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-rollover,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-rollover-index.html,Learn more about Roll over to a new index |
There was a problem hiding this comment.
| indices-rollover-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-rollover,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-rollover-index.html,Learn more about Roll over to a new index | |
| indices-rollover-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover,https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-rollover,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-rollover-index.html,Learn more about the Roll over to a new index API |
specification/_doc_ids/table.csv
Outdated
| amazonbedrock-secret-keys,https://docs.aws.amazon.com/IAM/latest/usingrGuide/id_credentials_access-keys.html,[use-doc-url],,Learn more about managing access keys for IAM users | ||
| amazonsagemaker-invoke,https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html,[use-doc-url],,Learn more about InvokeEndpoint | ||
| amazonsagemaker-secret-keys,https://docs.aws.amazon.com/IAM/latest/usingrGuide/id_credentials_access-keys.html,[use-doc-url],,Learn more about managing access keys for IAM users | ||
| analysis-charfilters,https://www.elastic.co/docs/reference/text-analysis/character-filter-reference,[use-doc-url],,Learn more about character filter reference |
There was a problem hiding this comment.
| analysis-charfilters,https://www.elastic.co/docs/reference/text-analysis/character-filter-reference,[use-doc-url],,Learn more about character filter reference | |
| analysis-charfilters,https://www.elastic.co/docs/reference/text-analysis/character-filter-reference,[use-doc-url],,Learn more about character filtering |
kosabogi
left a comment
There was a problem hiding this comment.
I'm not sure if refining the link texts and making them more consistent is within the scope of this PR. If not, please feel free to ignore this comment (and a lot of my suggestions).
I think we could generally use two different patterns depending on the type of page the link points to:
-
If the link points to a more conceptual or descriptive page, we could use phrasing like Learn more about [concept].
For example:
https://www.elastic.co/docs/reference/text-analysis/character-filter-reference → Learn more about character filtering -
If the link points to an API page, it might be clearer to explicitly reference the API name in the link text.
For example, for the following API page:
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segmentsA link text like Learn more about index segments could be misleading, because it sounds like it would lead to a conceptual description rather than an API reference page.
|
Thanks so much for the detailed review, @kosabogi! I’ve fixed the typos you caught and rewrote the link descriptions to ensure they fit within the strict 33-character limit to avoid the truncation @leemthompo pointed out. You are absolutely right about using consistent patterns. It was a bit tricky to apply them strictly given the tight character limit, but I did my best to establish a fallback hierarchy to keep things as consistent as possible. Here is what I used:
Let me know what you think of the updated texts! |

This PR adds descriptions to the links in
table.csv.As a result, the links in the documentation will not show up as "External documantation" anymore; but as meaningful descriptions of where the link is pointing to.
(Generative AI was used to generate the link descriptions.)
Connected to: elastic/docs-content#5277
Preview
Before
After