grafana/loki

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

Open

#9,443 opened on May 10, 2023

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Go (28,187 stars) (3,997 forks)batch import
help wantedtype/docs

Description

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

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
MarkdownDocumentation best practicesLoki project overviewSearch engine optimization basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.