cncf
/
techdocs
mirror of https://github.com/cncf/techdocs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
CNCF TechDocs Team
168 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 e9225bce00
Add trademark guidance for Series LLCs to website guidelines (#298) 
* adding guidance for Series LLCs

Signed-off-by: Nate W <natew@cncf.io>

* Update docs/website-guidelines-checklist.md

Signed-off-by: Nate W <natew@cncf.io>

* Update docs/website-guidelines-checklist.md

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>

* updating formatting after applying edit

Signed-off-by: Nate W <natew@cncf.io>

---------

Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
 		2025-03-12 15:00:58 -04:00
.github [CI] GitHub workflow cleanup 2025-02-26 04:54:19 -05:00
analyses [chore] Check Keda analysis pages 2025-02-26 15:25:04 -05:00
docs Add trademark guidance for Series LLCs to website guidelines (#298) 2025-03-12 15:00:58 -04:00
.cspell.yml updating domain and netlify information (#299) 2025-03-12 16:42:44 +00:00
.gitignore Basic tooling: link & spell chack, and formatting (#231) 2024-05-14 12:51:08 -07:00
.markdown-link-check.json [chore] Fix link fragments (#293) 2025-02-25 14:05:00 -05:00
.markdownlint.yaml [CI & docs] Rework of analysis docs + improved checks (#256) 2024-06-12 19:24:16 -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 Initial commit 2020-09-21 14:28:08 -05:00
README.md Criteria: sandbox update/clarification (#266) 2024-07-30 11:58:51 -07:00
package.json [chore] Check Keda analysis pages 2025-02-26 15:25:04 -05:00

README.md

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.

TechDocs Q&A (formerly called Office Hours) started on 30 September 2020.

Meeting link

Meeting notes

We store ongoing meeting notes in a Google doc.

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 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.