Skip to content

Commit

Permalink
Update criteria.md
Browse files Browse the repository at this point in the history
Fix MD linter and line-length errors.

Signed-off-by: Dave Welsch <[email protected]>
  • Loading branch information
dwelsch-esi authored Jul 25, 2024
1 parent b8f9d22 commit ab5c0ca
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/analysis/criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ specifically for them. We evaluate on the following:
top of your information architecture?
- Is there easily copy-pastable sample code or other example content?


<!-- markdownlint-enable line-length -->
<!-- cSpell:ignore OSes copy-pastable Algolia Docsy -->

Example:

- <https://falco.org/docs/getting-started/>
Expand Down Expand Up @@ -186,14 +190,15 @@ requirements for sandbox projects.
- **Project documentation** may or may not be present -- it is acceptable at
this maturity level to link out to documentation that hasn't yet been
integrated into the website
- _Example_: website with a single homepage, without any documentation or, as
was mentioned above, linking out to an external (preexisting) source for
- _Example_: website with a single homepage, without any documentation or,
as was mentioned above, linking out to an external (preexisting) source for
docs
- _However_: consider reading the recommended practices in this repository and
implementing as many of the best practices as you can. This groundwork will pay
big dividends later when you need to upgrade your practices and update your
documentation as an incubating project. Assistance is available from CNCF
TechDocs anytime, including answers to individual questions or a documentation workshop.
- _However_: consider reading the recommended practices in this repository
and implementing as many of the best practices as you can. This groundwork
will pay big dividends later when you need to upgrade your practices and
update your documentation as an incubating project. Assistance is available
from CNCF TechDocs anytime, including answers to individual questions or a
documentation workshop.
- **Incubating**
- [Website guidelines][]: all guidelines are satisfied.
- [Docs assessment][]: request an (re-)assessment through the CNCF [service
Expand Down

0 comments on commit ab5c0ca

Please sign in to comment.