grafana/loki

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

Aperta

#9443 aperta il 10 mag 2023

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (1 assegnatario)Go (3997 fork)batch import
help wantedtype/docs

Metriche repository

Star
 (28.187 stelle)
Metriche merge PR
 (Merge medio 5g 20h) (522 PR mergiate in 30 g)

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

Direzione di ricerca
Rivedere i file di documentazione di Loki per individuare campi di metadati 'description' mancanti o minimi. Concentrarsi sui file elencati nella cartella docs del repository. Utilizzare come riferimento la guida front matter di Grafana Writers Toolkit (https://grafana.com/docs/writers toolkit/writing guide/front matter/). Scrivere descrizioni significative che riassumano il contenuto e migliorino la visibilità sui motori di ricerca. Non sono richieste modifiche al codice.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85