22title : Flatcar Documentation Analysis
33tags : [Flatcar]
44created : 2026-02-26
5- modified : 2026-04-30
5+ modified : 2026-05-05
66author : Bruce Hamilton (@iRaindrop)
77---
88
@@ -119,13 +119,13 @@ to legal requirements such as copyright and licensing issues.
119119Flatcar is an ** incubating** project of CNCF. This means that the project should
120120be developing professional-quality documentation alongside the project code.
121121
122- | Criterion | [ Rating (1-5) ] |
123- | -------------------------------------------------------- | -------------- |
124- | Information architecture meets expectations | 3 |
125- | New user content meets expectations | 3 |
126- | Content maintainability meets expectations | 3 |
127- | Content creation processes meets or exceeds expectations | 3 |
128- | Inclusive language meets or exceeds expectations | 4 |
122+ | Criterion | Rating (1-5) |
123+ | -------------------------------- | --------------------- |
124+ | Information architecture | 2 - Needs improvement |
125+ | New user content | 2 - Needs improvement |
126+ | Content maintainability | 2 - Needs improvement |
127+ | Content creation processes meets | 2 - Needs improvement |
128+ | Inclusive language | 3 - Meets standards |
129129
130130### Comments
131131
@@ -143,7 +143,10 @@ of contents:
143143- The top "Flatcar Container Linux" page contains references and links that
144144 appear to refer to an alternate version of the TOC. While its good to provide
145145 quick links, the user wonders whether the TOC node references the same
146- content, or if the links in the overview (right side) are supplemental.
146+ content, or if the links in the overview (right side) are supplemental. On
147+ mobile the left-side TOC is not available, so the links in this overview serve
148+ as the navigation.
149+
147150- The "Installing" node contains the large "Cloud Providers" node, which might
148151 be better as top tier node. The same with "Bare Metal". The team agrees that
149152 "Community supported platforms" could be merged into the "Cloud Providers"
@@ -471,12 +474,12 @@ the best arbiters of what changes are appropriate to the project.
471474Flatcar is an ** incubating** project of CNCF. This means that the project should
472475be developing professional-quality documentation alongside the project code.
473476
474- | Criterion | [ Rating (1-5)] |
475- | ----------------------------------------- | -------------- |
476- | Communication methods documented | 3 |
477- | Beginner friendly issue backlog | 4 |
478- | “New contributor” getting started content | 3 |
479- | Project governance documentation | 4 |
477+ | Criterion | Rating (1-5) |
478+ | ----------------------------------------- | --------------------- |
479+ | Communication methods documented | 3 - meets standards |
480+ | Beginner friendly issue backlog | 2 - needs improvement |
481+ | “New contributor” getting started content | 2 - needs improvement |
482+ | Project governance documentation | 4 - meets standards |
480483
481484### Comments
482485
@@ -593,8 +596,8 @@ We evaluate on the following:
593596 contribution?**
594597
595598 Yes. There is a
596- [ How to contribute] ( https://www.flatcar.org/docs/latest/contribute/ ) node at
597- the bottom of the navigation tree, and contains guidance on making pull
599+ [ How to contribute] ( https://www.flatcar.org/docs/latest/contribute/ ) section
600+ at the bottom of the navigation tree, and contains guidance on making pull
598601 requests in the Flatcar GitHub repository. Also included is guidance style and
599602 formatting with links to style guides.
600603
@@ -643,15 +646,33 @@ project evolves, the following recommendations should be considered:
643646
644647#### Communication methods documented
645648
649+ Information is well documented and discoverable from the repository's
650+ [ Contributing] ( https://github.com/flatcar/Flatcar/blob/main/CONTRIBUTING.md ) and
651+ [ Onboarding] ( https://github.com/flatcar/Flatcar/blob/main/ONBOARDING.md ) guides
652+ linked to from the README file.
653+
646654#### Beginner-friendly issue backlog
647655
656+ Suggest adding a link to documentation issues in the Contributing guide's
657+ [ Finding Issues] ( https://github.com/flatcar/Flatcar/blob/main/CONTRIBUTING.md#finding-issues )
658+ section.
659+
648660#### New contributor getting started content
649661
662+ The team plans to expand the guidance in
663+ [ How to contribute] ( https://www.flatcar.org/docs/latest/contribute/ ) section on
664+ the website to parallel the guidance in the repository's Contributing guide as
665+ appropriate.
666+
650667#### Project governance documentation
651668
669+ The
670+ [ Flatcar Project Governance] ( https://github.com/flatcar/Flatcar/blob/main/governance.md )
671+ document is comprehensive, and appears well-maintained and up-to-date.
672+
652673## Website and infrastructure
653674
654- > AUTHOR NOTE: Pick the CNCF maturity level of the project:
675+ > The analysis for this section is not complete.
655676
656677Flatcar is an ** incubating** project of CNCF. This means that the project should
657678be developing professional-quality documentation alongside the project code.
0 commit comments