CNCF TechDocs

This site contains resources provided by the CNCF Technical Documentation team, including:

• Docs about building websites and developing technical documentation, including recommended tools, best practices, how-tos, and evaluation checklists. It provides specific guidelines for:
  • Setting up and maintaining a documentation website.
  • Writing technical documentation for a project.
  • Seeking assistance from the CNCF TechDocs community.
  • Analyzing project documentation.
• Analyses: a collection of documentation analyses of CNCF projects performed by the TechDocs team.

TechDocs Q&A

The CNCF TechDocs team holds a Zoom meeting to answer questions and discuss anything to do with documentation. Meetings are held on the fourth Wednesday of every month at 8am Pacific time.

• Zoom meeting link
• Meeting notes

Formerly called Office Hours, TechDocs Q&A started on September 30, 2020.

Assistance program for technical documentation

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

CNCF TechDocs team

The full-time staff of the team is (in alphabetical order):

• Nate Waddington - Head of mentoring & documentation
• Patrice Chalin - Senior techdoc & webdev lead
• Uchechukwu Obasi - Developer advocate

Consultants and volunteers also contribute to CNCF TechDocs efforts.

Licenses

• Documentation: CC-BY-4.0
• Code: Apache-2.0