Skip to content

Analysis templates suggested updates#357

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

Analysis templates suggested updates#357
iRaindrop wants to merge 13 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 3dcf00a
🔍 Latest deploy log https://app.netlify.com/projects/cncf-techdocs/deploys/6a2a0db6513de70008fcd516
😎 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>
users needing more help? (FAQ, Troubleshooting)
- If the product exposes an API, is there a complete reference?
- Is content up to date and accurate?

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.

Consider adding for information architecture:

  • Are prerequisites consistent in quickstarts and install topics? Consider consolidating if applicable.
  • Are there instructions on how to install something that is better served by linking to official documentation?
  • Is there content in other places that would be helpful for getting started content.


Replace link placeholders in brackets, such as [_PROJECT_][project-website],
with the actual link surrounded by parenthesis.

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.

I added this. Remove if you think its not needed.

Comment thread docs/analysis/criteria.md
[Inclusive Naming Initiative](https://inclusivenaming.org) website?
- Does the project use language like "simple", "easy", etc.?

### AI Optimization and Discoverability

@iRaindrop iRaindrop Jun 11, 2026

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.

New section. Please opine.

UPDATE: Nate and I discussed this and agreed it would be better in a separate topic. @nate-double-u - how about naming it ai-guidance.md?


#### Project governance documentation

## Website and infrastructure

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.

We can consider removing Website and infrastructure as writers only have minimal info or context to complete, and Nate has ok'd not including it.

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 is situational. In some cases the website and infrastructure review is warranted, in other cases I'm OK dropping it.

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.

2 participants