CNCF TechDocs Team
Go to file
Patrice Chalin 1c10ff3054
Canonicalize README links, cleanup package.json (#326)
2025-06-18 07:16:14 -04:00
.github [CI] GitHub workflow cleanup 2025-02-26 04:54:19 -05:00
analyses Rename {analyses,docs}/**/README.md to index.md (#323) 2025-06-16 14:07:26 -04:00
docs Link, title, and filename adjustments (#325) 2025-06-18 05:28:08 -04:00
scripts Rename {analyses,docs}/**/README.md to index.md (#323) 2025-06-16 14:07:26 -04:00
src Docusaurus version of docs pages (#301) 2025-03-17 12:55:23 -04:00
static Update refcache: Add Daniel's GH handle (#319) 2025-06-14 14:42:10 -04:00
.cspell.yml Link, title, and filename adjustments (#325) 2025-06-18 05:28:08 -04:00
.gitignore Fix page title, adjust link-check scripts (#324) 2025-06-17 11:39:07 -04:00
.htmltest.yml Analytics docs rework: factor out UA-to-GA4 instructions, and more (#312) 2025-04-24 06:04:10 -04:00
.markdown-link-check.json Adjust markdown syntax of analyses pages (#302) 2025-03-18 11:24:18 -04:00
.markdownlint.yaml Rename {analyses,docs}/**/README.md to index.md (#323) 2025-06-16 14:07:26 -04:00
.nvmrc [CI] Run checks over PRs (#235) 2024-05-27 14:49:20 -07:00
.prettierignore Initialize the Japanese Localization Guidelines (#259) 2024-07-01 18:05:49 -07:00
LICENSE Fix licenses (#305) 2025-03-19 07:31:07 -04:00
LICENSE-CODE Fix licenses (#305) 2025-03-19 07:31:07 -04:00
Makefile [CI] Use htmltest for link checking (#310) 2025-03-19 13:45:05 -04:00
README.md Canonicalize README links, cleanup package.json (#326) 2025-06-18 07:16:14 -04:00
docusaurus.config.ts Analytics docs rework: factor out UA-to-GA4 instructions, and more (#312) 2025-04-24 06:04:10 -04:00
netlify.toml Analytics docs rework: factor out UA-to-GA4 instructions, and more (#312) 2025-04-24 06:04:10 -04:00
package.json Canonicalize README links, cleanup package.json (#326) 2025-06-18 07:16:14 -04:00
sidebars.ts Docusaurus version of docs pages (#301) 2025-03-17 12:55:23 -04:00
tsconfig.json Docusaurus version of docs pages (#301) 2025-03-17 12:55:23 -04:00

README.md

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.

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:

Consultants and volunteers also contribute to CNCF TechDocs efforts.

Licenses