cncf / cncf/techdocs

Tech docs website best-practices: reference-implementation design & maintenance

Offen
#55 1 Kommentar 0 Reaktionen 1 zugewiesene Person Beansprucht von @chalin Auf GitHub ansehen
e3-weeks p2-medium
Vorherrschende Sprache
TypeScript
Sterne
56
Forks
29
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Evolving, documenting and demonstrating CNCF tech-docs website best-practices through reference-implementation design & maintenance, as well as techdocs documentation.

1. **Reference implementations**: design and implement website infrastructure / best-practices in _"reference-implementation" websites_ that have recently been reworked by the team:
- [etcd.io](https://github.com/etcd-io/website), with @nate-double-u
- [grpc.io](https://github.com/grpc/grpc.io)
2. **CNCF website starter**: contribute to the discussion, planning and creation of a starter, be it through either of the following:
- [hugo-netlify-starter](https://github.com/cncf/hugo-netlify-starter), or
- Our own CNCF-customized version of the [docsy-example](https://github.com/google/docsy-example)
3. **Documentation**: contribute to documenting our website best-practices.
- Related: https://github.com/cncf/techdocs/issues/54

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

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