grafana/loki

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

Offen

#9.443 geöffnet am 10.05.2023

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Go (3.997 Forks)batch import
help wantedtype/docs

Repository-Metriken

Stars
 (28.187 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Research-Richtung
Überprüfen Sie die Loki Dokumentationsdateien auf fehlende oder minimale 'description' Metadatenfelder. Konzentrieren Sie sich auf die im docs Ordner des Repositorys aufgeführten Dateien. Verwenden Sie den Grafana Writers Toolkit Front Matter Leitfaden (https://grafana.com/docs/writers toolkit/writing guide/front matter/) als Referenz. Verfassen Sie aussagekräftige Beschreibungen, die den Inhalt zusammenfassen und die Sichtbarkeit in Suchmaschinen verbessern. Es sind keine Codeänderungen erforderlich.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85