Skip to content

Commit 253d704

Browse files
author
Bruce Hamilton
committed
ran prittier
Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com>
1 parent 5979b0b commit 253d704

1 file changed

Lines changed: 45 additions & 29 deletions

File tree

analyses/2026/flatcar/analysis.md

Lines changed: 45 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,11 @@ The current Flatcar documentation navigation structure, table of contents,
135135
defines the needed areas of knowledge to install and provision Flatcar, but it
136136
does not readily show the different paths for new users depending on their
137137
environment and expectations. However, the initial structures of documentation
138-
sets such as Flatcar reflect the understanding, passions, and motivations of the team.
138+
sets such as Flatcar reflect the understanding, passions, and motivations of the
139+
team.
139140

140-
The following comments are in regard to the top-tier nodes in the current table of
141-
contents:
141+
The following comments are in regard to the top-tier nodes in the current table
142+
of contents:
142143

143144
- The top "Flatcar Container Linux" page contains references and links that
144145
appear to an alternate version of the table of contents. While its good to
@@ -156,8 +157,8 @@ contents:
156157
of the docs relate to this section.
157158
- The "Nebraska" node is about updates, but a top node should convey the
158159
functionality rather than a product name.
159-
- The "Setup and Operations" node casts too much of a wide net in its heading. How
160-
does "setup" differ from installation? The node contains several important
160+
- The "Setup and Operations" node casts too much of a wide net in its heading.
161+
How does "setup" differ from installation? The node contains several important
161162
content areas that should be more discoverable, for instance:
162163
- "Managing Clusters" might be better at a higher level because it's an
163164
initial evaluation in deploying Flatcar.
@@ -171,27 +172,27 @@ contents:
171172
- The "Migrating from CoreOS" node might be better placed earlier or within an
172173
Installation node, as it is an installation scenario.
173174
- The "Reference" node contains expected look-up information such as "Constants
174-
and IDs" and "Supply chain security mechanisms" but these sections
175-
could be better placed:
175+
and IDs" and "Supply chain security mechanisms" but these sections could be
176+
better placed:
176177
- "Integrations" could be incorporated into the Cloud Providers documentation.
177178
- "Developer Guides" contains conceptual content typically not found in a
178179
Reference section and would be better as a top-tier node.
179180
- The "How to Contribute" node is well-placed and has the expected content.
180181

181182
The documentation also includes an FAQ, accessible from the top banner of the
182-
home page. This FAQ has some content that could also be in the docs, such as historical context and how images are updated.
183-
Conversely, there should be a few top-of-mind installation and support FAQ items
184-
derived from the docs.
183+
home page. This FAQ has some content that could also be in the docs, such as
184+
historical context and how images are updated. Conversely, there should be a few
185+
top-of-mind installation and support FAQ items derived from the docs.
185186

186187
Code blocks are different from other documentation sets as they are not
187188
bordered, don't have a different fill background, don't have a copy button, and
188189
the language is not indicated. There is already a GitHub issue on this.
189190

190-
In several topics, new users might not be sure of the context for a given block of code. Is the
191-
Linux prompt in a VM, in a client computer, or in a CLI session with a cloud
192-
provider? Normally this can be reinforced by the narrative, such as starting a
193-
procedure with "In the VM window, use the following command to ..." or similar
194-
guidance.
191+
In several topics, new users might not be sure of the context for a given block
192+
of code. Is the Linux prompt in a VM, in a client computer, or in a CLI session
193+
with a cloud provider? Normally this can be reinforced by the narrative, such as
194+
starting a procedure with "In the VM window, use the following command to ..."
195+
or similar guidance.
195196

196197
In pages with code examples the narrative follows a casual and conversational
197198
flow, introducing the steps such as "First do this", show a block of code,
@@ -229,7 +230,8 @@ and configuring Flatcar.
229230

230231
- **Is the documentation feature complete?**
231232

232-
There are issues to document how to use Flatcar with particular providers and tools.
233+
There are issues to document how to use Flatcar with particular providers and
234+
tools.
233235

234236
- **Are there step-by-step instructions (tasks, tutorials) documented for
235237
features?**
@@ -302,7 +304,8 @@ specifically for them. We evaluate on the following:
302304
copy-pasted?**
303305

304306
Yes, most pages have code samples, but currently the UI does not show code
305-
example blocks with copy buttons. The code is simply in a different font. There is a GitHub issue to fix this.
307+
example blocks with copy buttons. The code is simply in a different font.
308+
There is a GitHub issue to fix this.
306309

307310
##### Content maintainability & site mechanics
308311

@@ -472,12 +475,17 @@ Contributor Documentation rubric.
472475
One of the easiest ways to attract new contributors is making sure they know how
473476
to reach you.
474477

475-
The Flatcar team casts a wide net for gathering feedback and contributions. Their effort spans documentation, code, community platforms, Flatcar apps, blogs, presentations, workshops, bug fixing events, developer challenges, and web design workshops.
478+
The Flatcar team casts a wide net for gathering feedback and contributions.
479+
Their effort spans documentation, code, community platforms, Flatcar apps,
480+
blogs, presentations, workshops, bug fixing events, developer challenges, and
481+
web design workshops.
476482

477483
The team provides links to aggregated GitHub issues for newcomers and advanced
478484
users to work on.
479485

480-
The team encourages users to create a Flatcar app, a reference implementation showing how to run a specific service on Flatcar, as a compelling way learn Flatcar and help the user community.
486+
The team encourages users to create a Flatcar app, a reference implementation
487+
showing how to run a specific service on Flatcar, as a compelling way learn
488+
Flatcar and help the user community.
481489

482490
We evaluate on the following:
483491

@@ -488,17 +496,19 @@ We evaluate on the following:
488496

489497
Chats:
490498
- Matrix: https://app.element.io/#/room/#flatcar:matrix.org
491-
- Slack: https://kubernetes.slack.com/archives/C03GQ8B5XNJ
499+
- Slack: https://kubernetes.slack.com/archives/C03GQ8B5XNJ
492500

493501
Social media:
494502
- Mastodon: https://hachyderm.io/@flatcar
495503
- X: https://x.com/flatcar
496504

497505
- **Is there a direct link to your GitHub organization/repository?**
498506

499-
Not from the `flatacar.org` website, but listed in the README file of the Flatcar GitHub repository.
507+
Not from the `flatacar.org` website, but listed in the README file of the
508+
Flatcar GitHub repository.
500509

501-
- **Are project meetings documented? Is it clear how someone can join those meetings?**
510+
- **Are project meetings documented? Is it clear how someone can join those
511+
meetings?**
502512

503513
Yes. Office Hours are promoted and scheduled monthly.
504514
- When: 2nd Wednesday of every month at 2:30pm UTC
@@ -526,17 +536,21 @@ We evaluate on the following:
526536
Yes, this URL shows doc issues being tracked in GitHub:
527537
https://github.com/flatcar/Flatcar/issues?q=state%3Aopen%20label%3Akind%2Fdocs
528538

529-
- **Is it easy for new contributors to make contributions (i.e. a “good first issue” label)?**
539+
- **Is it easy for new contributors to make contributions (i.e. a “good first
540+
issue” label)?**
530541

531-
The Contributing Guide, https://github.com/flatcar/Flatcar/blob/main/CONTRIBUTING.md, linked from the repository README file welcomes new contributors. The "Finding issues" subsection has these helpful links:
532-
533-
- **Good first issue** - Displays pages of coding and documentation tasks marked `good first issue` in DevOps. These issues have guidance to help newcomers with the task.
542+
The Contributing Guide,
543+
https://github.com/flatcar/Flatcar/blob/main/CONTRIBUTING.md, linked from the
544+
repository README file welcomes new contributors. The "Finding issues"
545+
subsection has these helpful links:
546+
- **Good first issue** - Displays pages of coding and documentation tasks
547+
marked `good first issue` in DevOps. These issues have guidance to help
548+
newcomers with the task.
534549
- **Help wanted issues** - suitable for non-core maintainers.
535550

536551
Each documentation page has these two links at the bottom:
537-
538552
- **Edit this page** - link the opens the page for editing in GitHub if a fork
539-
exists, otherwise shows the option to fork the repository.
553+
exists, otherwise shows the option to fork the repository.
540554
- **File documentation issue** - link opens a new GitHub issue.
541555

542556
- **Are issues well-documented (i.e., more than just a title)?**
@@ -591,7 +605,9 @@ We evaluate on the following:
591605

592606
Yes,
593607
[Flatcar Project Governance](https://github.com/flatcar/Flatcar/blob/main/governance.md)
594-
document projects values of openness, fairness, community, inclusivity, and participation. For an incubating project, Flatcar is laying the foundation for vigorous community participation.
608+
document projects values of openness, fairness, community, inclusivity, and
609+
participation. For an incubating project, Flatcar is laying the foundation for
610+
vigorous community participation.
595611

596612
### Recommendations
597613

0 commit comments

Comments
 (0)