Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ ignorePaths:
# - CodeBlock
words:
- backstore
- Chalin
- CLOTributor
- CNCF
- Docsy
Expand All @@ -34,9 +35,12 @@ words:
- mkdocs
- nate
- nvmrc
- Obasi
- subpages
- techdocs
- toolkits
- toto
- triaging
- Uchechukwu
- webdev
- Welsch
13 changes: 13 additions & 0 deletions .github/workflows/trigger-contribute-site-netlify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Trigger contribute-site Netlify build

on:
push:
branches: [main]

jobs:
trigger:
runs-on: ubuntu-latest
steps:
- name: Call Netlify build hook
run: |
curl -sS -X POST "${{ secrets.NETLIFY_CONTRIBUTE_SITE_BUILD_HOOK }}"
61 changes: 57 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,61 @@ title: CNCF Techdocs how-tos
sidebar_position: 1
---

# CNCF Techdocs how-tos
# CNCF TechDocs

This section contains documentation on how the CNCF TechDocs team does things.
While its intent is for the CNCF TechDocs team's use, we encourage project
maintainers to use these documents if you find them helpful.
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](./analysis).

It also contains 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][date-time].

- [Zoom meeting][] link
- [Meeting notes][]

> <small>Formerly called _Office Hours_, TechDocs Q&amp;A started on September
> 30, 2020.</small>

## Assistance program for technical documentation

The TechDocs team can help CNCF projects analyze and improve their
documentation. For details, see the TechDocs
[assistance program](./assistance.md).

## CNCF TechDocs team

The full-time staff of the team is:

- [Daniel Krook](https://github.com/krook) - Senior director of developer
experience, CNCF
- [Nate W.](https://github.com/nate-double-u) - Head of mentoring &
documentation, CNCF
- [Patrice Chalin](https://github.com/chalin) - Senior TechDocs & webdev lead
- [Uchechukwu Obasi](https://github.com/thisisobate) - Developer advocate

Consultants and volunteers also contribute to CNCF TechDocs efforts.

## Licenses

- Documentation: [CC-BY-4.0](LICENSE)
- Code: [Apache-2.0](LICENSE-CODE)

[date-time]:
https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours
[Meeting notes]:
https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/
[Zoom meeting]:
https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e