diff --git a/.cspell.yml b/.cspell.yml index 55a0de5..2af4e9b 100644 --- a/.cspell.yml +++ b/.cspell.yml @@ -21,6 +21,7 @@ ignorePaths: # - CodeBlock words: - backstore + - Chalin - CLOTributor - CNCF - Docsy @@ -34,9 +35,12 @@ words: - mkdocs - nate - nvmrc + - Obasi - subpages - techdocs - toolkits - toto - triaging + - Uchechukwu + - webdev - Welsch diff --git a/.github/workflows/trigger-contribute-site-netlify.yml b/.github/workflows/trigger-contribute-site-netlify.yml new file mode 100644 index 0000000..db81972 --- /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 }}" diff --git a/docs/index.md b/docs/index.md index 9f616fb..7668554 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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][] + +> 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 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