CNCF Tech Docs

@cncf-tech-docs

Public team

Joined on Jun 16, 2022

  • Prepared by: @jbogarthyde (@add-link-to-your-github-id)<br> Date: 2023-08-29 Introduction This document assesses the quality and completeness of the in-toto project's documentation and website. This document: Measures existing documentation quality against the CNCF’s standards Recommends specific and general improvements
     Like  Bookmark
  •  Like  Bookmark
  •  Like  Bookmark
  • title: Backstage tech docs assessment notes tags: backstage This document contains notes about the CNCF Backstage documentation. These are working notes, taken as I reviewed the existing Backstage documentation and website. They are not intended to be a polished report of any kind. The ultimate goal of this work is to deliver an assessment of the Backstage documentation as described in the CNCF assessment guidelines. When complete, the assessment will be included in GitHub as a separate document with the other CNCF tech doc assessments (in that same GitHub directory). The assessed Backstage documentation includes: The Backstage website
     Like  Bookmark
  • Prepared by: Dave Welsch (@dwelsch-esi)<br> Date: 2023-09-01 Introduction This document assesses the quality and completeness of the Backstage project's documentation and website. This document: Measures existing documentation quality against the CNCF’s standards Provides examples of great documentation as a reference
     Like  Bookmark
  • API https://backstage.io/docs/features/software-catalog/system-model App An installation of Backstage. Backstage A platform for creating and deploying developer portals, developed at Spotify. Backstage is an incubation-stage open source project of the Cloud Native Computing Foundation.
     Like  Bookmark
  • Assessment template Prepared by: <name> (@add-link-to-your-github-id)<br> Date: 2021-mm-dd Introduction This document assesses the quality and completeness of a project's documentation and website (if present). This document: Measures existing documentation quality against the CNCF’s standards
     Like  Bookmark
  • Notes meeting notes: https://docs.google.com/document/d/12OGtSaUtlc7OA_iPnUvmVaiKg8yM7_QBzFnMgoHvnLw/edit?usp=sharingwebsite: https://getporter.org/repos: https://github.com/getporter/porter (main site), site content is in docs/ folder https://github.com/getporter/operator (https://getporter.org/operator site) Assessment template Prepared by: Uchechukwu Obasi
     Like  Bookmark
  • ChatGPT-4 generated Porter docs assessment This is a test to see how chatgpt would perform in doing a documentation assessment based the CNCF techdocs documentation critera (found here: https://github.com/cncf/techdocs/tree/main/assessments). Can generated content be used to help speed up the docs assessment process? Nate W. prompt: can you do a documentation assessment of getporter.org/docs based on the CNCF techdocs documentation assessments criteria and examples using the following template: Assessment template
     Like  Bookmark
  • KEDA Docs Assessment - DRAFT Prepared by: Uche (thisisobate) Date: 2021-06-17 https://keda.sh/ https://github.com/kedacore/keda-docs Note: keda.sh is a Hugo site. Introduction
     Like  Bookmark