cncf
/
techdocs
mirror of https://github.com/cncf/techdocs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
CNCF TechDocs Team
130 Commits 2 Branches 0 Tags 1.4 MiB
TypeScript 35.9%
JavaScript 32.8%
Makefile 19.1%
CSS 11.6%
MDX 0.6%
Go to file
Nate W 81199a22ff
Merge pull request #229 from dwelsch-esi/analysis-howto 
Revised TechDoc Analysis Tools
 		2024-05-31 09:16:25 -07:00
.github Fix GH action errors & Ingore GH handles in README.md (#243) 2024-05-31 11:33:28 -04:00
assessments correcting links, reformatting tables, other formatting corrections 2024-05-31 12:13:45 -04:00
docs correcting links, reformatting tables, other formatting corrections 2024-05-31 12:13:45 -04:00
images Add Kubernetes Gateway API docs assessment (#109) 2022-05-29 19:56:49 -07:00
.cspell.yml [CI] Run checks over PRs (#235) 2024-05-27 14:49:20 -07:00
.gitignore Basic tooling: link & spell chack, and formatting (#231) 2024-05-14 12:51:08 -07:00
.markdown-link-check.json Basic tooling: link & spell chack, and formatting (#231) 2024-05-14 12:51:08 -07:00
.nvmrc [CI] Run checks over PRs (#235) 2024-05-27 14:49:20 -07:00
.prettierignore Address check failures 2024-05-31 12:13:45 -04:00
LICENSE Initial commit 2020-09-21 14:28:08 -05:00
README.md correcting links, reformatting tables, other formatting corrections 2024-05-31 12:13:45 -04:00
assistance.md Address check failures 2024-05-31 12:13:45 -04:00
package.json [CI] Run checks over PRs (#235) 2024-05-27 14:49:20 -07:00

README.md

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

Zoom link: https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e

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.