cncf / cncf/techdocs

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

Open
#55 1 comment 0 reactions 1 assignee Claimed by @chalin View on GitHub
e3-weeks p2-medium
Dominant language
TypeScript
Stars
56
Forks
29
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.