11# Assessment criteria and examples
22
33We recommend reading the
4- [ CNCF sandbox project documentation primer] ( ../sandbox-doc-primer.md )
5- before reviewing these criteria. The primer contains key definitions concepts
6- that are referred to in the criteria.
4+ [ CNCF sandbox project documentation primer] ( ../sandbox-doc-primer.md ) before
5+ reviewing these criteria. The primer contains key definitions concepts that are
6+ referred to in the criteria.
77
88## Project documentation
99
1010### Information architecture
1111
12- How your technical information is organized, laid out, and presented.
13- This includes structure (pages/subpages/sections/subsections), information
14- types (conceptual/instructional/reference), and matching documentation
15- content to user expectations.
12+ How your technical information is organized, laid out, and presented. This
13+ includes structure (pages/subpages/sections/subsections), information types
14+ (conceptual/instructional/reference), and matching documentation content to user
15+ expectations.
1616
1717We evaluate on the following:
1818
@@ -217,10 +217,9 @@ Listed here are the _minimal_ website requirements for projects based on their
217217
218218We evaluate on the following:
219219
220- * Note : Except for archived projects, requirements are cumulative through project
220+ _ Note : Except for archived projects, requirements are cumulative through project
221221maturity levels so, for example, incubating projects must satisfy the
222- requirements for sandbox projects.*
223-
222+ requirements for sandbox projects._
224223
225224#### Sandbox
226225
@@ -232,19 +231,21 @@ requirements for sandbox projects.*
232231 - Corporate sponsorship and support
233232 - Copyright and trademark
234233 - Community standards
235- - ** Plan ahead** : projects must meet all guidelines before being promoted to Incubating status.
236- - Is there rudimentary ** project documentation** , or a placeholder or substitute?
234+ - ** Plan ahead** : projects must meet all guidelines before being promoted to
235+ Incubating status.
236+ - Is there rudimentary ** project documentation** , or a placeholder or
237+ substitute?
237238 - It is acceptable at this maturity level to link out to documentation that
238239 hasn't yet been integrated into the website.
239- - _ Example_ : website with a single homepage, without any documentation or,
240- as was mentioned above, linking out to an external (preexisting) source
241- for docs.
242- - _ However_ : consider reading the recommended practices in this repository
243- and implementing as many of the best practices as you can. This groundwork
244- will pay big dividends later when you need to upgrade your practices and
245- update your documentation as an incubating project. Assistance is
246- available from CNCF TechDocs anytime, including answers to individual
247- questions or a documentation workshop.
240+ - _ Example_ : website with a single homepage, without any documentation or, as
241+ was mentioned above, linking out to an external (preexisting) source for
242+ docs.
243+ - _ However_ : consider reading the recommended practices in this repository and
244+ implementing as many of the best practices as you can. This groundwork will
245+ pay big dividends later when you need to upgrade your practices and update
246+ your documentation as an incubating project. Assistance is available from
247+ CNCF TechDocs anytime, including answers to individual questions or a
248+ documentation workshop.
248249
249250#### Incubating
250251
@@ -266,8 +267,8 @@ requirements for sandbox projects.*
266267#### Archived
267268
268269- Is the website repo in an [ archived state] [ ] ?
269- - Is the archived status of the project obvious to those visiting the
270- website, such as through the use of a prominent banner?
270+ - Is the archived status of the project obvious to those visiting the website,
271+ such as through the use of a prominent banner?
271272- If a successor project exists, are there links to its website and/or migration
272273 documentation.
273274
@@ -335,8 +336,7 @@ organizations using it.
335336
336337We evaluate on the following:
337338
338- - Are there case studies available for the project and are they documented
339- on
339+ - Are there case studies available for the project and are they documented on
340340 the website?
341341- Are there user testimonials available?
342342- Is there an active project blog?
0 commit comments