Skip to content

chalin/techdocs

 
 

Repository files navigation

CNCF TechDocs

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.

CNCF 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.

Office hours

The CNCF tech docs team holds office hours on the fourth Wednesday of every month at 8am Pacific time.

Office hours started on 30 September 2020.

Meeting link

Meeting notes

We store ongoing meeting notes in a Google doc.

Assistance program for technical documentation

The TechDocs team can assist CNCF projects analyze and improve their documentation. For details, see the TechDocs assistance program.

Resources

The docs/ directory contains collected resources for building websites and developing documentation, including recommended tools and practices, how-tos, and evaluation checklists.

About

CNCF TechDocs Team

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published