cncf / cncf/toc

TAG Reboot documentation drift

Open
#1,925 2 comments 1 reaction 0 assignees View on GitHub
kind/docs kind/subproject needs-triage toc
Dominant language
HTML
Stars
1.9k
Forks
724
Avg merge
6d 12h
Merged PRs (30d)
4

Description

After some discussions with project maintainers around the process for Project Moving Levels, I noticed some documentation sprawl and out of date links/information, mostly due to the TAG Reboot in the [CNCF Project Lifecycle Process](https://github.com/cncf/toc/blob/main/process/README.md#cncf-project-lifecycle--process) doc.

Mainly I noticed that the DTR and GTR templates got caught up the archive as well as reference to previous TAG and the need for project presentations

~~I brought this up in the 10/16 Project Reviews SubProject meeting, and @mrbobbytables mentioned that doc sprawl is the main factor and there's been an effort to consolidate docs to the https://github.com/cncf/contribute-site repo and site.~~

~~I'm looking to drive a discussion and get guidance on:~~

~~1. Update the existing doc in-place and keep it in the TOC repo
2. Update and transfer to the new contribute-site repo~~

I'm repurposing this issue to be a general checklist for auditing documentation that is out-of-date or has broken links.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.