tektoncd/website

Publish CLI references

Offen

#118 geöffnet am 20.05.2020

Auf GitHub ansehenContributor Guide
 (18 Kommentare) (1 Reaktion) (0 zugewiesene Personen)CSS (171 Forks)auto 404
help wantedkind/documentationlifecycle/frozen

Repository-Metriken

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

Beschreibung

As part of tekton.dev documentation, we should publish the CLI references of tkn

See https://knative.dev/docs/reference/client/ and https://github.com/tektoncd/cli/tree/master/docs/cmd (reference docs are already generated, we just need to sync them and "present" them)

/kind documentation

Contributor Guide

Research-Richtung
Identifiziere den verwendeten Static Site Generator (z. B. Hugo, Jekyll) und finde heraus, wo die CLI Dokumente im Repository tektoncd/website gespeichert sind. Überlege dann, wie die vorgefertigten Dokumente aus dem CLI Repository synchronisiert und auf der Website präsentiert werden können.
Tech Stack
htmlcss
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.
Unter 1 Stunde
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85