chaoss / chaoss/grimoirelab-tutorial

Proposal to add a "user tutorial"

Offen
#110 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Ruby
Sterne
30
Forks
68
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

The current tutorial is great for developers who want to use the GrimoireLab components or engineers who want to install GrimoireLab.

What we are not describing well is how to use GrimoireLab as a user of the GUI. Sure, we can direct people to the Kibana documentation for most parts, but there are GrimoireLab specific modifications and open source metrics specific use cases that we should document.

This issue proposes to add a dedicated user documentation to the GrimoireLab tutorial.

I imagine that in the future the front page of the tutorial offers two sections: user and developer. The current tutorial will be available under the developer section. The new tutorial will be under the user section.

```
GL Tutorial
+ User Doc
+ Dev Doc

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, das aktuelle GrimoireLab-Tutorial und die darin referenzierte Kibana-Dokumentation zu prüfen. Identifiziere die GrimoireLab-spezifischen GUI-Anpassungen und Anwendungsfälle für Open-Source-Metriken, die die Benutzerdokumentation abdecken sollte. Die Aufgabe ist abgeschlossen, wenn das Tutorial in separate Abschnitte für Benutzer und Entwickler gegliedert ist und ein eigenes Benutzer-Tutorial enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.