@@ -3,8 +3,61 @@ title: CNCF Techdocs how-tos
33sidebar_position : 1
44---
55
6- # CNCF Techdocs how-tos
6+ # CNCF TechDocs
77
8- This section contains documentation on how the CNCF TechDocs team does things.
9- While its intent is for the CNCF TechDocs team's use, we encourage project
10- maintainers to use these documents if you find them helpful.
8+ This site contains resources provided by the CNCF Technical Documentation team,
9+ including:
10+
11+ - Docs about building websites and developing technical documentation, including
12+ recommended tools, best practices, how-tos, and evaluation checklists. It
13+ provides specific guidelines for:
14+ - Setting up and maintaining a documentation website.
15+ - Writing technical documentation for a project.
16+ - Seeking assistance from the CNCF TechDocs community.
17+ - Analyzing project documentation.
18+
19+ It also contains a collection of documentation analyses of CNCF projects
20+ performed by the TechDocs team.
21+
22+ ## TechDocs Q&A
23+
24+ The CNCF TechDocs team holds a [ Zoom meeting] [ ] to answer questions and discuss
25+ anything to do with documentation. Meetings are held on the [ fourth Wednesday of
26+ every month at 8am Pacific time] [ date-time ] .
27+
28+ - [ Zoom meeting] [ ] link
29+ - [ Meeting notes] [ ]
30+
31+ > <small >Formerly called _ Office Hours_ , TechDocs Q& ; A started on September
32+ > 30, 2020.</small >
33+
34+ ## Assistance program for technical documentation
35+
36+ The TechDocs team can help CNCF projects analyze and improve their
37+ documentation. For details, see the TechDocs
38+ [ assistance program] ( ./assistance.md ) .
39+
40+ ## CNCF TechDocs team
41+
42+ The full-time staff of the team is:
43+
44+ - [ Daniel Krook] ( https://github.com/krook ) - Senior director of developer
45+ experience, CNCF
46+ - [ Nate W.] ( https://github.com/nate-double-u ) - Head of mentoring &
47+ documentation, CNCF
48+ - [ Patrice Chalin] ( https://github.com/chalin ) - Senior TechDocs & webdev lead
49+ - [ Uchechukwu Obasi] ( https://github.com/thisisobate ) - Developer advocate
50+
51+ Consultants and volunteers also contribute to CNCF TechDocs efforts.
52+
53+ ## Licenses
54+
55+ - Documentation: [ CC-BY-4.0] ( LICENSE )
56+ - Code: [ Apache-2.0] ( LICENSE-CODE )
57+
58+ [ date-time] :
59+ https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours
60+ [ Meeting notes] :
61+ https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/
62+ [ Zoom meeting] :
63+ https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e
0 commit comments