Giter VIP home page Giter VIP logo

cncf-techdocs's Introduction

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

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.