Backport of docs: Search Description Refresh into release/1.13.x

[hc-github-team-consul-core]

Backport

This PR is auto-generated from #14643 to be assessed for backporting due to the inclusion of the label type/docs-cherrypick.

WARNING automatic cherry-pick of commits failed. Commits will require human attention.

merge conflict error: unable to process merge commit: "ec679cb5b7602f8ecd2e5bad17de4a6ab1d80dca", automatic backport requires rebase workflow

The below text is copied from the body of the original PR.

---

This PR was created as part of the Consul Docs DevDot migration.

Consul Docs Search Refresh

Page metadata headers in the Consul documentation currently include “page title” and “page description” fields. Because our search functions do not match full article text, these fields are used to:

1. Provide the terms that the internal search functions match with to produce results, meaning that these descriptions index the site’s content for search
2. Populate the internal search results, meaning that these descriptions will be displayed to users as a way to help them select the most relevant page
3. Order internal search results based on Title match and then Description match, alphabetizing within each, meaning that the words used in the page titles have a higher impact on the search results that appear first

Additionally, these fields describe pages for their external Google Search results, meaning that the first 160 characters of each description greatly impact search rankings and user decisions when selecting pages.

Notes for Reviewers

• Page titles currently apply ad hoc punctuation schema in an attempt to include the most important terms and produce more meaningful top results when assuming results are returned alphabetically. Please remember that titles will continue to change as we make organizational and display adjustments in DevDot. When making suggestions, I encourage you to propose different combinations of terms and punctuation as you see fit - but please be aware that making these suggestions on every single title will not be an efficient use of time. I will do my best to standardize title formatting based on any additional input you provide.
  • Primary goals in title reviews:
    • Accurate categorization. For example, the title has “observability” when it should be “traffic management”
    • Highest priority terms and acronyms used
• Page descriptions: Descriptions were written to summarize a page’s content with an eye towards how components work in Consul, user end-goals, and what content is actually contained in the page. Additionally, every description’s first 160 characters include a complete sentence, and the character cut-off was considered semantically significant for each description (for example, if a word is cut off, it should still be comprehensible, so there aren’t lingering individual characters). You do not have to consider character counts in your review. Make suggestions, and I will review them in light of these constraints to fine-tune wording.
  • Primary goals in description reviews:
    • Technical accuracy in descriptions
    • Includes terms that could reasonably be part of to find this page’s content
    • Does not use words that are semantically insignificant or misleading. For example, “get” is not a descriptive verb and it has a specific use in API requests, so it has increased potential to skew search results.

Please direct any questions to @boruszak.

---

Overview of commits

• 1f168f6 - ec679cb - 046a046 - c568021 - 21d8358 - 4b06add - 8efc8fa - f1c6629 - 6dcc2a2 - e00e066 - 5e86650 - f06348c - c7a6187 - 04d66e7 - 4278fe8 - 45ea33b - fc5be5d - 11a5fec - 6bac01e - c94f8c2 - 205e866 - 110139a - dc66e10 - 7d09a93 - e3f6a3a - 18e1844 - a6cd059 - eba36ba - 8d181da - dd8907c - 8a58aab - 6c0f27f - 8d742d5 - 977ac69 - add1b0a - f91f01c - 76c064d - a95a7ec - 9c5de92 - f76983f - 4b6fef4 - df9702f - b79fb73 - 2b122dd - 653cfb4 - 76f044d - f60da88 - ebcb557 - 38fd65b - 2b69d80 - 2a70eef - e339379 - 0de4184 - acfbda9 - 906ebb9 - beee474 - 46499d2 - a208928 - 2a86195 - f1b11e2 - 0dba086 - 21621f3 - 2b171fc - 78c53ef - 72e53c7 - bd39e1b - 7c2b8e4 - 57d410a - 0e04265 - 1814d67