Skip to content

Add descriptions to table.csv and update link texts#6096

Open
charlotte-hoblik wants to merge 6 commits intomainfrom
add-descriptions-5277
Open

Add descriptions to table.csv and update link texts#6096
charlotte-hoblik wants to merge 6 commits intomainfrom
add-descriptions-5277

Conversation

@charlotte-hoblik
Copy link
Contributor

@charlotte-hoblik charlotte-hoblik commented Mar 8, 2026

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

Screenshot 2026-03-08 at 23 58 26 Screenshot 2026-03-09 at 0 01 40

After

Screenshot 2026-03-10 at 12 30 42 Screenshot 2026-03-10 at 12 31 28

@leemthompo
Copy link
Contributor

One general comment, let's try to avoid any truncated link text like this:

Screenshot 2026-03-09 at 14 17 52

Copy link
Contributor

@kosabogi kosabogi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Copy link
Contributor

@kosabogi kosabogi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

@charlotte-hoblik
Copy link
Contributor Author

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:

  • “Learn more about [X]” (when X is ≤13 characters)
  • “More about [X]” (when it fits within 33 characters)
  • “About [X]” (for the tightest limits)
  • “Creating or updating [object]” (for create/update actions, e.g., alias, lifecycle policy, GeoIP database)

Let me know what you think of the updated texts!

Copy link
Contributor

@kosabogi kosabogi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed it up to line 150. In some places, sentences are cut off. I marked these with comments, but it might be worth running another round with AI and reviewing them again.

alibabacloud-api-keys,https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key,[use-doc-url],,More about Alibaba Cloud API keys
analysis-analyzers,https://www.elastic.co/docs/reference/text-analysis/analyzer-reference,[use-doc-url],,Learn more about analyzers
amazonbedrock-models,https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html,[use-doc-url],,More about Amazon Bedrock models
amazonbedrock-secret-keys,https://docs.aws.amazon.com/IAM/latest/usingrGuide/id_credentials_access-keys.html,[use-doc-url],,About managing access keys for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like something important got cut off here (possibly “AWS”?).
If this was due to a character limit, we could rephrase it as either:

  • “About managing access keys” (if the surrounding context makes it clear), or
  • “Managing AWS access keys” (clearer and more explicit).

amazonbedrock-models,https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html,[use-doc-url],,More about Amazon Bedrock models
amazonbedrock-secret-keys,https://docs.aws.amazon.com/IAM/latest/usingrGuide/id_credentials_access-keys.html,[use-doc-url],,About managing access keys for
amazonsagemaker-invoke,https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html,[use-doc-url],,More about InvokeEndpoint
amazonsagemaker-secret-keys,https://docs.aws.amazon.com/IAM/latest/usingrGuide/id_credentials_access-keys.html,[use-doc-url],,About managing access keys for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

autoscaling-put-autoscaling-policy,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-put-autoscaling-policy.html,Learn more about autoscaling
avoid-index-pattern-collisions,https://www.elastic.co/docs/manage-data/data-store/templates#avoid-index-pattern-collisions,[use-doc-url],,Learn more about templates
azureaistudio-api-keys,https://ai.azure.com/,[use-doc-url],,More about Microsoft foundry
azureaistudio-endpoint-types,https://learn.microsoft.com/en-us/azure/ai-foundry/concepts/deployments-overview#billing-for-deploying-and-inferencing-llms-in-azure-ai-studio,[use-doc-url],,About deployment options for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

azureopenai-auth,https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#authentication,[use-doc-url],,About Azure OpenAI in Microsoft
azureopenai-portal,https://portal.azure.com/#view/HubsExtension/BrowseAll,[use-doc-url],,More about Microsoft Azure
azureopenai-quota-limits,https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits,[use-doc-url],,More about quotas and limits
behavioral-analytics-collection-event,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-analytics-collection-event.html,About creating a behavioral
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Analytics" got cut off here

cat,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat,[use-doc-url],https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat.html,Learn more about CAT
ccr,https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication,[use-doc-url],,About cross-cluster replication
ccr-auto-follow,https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns,[use-doc-url],,More about auto-follow patterns
ccr-delete-auto-follow-pattern,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-delete-auto-follow-pattern.html,About deleting auto-follow
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"pattern" got cut off here

cluster-name,https://www.elastic.co/docs/deploy-manage/deploy/self-managed/important-settings-configuration##_cluster_name_setting,[use-doc-url],,Learn more about cluster name
cluster-nodes-hot-threads,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-hot-threads,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-hot-threads.html,About the hot threads for nodes
cluster-nodes-info,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-info.html,More about node information
cluster-nodes-reload-secure-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings,,https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-reload-secure-settings.html,About reloading the keystore on
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

something got cut off here

cluster,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster,[use-doc-url],https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster.html,Learn more about clusters
cohere-api-keys,https://dashboard.cohere.com/api-keys,[use-doc-url],,More about Cohere API keys
cohere-models,https://docs.cohere.com/docs/models#command,[use-doc-url],,Learn more about Cohere models
common-options,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options,[use-doc-url],,About Elasticsearch API common
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

something got cut off here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants