grafana/loki

[Docs] UX - Update "description" in the file metadata to improve user experience

Open

#9,443 创建于 2023年5月10日

在 GitHub 查看
 (0 评论) (0 反应) (1 负责人)Go (28,187 star) (3,997 fork)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
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
blocked
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
MarkdownDocumentation best practicesLoki project overviewSearch engine optimization basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
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.