[Docs] UX - Update "description" in the file metadata to improve user experience · grafana/loki#9443

(0 comments) (0 reactions) (1 assignee)Go (28,187 stars) (3,997 forks)batch import

help wantedtype/docs

説明

The metadata in each documentation topic includes a description: which is displayed in search results (both Grafana Labs search and in Google search results). This description field in the metadata has minimal information in much of the Loki docs set. It would be helpful to users to take a pass through the documentation and attempt to write some meaningful text for the descriptions.

https://grafana.com/docs/writers-toolkit/writing-guide/front-matter/

Additional context The bold heading is the menuTitle metadata (or from title if menuTitle has not been defined) and the text below is from the description metadata.

GL_Search

コントリビューターガイド

技術スタック: なし
領域: documentation
Issue 種別: documentation
難度: 2
推定時間: 1-2 days
活動状況: blocked
明確さ: clear
前提条件: MarkdownDocumentation best practicesLoki project overviewSearch engine optimization basics
初心者向け度: 50
調査方針: Review the Loki documentation files for missing or minimal 'description' metadata fields. Focus on files listed in the docs folder of the repository. Use the Grafana Writers Toolkit front matter guide (https://grafana.com/docs/writers toolkit/writing guide/front matter/) as reference. Write meaningful descriptions that summarize the content and improve search engine visibility. No code changes required.