brndnmtthws/conky

Improve documentation handling

Offen

#762 geöffnet am 10.01.2019

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (666 Forks)batch import
documentationgood first issuehelp wanted

Repository-Metriken

Stars
 (8.477 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T) (17 gemergte PRs in 30 T)

Beschreibung

I'd like to convert the documentation from a XML/XSL-based system, to a simpler JSON/Jekyll/Jinja2 based system. I would also like to use GitHub pages to provide a landing page with documentation for Conky.

Contributor Guide

Research-Richtung
Untersuche die vorhandenen XML/XSL Dokumentationsdateien, verstehe die Struktur und lerne Jekyll und Jinja2, um ein neues JSON basiertes System zu entwerfen.
Tech Stack
rubypython
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
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
GitGitHub Pages
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75