From e1de805aca6a1622cb5f2ff8bed8be3f6466b284 Mon Sep 17 00:00:00 2001 From: thisisobate Date: Tue, 24 Feb 2026 11:43:57 +0300 Subject: [PATCH 1/5] chore: Add a GH workflow to trigger contribute site Signed-off-by: thisisobate --- .../workflows/trigger-contribute-site-netlify.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/workflows/trigger-contribute-site-netlify.yml diff --git a/.github/workflows/trigger-contribute-site-netlify.yml b/.github/workflows/trigger-contribute-site-netlify.yml new file mode 100644 index 0000000..af8e923 --- /dev/null +++ b/.github/workflows/trigger-contribute-site-netlify.yml @@ -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 }}" \ No newline at end of file From f96a0c1135d9f71928e1f3f840cc34a220306b39 Mon Sep 17 00:00:00 2001 From: thisisobate Date: Tue, 24 Feb 2026 11:48:09 +0300 Subject: [PATCH 2/5] chore: prettify code Signed-off-by: thisisobate --- .github/workflows/trigger-contribute-site-netlify.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/trigger-contribute-site-netlify.yml b/.github/workflows/trigger-contribute-site-netlify.yml index af8e923..db81972 100644 --- a/.github/workflows/trigger-contribute-site-netlify.yml +++ b/.github/workflows/trigger-contribute-site-netlify.yml @@ -10,4 +10,4 @@ jobs: steps: - name: Call Netlify build hook run: | - curl -sS -X POST "${{ secrets.NETLIFY_CONTRIBUTE_SITE_BUILD_HOOK }}" \ No newline at end of file + curl -sS -X POST "${{ secrets.NETLIFY_CONTRIBUTE_SITE_BUILD_HOOK }}" From 64debbd2924c6e1b7ba25a53c693d5182c4cc332 Mon Sep 17 00:00:00 2001 From: thisisobate Date: Tue, 3 Mar 2026 15:48:12 +0000 Subject: [PATCH 3/5] chore: move info from top level README to docs readme Signed-off-by: thisisobate --- docs/index.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 56 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9f616fb..88b8685 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,8 +3,60 @@ 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). +- [Analyses](./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][date-time]. + +- [Zoom meeting][] link +- [Meeting notes][] + +> 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](./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 techdoc & 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 From ec91c22a129f19b1e075ad7516dc9c7da952760a Mon Sep 17 00:00:00 2001 From: thisisobate Date: Tue, 3 Mar 2026 15:59:43 +0000 Subject: [PATCH 4/5] chore: fix CI errors Signed-off-by: thisisobate --- .cspell.yml | 4 ++++ docs/index.md | 12 ++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/.cspell.yml b/.cspell.yml index c13d3e9..0fa4166 100644 --- a/.cspell.yml +++ b/.cspell.yml @@ -21,6 +21,7 @@ ignorePaths: # - CodeBlock words: - backstore + - Chalin - CLOTributor - CNCF - Docsy @@ -32,9 +33,12 @@ words: - mkdocs - nate - nvmrc + - Obasi - subpages - techdocs - toolkits - toto - triaging + - Uchechukwu + - webdev - Welsch diff --git a/docs/index.md b/docs/index.md index 88b8685..abda93f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,15 +8,15 @@ sidebar_position: 1 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: +- 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). -- [Analyses](./analyses): a collection of documentation analyses of CNCF projects - performed by the TechDocs team. +- [Analyses](./analyses): a collection of documentation analyses of CNCF + projects performed by the TechDocs team. ## TechDocs Q&A @@ -44,7 +44,7 @@ The full-time staff of the team is: experience, CNCF - [Nate W.](https://github.com/nate-double-u) - Head of mentoring & documentation, CNCF -- [Patrice Chalin](https://github.com/chalin) - Senior techdoc & webdev lead +- [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. From b98029ae791f0c5de96de0c57bfbcc74b6d1091b Mon Sep 17 00:00:00 2001 From: thisisobate Date: Thu, 5 Mar 2026 11:25:28 +0000 Subject: [PATCH 5/5] chore: nit fix Signed-off-by: thisisobate --- docs/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index abda93f..7668554 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,8 +15,9 @@ including: - Writing technical documentation for a project. - Seeking assistance from the CNCF TechDocs community. - [Analyzing project documentation](./analysis). -- [Analyses](./analyses): a collection of documentation analyses of CNCF - projects performed by the TechDocs team. + +It also contains a collection of documentation analyses of CNCF projects +performed by the TechDocs team. ## TechDocs Q&A