Repository navigation
Conversation
Signed-off-by: Bruce Hamilton <[email protected]>
✅ Deploy Preview for cncf-techdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
dwelsch-esi
left a comment
There was a problem hiding this comment.
Since we're taking this opportunity to review and improve the analysis criteria, a couple of overall comments:
-
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?
-
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?
|
|
||
| [accessibility]: https://developer.mozilla.org/en-US/docs/Web/Accessibility | ||
|
|
||
| ### Branding |
There was a problem hiding this comment.
This isn't my area, but are all the branding criteria still relevant and important? Are there others that should be added?
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Patrice Chalin <[email protected]>
Signed-off-by: Patrice Chalin <[email protected]>
…dates Signed-off-by: Patrice Chalin <[email protected]> # Conflicts: # .htmltest.yml
chalin
left a comment
There was a problem hiding this comment.
Link-check issue should be resolved.
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
There was a problem hiding this comment.
🟡 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
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Co-authored-by: Dave Welsch <[email protected]> Signed-off-by: Bruce Hamilton <[email protected]>
Co-authored-by: Dave Welsch <[email protected]> Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Co-authored-by: Dave Welsch <[email protected]> Signed-off-by: Nate W <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>

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