@@ -43,8 +43,8 @@ the technical documentation, and documentation for contributors and users on the
4343Flatcar GitHub repository.
4444
4545The Flatcar website and documentation are written in Markdown and are compiled
46- using the "static site" generator with the " theme" and served from "platform".
47- The site's code is stored on the Flatcar GitHub repo.
46+ using the Hugo generator with the Flatcar theme and served from a GitHub
47+ repository. The site's code is stored on the Flatcar GitHub repo.
4848
4949#### In scope
5050
@@ -117,11 +117,11 @@ be developing professional-quality documentation alongside the project code.
117117
118118| Criterion | [ Rating (1-5)] |
119119| -------------------------- | -------------- |
120- | Information architecture | [ rating (1-5) ] |
121- | New user content | [ rating (1-5) ] |
122- | Content maintainability | [ rating (1-5) ] |
123- | Content creation processes | [ rating (1-5) ] |
124- | Inclusive language | [ rating (1-5) ] |
120+ | Information architecture | 3 |
121+ | New user content | 3 |
122+ | Content maintainability | 4 |
123+ | Content creation processes | 4 |
124+ | Inclusive language | 4 |
125125
126126### Comments
127127
@@ -343,15 +343,15 @@ repository, formatting, and style.
343343- ** Does your code release process account for documentation creation &
344344 updates?**
345345
346- Supported, but not a formalized process at this time .
346+ The team regularly updates content as the project is incubating .
347347
348348- ** Who reviews and approves documentation pull requests?**
349349
350- Team members are determined .
350+ Maintainers delegate doc approval to experienced code contributors .
351351
352352- ** Does the website have a clear owner/maintainer?**
353353
354- Team members are determined .
354+ Yes .
355355
356356##### Inclusive language
357357
@@ -368,8 +368,7 @@ those only "abort" would necessitate a fix on eight occurrences.
368368
369369- ** Does the project use language like "simple", "easy", etc.?**
370370
371- No, the complexity of the content is a given, and the content assumes a level of
372- sophistication where such verbiage would be suspicious.
371+ Yes, there are such occurrences to flag and rewrite.
373372
374373### Recommendations
375374
@@ -409,30 +408,14 @@ For a Getting Started node. Titles are preliminary.
409408 areas for Flatcar. While these could be under a broader umbrella, such as
410409 Operations, I think that nine or headings in the navigation bar is not too
411410 much, and speeds up discovery. Given a list of about 60 tools, technologies,
412- etc., Copilot devised the following categories with descriptions :
411+ etc., Copilot devised the following categories:
413412
414- Virtualization & Hypervisors Technologies used to run Flatcar as a VM.
413+ Virtualization & Hypervisors Cloud & Hosting Platforms Bare Metal, Booting &
414+ Installation Security & Compliance Security Storage & File systems System
415+ Services & OS Internals Provisioning, Configuration & Automation Container &
416+ Orchestration
415417
416- Cloud & Hosting Platforms Providers where Flatcar can be deployed.
417-
418- Bare Metal, Booting & Installation Tools and technologies involved in
419- provisioning, booting, or installing Flatcar.
420-
421- Security & Compliance Security frameworks, encryption, authentication, and
422- compliance features.
423-
424- Storage & Filesystems Filesystems, storage layers, and related tooling.
425-
426- System Services & OS Internals Core OS components and Linux/Flatcar system
427- management.
428-
429- Provisioning, Configuration & Automation Tools for configuring, deploying, or
430- automating Flatcar systems.
431-
432- Container & Orchestration Ecosystem Container runtimes, orchestration systems,
433- and distributed components.
434-
435- Work with the team to devise the structure and keep to it!
418+ Work with the team to devise the categories and keep to it!
436419
437420#### New user content
438421
0 commit comments