This repository holds resources provided by the CNCF Technical Documentation team. The repo contains the following directories:
analysis contains instructions, templates, and criteria for requesting and
performing an analysis of an OSS project's website and technical
documentation. Completed analyses are stored here as well.resources contains information that OSS teams can use to set up a
documentation project as suggested by the TechDocs team.The full-time staff of the CNCF Tech Docs team is:
| GitHub ID | Role |
|---|---|
| @chalin | Senior technical writer |
| @nate-double-u | Developer advocate & technical writer |
| @thisisobate | Developer advocate |
Various consultants and volunteers also contribute to CNCF Tech Docs projects.
The CNCF tech docs team holds office hours on the [fourth Wednesday of every month at 8am Pacific time][date-time].
Office hours started on 30 September 2020.
We store ongoing meeting notes in a Google doc.
The TechDocs team can assist CNCF projects analyze and improve their documentation. For details, see the TechDocs assistance program.
The docs/ directory contains collected resources for building websites and
developing documentation, including recommended tools and practices, how-tos,
and evaluation checklists.
[date-time]: https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours [Zoom meeting 95471930872]: https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e