https://github.com/cncf/techdocs

CNCF TechDocs Team
https://github.com/cncf/techdocs

cncf documentation

Last synced: 6 months ago
JSON representation

CNCF TechDocs Team

• Host: GitHub
• URL: https://github.com/cncf/techdocs
• Owner: cncf
• License: apache-2.0
• Created: 2020-09-21T19:28:06.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-06T20:10:58.000Z (over 1 year ago)
• Last Synced: 2024-12-29T18:29:52.457Z (over 1 year ago)
• Topics: cncf, documentation
• Homepage: https://cncf.io
• Size: 449 KB
• Stars: 46
• Watchers: 12
• Forks: 27
• Open Issues: 59
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CNCF TechDocs

This repository holds resources provided by the CNCF Technical Documentation

team. The repo contains the following directories:

- `docs` contains collected resources for building websites and developing

  documentation, including recommended tools and practices, how-tos, and

  evaluation checklists. Included are specific guidelines for:

  - Setting up and maintaining a documentation website.

  - Writing technical documentation for a project.

  - Getting assistance from the CNCF TechDocs community.

  - Analyzing project documentation, for use by CNCF TechDocs staff (in

    `docs/analysis`).

- `analyses` (not to be confused with `docs/analysis`) contains all the

  completed documentation analyses.

## TechDocs Q&A

The CNCF tech docs team holds a Zoom call to answer questions and discuss

anything to do with documentation. Calls are held on the [fourth Wednesday of

every month at 8am Pacific time][date-time].

TechDocs Q&A (formerly called _Office Hours_) started on 30 September 2020.

### Meeting link

- [Zoom meeting 95471930872]

### Meeting notes

We store ongoing meeting notes in a

[Google doc](https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/).

## Assistance program for technical documentation

The TechDocs team can help CNCF projects analyze and improve their

documentation. For details, see the TechDocs

[assistance program](docs/assistance.md).

## CNCF TechDocs team

The full-time staff of the CNCF Tech Docs team is:

| GitHub ID                                          | Role                                  |

| -------------------------------------------------- | ------------------------------------- |

| [@chalin](https://github.com/chalin)               | Senior technical writer               |

| [@nate-double-u](https://github.com/nate-double-u) | Developer advocate & technical writer |

| [@thisisobate](https://github.com/thisisobate)     | Developer advocate                    |

Various consultants and volunteers also contribute to CNCF Tech Docs projects.

[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