11# CNCF TechDocs
22
3- This repository holds resources provided by the CNCF Technical Documentation
4- team. The repo contains the following directories :
3+ This site contains resources provided by the CNCF Technical Documentation team,
4+ including :
55
6- - ` docs ` contains collected resources for building websites and developing
7- documentation, including recommended tools and practices, how-tos, and
8- evaluation checklists. Included are specific guidelines for:
6+ - [ Docs ] ( docs ) about building websites and developing technical documentation,
7+ including recommended tools, best practices, how-tos, and evaluation
8+ checklists. It provides specific guidelines for:
99 - Setting up and maintaining a documentation website.
1010 - Writing technical documentation for a project.
11- - Getting assistance from the CNCF TechDocs community.
12- - Analyzing project documentation, for use by CNCF TechDocs staff (in
13- ` docs/analysis ` ).
14- - ` analyses ` (not to be confused with ` docs/analysis ` ) contains all the
15- completed documentation analyses.
11+ - Seeking assistance from the CNCF TechDocs community.
12+ - [ Analyzing project documentation] ( docs/analysis/ ) .
13+ - [ Analyses] ( analyses ) : a collection of documentation analyses of CNCF projects
14+ performed by the TechDocs team.
1615
1716## TechDocs Q&A
1817
19- The CNCF tech docs team holds a Zoom call to answer questions and discuss
20- anything to do with documentation. Calls are held on the [ fourth Wednesday of
18+ The CNCF TechDocs team holds a [ Zoom meeting ] [ ] to answer questions and discuss
19+ anything to do with documentation. Meetings are held on the [ fourth Wednesday of
2120every month at 8am Pacific time] [ date-time ] .
2221
23- TechDocs Q&A (formerly called _ Office Hours_ ) started on 30 September 2020.
22+ - [ Zoom meeting] [ ] link
23+ - [ Meeting notes] [ ]
2424
25- ### Meeting link
26-
27- - [ Zoom meeting 95471930872]
28-
29- ### Meeting notes
30-
31- We store ongoing meeting notes in a
32- [ Google doc] ( https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/ ) .
25+ > <small >Formerly called _ Office Hours_ , TechDocs Q& ; A started on September
26+ > 30, 2020.</small >
3327
3428## Assistance program for technical documentation
3529
@@ -39,20 +33,14 @@ documentation. For details, see the TechDocs
3933
4034## CNCF TechDocs team
4135
42- The full-time staff of the CNCF Tech Docs team is :
36+ The full-time staff of the team is (in alphabetical order) :
4337
44- <!-- markdownlint-disable line-length -->
38+ - [ Nate Waddington] ( https://github.com/nate-double-u ) - head of mentoring &
39+ documentation
40+ - [ Patrice Chalin] ( https://github.com/chalin ) - senior techdoc & webdev lead
41+ - [ Uchechukwu Obasi] ( https://github.com/thisisobate ) - developer advocate
4542
46- | GitHub ID | Role |
47- | -------------------------------------------------- | --------------------------------------- |
48- | [ @chalin ] ( https://github.com/chalin ) | Senior technical writer |
49- | [ @nate-double-u ] ( https://github.com/nate-double-u ) | Head of Mentoring & Documentation, CNCF |
50- | [ @thisisobate ] ( https://github.com/thisisobate ) | Developer advocate |
51-
52- <!-- markdownlint-enable line-length -->
53- <!-- cSpell:ignore chalin nate thisisobate -->
54-
55- Various consultants and volunteers also contribute to CNCF Tech Docs projects.
43+ Consultants and volunteers also contribute to CNCF TechDocs efforts.
5644
5745## Licenses
5846
@@ -61,5 +49,9 @@ Various consultants and volunteers also contribute to CNCF Tech Docs projects.
6149
6250[ date-time] :
6351 https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours
64- [ Zoom meeting 95471930872] :
52+ [ Meeting notes] :
53+ https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/
54+ [ Zoom meeting] :
6555 https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e
56+
57+ <!-- cSpell:ignore Chalin Waddington Uchechukwu Obasi techdoc webdev -->
0 commit comments