lbryio/lbry-sdk

Versioning for documentation to match daemon version

Offen

#1.130 geöffnet am 26.02.2018

Auf GitHub ansehenContributor Guide
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (500 Forks)batch import
area: docsgood first issuehelp wantedlevel: 1type: discussiontype: improvement

Repository-Metriken

Stars
 (7.220 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Right now the docs correspond to what's on master. We need docs for each daemon release so developers can see what's available in the version they are using.

https://github.com/jimporter/mike may be helpful.

Contributor Guide

Research-Richtung
Untersuche die Verwendung von mike zur Versionierung der Dokumentation für jedes Daemon Release und integriere es in den bestehenden Dokumentationsworkflow.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
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.
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
GitPythonDocumentation generation tools
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60