22title : Flatcar Documentation Analysis
33tags : [Flatcar]
44created : 2026-02-26
5- modified : 2026-05-05
5+ modified : 2026-05-11
66author : Bruce Hamilton (@iRaindrop)
77---
88
@@ -12,9 +12,9 @@ author: Bruce Hamilton (@iRaindrop)
1212
1313This document is an analysis of the effectiveness and completeness of the
1414[ Flatcar] ( https://www.flatcar.org/docs/latest ) open source software (OSS)
15- project's documentation and website . It is funded by the CNCF Foundation as part
16- of its overall effort to incubate, grow, and graduate open source cloud native
17- software projects.
15+ project's documentation. It is funded by the CNCF Foundation as part of its
16+ overall effort to incubate, grow, and graduate open source cloud native software
17+ projects.
1818
1919According to CNCF best practices guidelines, effective documentation is a
2020prerequisite for program graduation. The documentation analysis is the first
@@ -33,15 +33,15 @@ up by contributors to improve the documentation.
3333
3434This document:
3535
36- - Analyzes the current Flatcar technical documentation and website
36+ - Analyzes the current Flatcar technical documentation
3737- Compares existing documentation against the CNCF’s standards
3838- Recommends a program of key improvements with the largest return on investment
3939
4040### Scope of analysis
4141
42- The documentation discussed here includes the entire contents of the website,
43- the technical documentation, and documentation for contributors and users on the
44- Flatcar GitHub repository.
42+ The documentation discussed here includes the entire contents of the technical
43+ documentation and documentation for contributors and users on the Flatcar GitHub
44+ repository.
4545
4646The Flatcar website and documentation are written in Markdown and are compiled
4747using the Hugo generator with the Flatcar theme and served from a GitHub
@@ -69,8 +69,6 @@ concern:
6969 software, aimed at people who intend to use the project software
7070- ** Contributor documentation:** concerns documentation for new and existing
7171 contributors to the Flatcar OSS project
72- - ** Website:** concerns the mechanics of publishing the documentation, and
73- includes branding, website structure, and maintainability
7472
7573Each section begins with summary ratings based on a rubric with appropriate
7674criteria for the section, then proceeds to:
@@ -97,10 +95,9 @@ to their area of concern:
9795
9896- [ Project documentation] ( #project-documentation )
9997- [ Contributor documentation] ( #contributor-documentation )
100- - [ Website and documentation infrastructure] ( #website-and-infrastructure )
10198
10299Examples of CNCF documentation that demonstrate the analysis criteria are linked
103- from the [ criteria] specification.
100+ from the [ criteria] ( ../../../docs/analysis/criteria.md ) specification.
104101
105102#### Recommendations, requirements, and best practices
106103
@@ -669,213 +666,3 @@ appropriate.
669666The
670667[ Flatcar Project Governance] ( https://github.com/flatcar/Flatcar/blob/main/governance.md )
671668document is comprehensive, and appears well-maintained and up-to-date.
672-
673- ## Website and infrastructure
674-
675- > The analysis for this section is not complete.
676-
677- Flatcar is an ** incubating** project of CNCF. This means that the project should
678- be developing professional-quality documentation alongside the project code.
679-
680- | Criterion | [ Rating (1-5)] |
681- | ------------------------------------------- | -------------- |
682- | Single-source for all files | [ rating (1-5)] |
683- | Meets min website req. (for maturity level) | [ rating (1-5)] |
684- | Usability, accessibility, and design | [ rating (1-5)] |
685- | Branding and design | [ rating (1-5)] |
686- | Case studies/social proof | [ rating (1-5)] |
687- | SEO, Analytics, and site-local search | [ rating (1-5)] |
688- | Maintenance planning | [ rating (1-5)] |
689- | A11y plan & implementation | [ rating (1-5)] |
690- | Mobile-first plan & implementation | [ rating (1-5)] |
691- | HTTPS access & HTTP redirect | [ rating (1-5)] |
692- | Google Analytics 4 for production only | [ rating (1-5)] |
693- | Indexing allowed for production server only | [ rating (1-5)] |
694- | Within site / local search | [ rating (1-5)] |
695- | Account custodians are documented | [ rating (1-5)] |
696-
697- ### Comments
698-
699- > AUTHOR NOTE: make any overall comments about the Website and documentation
700- > infrastructure here.
701-
702- The following sections contain brief assessments of each element of the Website
703- and documentation infrastructure rubric.
704-
705- > AUTHOR NOTE: for each heading below, discuss how well the in-scope items meet
706- > these criteria. Keep in mind that much of the website infrastructure criteria
707- > depend on the tools (static site generator, website framework and hosting,
708- > analytics tools, etc.) and processes (project CI, release procedures,
709- > governance, etc.) used to produce the documentation. (Criteria are copied from
710- > criteria.md)
711-
712- #### Single-source requirement
713-
714- Source files for _ all website pages_ should reside in a single repo. Among other
715- problems, keeping source files in two places:
716-
717- - confuses contributors
718- - requires you to keep two sources in sync
719- - increases the likelihood of errors
720- - makes it more complicated to generate the documentation from source files
721-
722- Ideally, all website files should be in the ** website repo** itself.
723- Alternatively, files should be brought into the website repo via [ git
724- submodules] [ git-submodules ] .
725-
726- If a project chooses to keep source files in multiple repos, they need a clearly
727- documented strategy for managing mirrored files and new contributions.
728-
729- #### Minimal website requirements
730-
731- Listed here are the minimal website requirements for projects based on their
732- [ maturity level] [ maturity-level ] , either incubating or graduated. (These are the
733- only two levels for which a tech docs analysis can be requested.)
734-
735- <!-- markdownlint-disable line-length -->
736-
737- | Criterion | Incubating Requirement | Graduated Requirement |
738- | ----------------------------- | ------------------------------------------------------- | ----------------------------------------- |
739- | [ Website guidelines] | All guidelines satisfied | All guidelines satisfied |
740- | ** Docs analysis** (this) | Requested through CNCF [ service desk] [ cncf-servicedesk ] | All follow-up actions addressed |
741- | ** Project doc** : stakeholders | Roles identified and doc needs documented | All stakeholder need identified |
742- | ** Project doc** : hosting | Hosted directly | All Hosted directly |
743- | ** Project doc** : user docs | Comprehensive, addressing most stakeholder needs | Fully addresses needs of key stakeholders |
744-
745- <!-- markdownlint-enable line-length -->
746-
747- [ git-submodules ] : https://git-scm.com/book/en/v2/Git-Tools-Submodules
748- [ maturity-level] :
749- https://github.com/cncf/toc/tree/main/process#ii-stages---definitions--expectations
750- [ cncf-servicedesk ] : https://servicedesk.cncf.io
751-
752- #### Usability, accessibility and devices
753-
754- Most CNCF websites are accessed from mobile and other non-desktop devices at
755- least 10-20% of the time. Planning for this early in your website's design will
756- be much less effort than retrofitting a desktop-first design.
757-
758- - Is the website usable from mobile?
759- - Are doc pages readable?
760- - Are all / most website features accessible from mobile -- such as the top-nav,
761- site search and in-page table of contents?
762- - Might a [ mobile-first] design make sense for your project?
763-
764- [ mobile-first] :
765- https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Responsive/Mobile_first
766-
767- Plan for suitable [ accessibility] [ ] measures for your website. For example:
768-
769- - Are color contrasts significant enough for color-impaired readers?
770- - Are most website features usable using a keyboard only?
771- - Does text-to-speech offer listeners a good experience?
772-
773- It is up to each project to set their own guidelines.
774-
775- [ accessibility ] : https://developer.mozilla.org/en-US/docs/Web/Accessibility
776-
777- #### Branding and design
778-
779- CNCF seeks to support enterprise-ready open source software. A key aspect of
780- this is branding and marketing.
781-
782- We evaluate on the following:
783-
784- - Is there an easily recognizable brand for the project (logo + color scheme)
785- clearly identifiable?
786- - Is the brand used across the website consistently?
787- - The website’s typography clean and well-suited for reading?
788-
789- #### Case studies/social proof
790-
791- One of the best ways to advertise an open source project is to show other
792- organizations using it.
793-
794- We evaluate on the following:
795-
796- - Are there case studies available for the project and are they documented on
797- the website?
798- - Are there user testimonials available?
799- - Is there an active project blog?
800- - Are there community talks for the project and are they present on the website?
801- - Is there a logo wall of users/participating organizations?
802-
803- #### SEO, Analytics and site-local search
804-
805- SEO helps users find your project, and it's documentation, and analytics helps
806- you monitor site traffic and diagnose issues like page 404s. Intra-site search,
807- while optional, can offer your readers a site-focused search results.
808-
809- We evaluate on the following:
810-
811- - Analytics:
812- - Is analytics enabled for the production server?
813- - Is analytics disabled for all other deploys?
814- - If your project used Google Analytics, have you migrated to GA4?
815- - Can Page-not-found (404) reports easily be generated from your site
816- analytics? Provide a sample of the site's current top-10 404s.
817- - Is site indexing supported for the production server, while disabled for
818- website previews and builds for non-default branches?
819- - Is local intra-site search available from the website?
820- - Are the current custodian(s) of the following accounts clearly documented:
821- analytics, Google Search Console, site-search (such as Google CSE or Algolia)
822-
823- #### Maintenance planning
824-
825- Website maintenance is an important part of project success, especially when
826- project maintainers aren’t web developers.
827-
828- We evaluate on the following:
829-
830- - Is your website tooling well-supported by the community (i.e., Hugo with the
831- Docsy theme) or commonly used by CNCF projects (our recommended tech stack?)
832- - Are you actively cultivating website maintainers from within the community?
833- - Are site build times reasonable?
834- - Do site maintainers have adequate permissions?
835-
836- #### Other
837-
838- - Is your website accessible via HTTPS? Yes
839- - Does HTTP access, if any, redirect to HTTPS? Yes
840-
841- ### Recommendations
842-
843- > AUTHOR NOTE: Write general recommendations based on the comments from the
844- > previous section.
845-
846- #### Single-source requirement
847-
848- #### Minimal website requirements
849-
850- #### Usability, accessibility and devices
851-
852- #### Branding and design
853-
854- #### Case studies/social proof
855-
856- #### SEO, Analytics and site-local search
857-
858- #### Maintenance planning
859-
860- #### Other
861-
862- #### References and notes
863-
864- ##### Rating values
865-
866- The numeric rating values used in this document are as follows
867-
868- 1 . Not present
869- 2 . Needs improvement
870- 3 . Meets standards
871- 4 . Meets or exceeds standards
872- 5 . Exemplary
873-
874- <!--
875- [criteria]: ../../../docs/criteria.md
876- [implementation]: ./implementation.md
877- [issues list]: ./issues-list.md
878- [project-website]: _PROJECT-WEBSITE_
879- [Rating (1-5)]: #rating-values
880- [rfc-spec]: https://www.rfc-editor.org/rfc/rfc2119
881- [website guidelines]: ../../website-guidelines-checklist.md -->
0 commit comments