Add descriptions to table.csv and update link texts

[charlotte-hoblik]

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

[leemthompo]

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

[kosabogi]

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-segments

  A 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.

[kosabogi]

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-segments

  A 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.

[charlotte-hoblik]

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!

[kosabogi]

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.

[github-actions]

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

You can validate these APIs yourself by using the make validate target.