grafana/loki

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

Open

Aperta il 10 mag 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Go (28.187 star) (3997 fork)batch import
help wantedtype/docs

Descrizione

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

Guida contributor

Tech stack
Nessuno
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
blocked
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
MarkdownDocumentation best practicesLoki project overviewSearch engine optimization basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50
Direzione di ricerca
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.