Flatcar docs analysis - writing and updates#349
Open
Flatcar docs analysis - writing and updates#349
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]>
chalin
reviewed
Apr 16, 2026
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
… into flatcar-analysis-2
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]>
iRaindrop
force-pushed
the
flatcar-analysis-2
branch
from
e1397f1 to
2e5f52b
Compare
… into flatcar-analysis-2
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]>
chalin
reviewed
Apr 21, 2026
Co-authored-by: Patrice Chalin <[email protected]> Signed-off-by: Bruce Hamilton <[email protected]>
Collaborator
|
Btw, @iRaindrop, you can see the preview at https://deploy-preview-349--cncf-techdocs.netlify.app/analyses/2026/flatcar/analysis/ |
added 2 commits
April 22, 2026 22:26
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
added 10 commits
April 26, 2026 20:57
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
reviewed
Apr 30, 2026
Comment on lines
+314
to
+317
| Use AI and your own research to gather key concepts and common procedures that | ||
| each of the subtopics have so that the overview contains the conceptual guidance | ||
| and common tasks that need not be repeated by the subtopics. Copilot also | ||
| offered to write the overview draft from which good ideas could be gleaned. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Use AI and your own research to gather key concepts and common procedures that | |
| each of the subtopics have so that the overview contains the conceptual guidance | |
| and common tasks that need not be repeated by the subtopics. Copilot also | |
| offered to write the overview draft from which good ideas could be gleaned. | |
| Document key concepts that are common to each subtopic in the topic overview. | |
| Consider consolidating common procedures into one procedure that works for all the subtopics. | |
| (This only works if the variations in the procedure are minimal.) ``` | |
| I'd be wary of pulling out common procedures. Unless they're identical every time and you provide | |
| a link in each platform-specific topic, this will get messy. That said, it's a judgement call whether | |
| it's worse to redirect the user in the middle of a procedure, to include variations in inline sub-procedures, | |
| or to cut and paste boilerplate text. | |
| Common background or conceptual information absolutely belongs in the introduction. | |
| Again, recommend the solution, not the implementation. |
| and common tasks that need not be repeated by the subtopics. Copilot also | ||
| offered to write the overview draft from which good ideas could be gleaned. | ||
|
|
||
| ## Consolidate Concepts in the Cloud Providers Overview |
Collaborator
There was a problem hiding this comment.
See comments in "Consolidate Concepts in Virtual Machines Overview".
| and common tasks that need not be repeated by the subtopics. Copilot also | ||
| offered to write the overview draft from which good ideas could be gleaned. | ||
|
|
||
| ## Consolidate Concepts in the Bare Metal Overview |
Collaborator
There was a problem hiding this comment.
See comments in "Consolidate Concepts in Virtual Machines Overview".
dwelsch-esi
reviewed
Apr 30, 2026
Collaborator
dwelsch-esi
left a comment
dwelsch-esi
left a comment
There was a problem hiding this comment.
Good job! See individual comments.
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]>
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]>
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]>
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
reviewed
May 1, 2026
Comment on lines
+29
to
+30
| outlines an actionable plan for improvement. A third document is an **issues | ||
| list** of issues to be added to the project documentation repository. These |
Collaborator
There was a problem hiding this comment.
If you're skipping the implementation doc, remove mention of it.
dwelsch-esi
reviewed
May 1, 2026
|
|
||
| Readers interested only in actionable improvements should skip this document and | ||
| read the [implementation][] plan and [issues list][]. | ||
| read the **implementation plan** and **issues list**. |
dwelsch-esi
reviewed
May 1, 2026
Comment on lines
+121
to
+127
| | Criterion | [Rating (1-5)] | | ||
| | -------------------------------------------------------- | -------------- | | ||
| | Information architecture meets expectations | 3 | | ||
| | New user content meets expectations | 3 | | ||
| | Content maintainability meets expectations | 3 | | ||
| | Content creation processes meets or exceeds expectations | 3 | | ||
| | Inclusive language meets or exceeds expectations | 4 | |
Collaborator
There was a problem hiding this comment.
I think putting the definition next to the number makes the table cleaner and more understandable.
Signed-off-by: Bruce Hamilton <[email protected]>
Signed-off-by: Bruce Hamilton <[email protected]>
Collaborator
Author
|
@nate-double-u - ready to merge |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Completing the Contributor Docs and Website portions of the analysis.