grafana/loki

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

开放

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

 (0 条评论) (0 个反应) (1 位负责人)Go (3,997 个派生)batch import
help wantedtype/docs

仓库指标

星标
 (28,187 个星标)
PR 合并指标
 (平均合并 5天 20小时) (30 天内合并 522 个 PR)

描述

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

贡献者指南