CNCF TechDocs Team

Go to file

Junya Okabe 75cc9b0b96 Initialize the Japanese Localization Guidelines (#259 ) * feat: initialize Japanese l10n guide Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> * update: add review section Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> * fix: anchor link Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> * Update: l10n reviewer Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> * fix: linter errors Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> * feat: add ## Localization READMEs Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> * fix: link checker error Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> * update: .prettierignore Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> * Update docs/localization/README.md Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> * Update .prettierignore Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> * fix: L6 Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> --------- Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp> Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com> Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>		2024-07-01 18:05:49 -07:00
.github	[CI & docs] Rework of analysis docs + improved checks (#256 )	2024-06-12 19:24:16 -04:00
analyses	Update README.md - add issues-list filename (#262 )	2024-06-26 18:05:19 -07:00
docs	Initialize the Japanese Localization Guidelines (#259 )	2024-07-01 18:05:49 -07:00
.cspell.yml	Move assessments to analyses and more (#245 )	2024-05-31 13:08:05 -04:00
.gitignore	Basic tooling: link & spell chack, and formatting (#231 )	2024-05-14 12:51:08 -07:00
.markdown-link-check.json	Fix all links in docs and analyses, and rename resources (#248 )	2024-05-31 18:16:16 -04: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	[CI & docs] Rework of analysis docs + improved checks (#256 )	2024-06-12 19:24:16 -04:00
package.json	[CI & docs] Rework of analysis docs + improved checks (#256 )	2024-06-12 19:24:16 -04: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 meeting 95471930872

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.