Skip to content

Analysis templates suggested updates - #357

Open
iRaindrop wants to merge 40 commits into
cncf:mainfrom
iRaindrop:analysis-templates-updates
Open

iRaindrop wants to merge 40 commits into
cncf:mainfrom
iRaindrop:analysis-templates-updates

Conversation

@iRaindrop

Copy link
Copy Markdown
Collaborator

This PR is for collaborating on changes to the CNCF Techdocs analysis template(s).

Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
@netlify

netlify Bot commented Jun 9, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for cncf-techdocs ready!

Name Link
🔨 Latest commit 59fd2c2
🔍 Latest deploy log https://app.netlify.com/projects/cncf-techdocs/deploys/6a4d7202a350d300087dc288
😎 Deploy Preview https://deploy-preview-357--cncf-techdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@iRaindrop
iRaindrop requested a review from dwelsch-esi June 9, 2026 05:32
@iRaindrop
iRaindrop marked this pull request as draft June 9, 2026 05:39
iRaindrop added 11 commits June 10, 2026 13:30
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Comment thread docs/analysis/templates/analysis.md
Comment thread docs/analysis/templates/analysis.md
Comment thread docs/analysis/criteria.md Outdated
Comment thread docs/analysis/templates/analysis.md

@dwelsch-esi dwelsch-esi left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're taking this opportunity to review and improve the analysis criteria, a couple of overall comments:

  1. The analysis process evaluates against the maturity level (or the proposed maturity level) of the project. We don't explicitly map criteria requirements to maturity level, except briefly for website guidelines. Should we consider revising the criteria document to explictly map leveled criteria to the incubating and graduated levels?

  2. The doc criteria don't include any process requirements. I understand that each project has its own processes, procedures, and culture. (Some process is alluded to, for example with requirements like "Who reviews and approves documentation pull requests?") On the other hand, process is really what a maturity model is about. Should we start thinking about including doc process in the criteria, especially for a graduated project? These would necessarily have to be general principles, adaptable to a range of OSS projects and their methodologies. For example, we ask if the documentation has versions and release notes, but not if the project has a versioning process.

A maintenance question for the CNCF TechDocs analysis docments: We duplicate the criteria in the analysis template. This makes the template easy to use but risks getting the template out of sync with the criteria. Is there a better way to do this?

Comment thread docs/analysis/templates/analysis.md Outdated
Comment thread docs/analysis/templates/analysis.md
Comment thread docs/analysis/templates/analysis.md
Comment thread docs/analysis/criteria.md Outdated
Comment thread docs/analysis/templates/analysis.md
Comment thread docs/analysis/criteria.md Outdated
Comment thread docs/analysis/criteria.md Outdated
Comment thread docs/analysis/criteria.md Outdated
Comment thread docs/analysis/criteria.md

[accessibility]: https://developer.mozilla.org/en-US/docs/Web/Accessibility

### Branding

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't my area, but are all the branding criteria still relevant and important? Are there others that should be added?

Comment thread docs/analysis/criteria.md
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Comment thread docs/analysis/templates/analysis.md
Comment thread docs/analysis/templates/analysis.md Outdated
iRaindrop added 4 commits July 7, 2026 08:46
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Comment thread docs/analysis/criteria.md Outdated
Comment thread docs/analysis/criteria.md
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
@nate-double-u nate-double-u self-assigned this Oct 8, 2026
chalin added 2 commits October 7, 2026 21:11
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
…dates

Signed-off-by: Patrice Chalin <pchalin@gmail.com>

# Conflicts:
#	.htmltest.yml

@chalin chalin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link-check issue should be resolved.

Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The minimum-requirements question conflicts with the template’s mandatory standards.

3 open issues
What changed in this PR

Updates CNCF Techdocs analysis guidance and templates for documentation assessments.

Changes:

  • Adds AI-use disclosure and discoverability criteria.
  • Refines assessment questions and makes implementation plans optional.
  • Adjusts a relative link and the spelling dictionary.
File Description
docs/​analysis/​templates/​analysis.md Updates author guidance, assessment questions, and AI sections.
docs/​analysis/​howto.md Removes a trailing slash from the analyses link.
docs/​analysis/​criteria.md Refines evaluation criteria and adds AI discoverability guidance.
.cspell.yml Allows the term llms.

Review effort: Balanced

Comment thread docs/analysis/criteria.md Outdated
Comment thread docs/analysis/templates/analysis.md Outdated
Comment thread docs/analysis/templates/analysis.md Outdated
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
@iRaindrop
iRaindrop marked this pull request as ready for review October 18, 2026 18:32
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
@nate-double-u
nate-double-u self-requested a review October 20, 2026 00:06
Comment thread docs/analysis/templates/analysis.md Outdated
Comment thread docs/analysis/templates/analysis.md Outdated
iRaindrop and others added 3 commits October 22, 2026 14:01
Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
Comment thread docs/analysis/criteria.md
Comment on lines +411 to +412
The leading proposal for an AI-enabling file for websites is at
[llms-txt](https://llmstxt.org/).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I agree that llms.txt is part of it, do we want to share the new CloMonitory checks here? https://clomonitor.io/docs/topics/checks/#agent-readiness

I think the actual check/evaluation we should do is the AFDocs test: https://afdocs.dev/

Comment thread docs/analysis/criteria.md

- https://kubernetes.io

### AI Optimization and Discoverability

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section is duplicated in docs/analysis/templates/analysis.md

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, as it's a criteria area under Website and Infrastructure and is in sync with the template. Things that the website should do to make AI better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants