Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "min requirements" for websites based on proj maturity level #84

Merged
merged 1 commit into from
Nov 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions assessments/criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,51 @@ documented strategy for managing mirrored files and new contributions.
[otel-changes-lost]: https://github.com/open-telemetry/opentelemetry.io/issues/673
[git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules

### Minimal website requirements

Listed here are the _minimal_ website requirements for projects based on their
[maturity level][]: sandbox, incubating, graduated and archived.

Except for archived projects, requirements are cumulative through project
maturity levels so, for example, incubating projects must satisfy the
requirements for sandbox projects.

- **Sandbox**
- [Website guidelines][]: majority of the guidelines are satisfied
- [Docs assessment][]: consider [submitting a request][service desk] for an
assessment as early as possible to avoid documentation and website rework.
- **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
docs
- **Incubating**
- [Website guidelines][]: all guidelines are satisfied.
- [Docs assessment][]: request an (re-)assessment through the CNCF [service
desk][]
- **Project documentation**:
- Stakeholders / personas are identified and their core needs (in terms of
docs) documented
- Hosted directly on the website (also see [Single-source requirement])
- Comprehensive, addressing most stakeholder needs
- **Graduated**
- [Docs assessment][]: follow-through actions from any assessment are complete
- **Project documentation** fully addresses the needs of key stakeholders
- **Archived**
- The website repo is in an [archived state][]
- The archived status of the project must be obvious to those visiting the
website, such as through the use of a prominent banner.
- If a successor project exists, link to it's website and/or migration
documentation.

[archived state]: https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories
[docs assessment]: /assessments/howto.md
[maturity level]: https://github.com/cncf/toc/tree/main/process#ii-stages---definitions--expectations
[service desk]: https://servicedesk.cncf.io
[single-source requirement]: #single-source-requirement
[website guidelines]: /howto/website-guidelines-checklist.md

### Usability, accessibility and devices

Most CNCF websites are accessed from mobile and other non-desktop devices at
Expand Down
19 changes: 10 additions & 9 deletions assessments/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,16 @@ _Provide a list of recommendations to improve in this area_

## Website

| Criteria | 1 | 2 | 3 | 4 | 5 |
| --- | --- | --- | --- | --- | --- |
| Single-source for all files | | | | | |
| Branding and design | | | | | |
| Case studies/social proof | | | | | |
| Maintenance planning | | | | | |
| A11y plan & implementation | | | | | |
| Mobile-first plan & impl. | | | | | |
| HTTPS access & HTTP redirect | | | | | |
| Criteria | 1 | 2 | 3 | 4 | 5 |
| --- | --- | --- | --- | --- | --- |
| Single-source for all files | | | | | |
| Meets min website req. (for maturity level) | | | | | |
| Branding and design | | | | | |
| Case studies/social proof | | | | | |
| Maintenance planning | | | | | |
| A11y plan & implementation | | | | | |
| Mobile-first plan & impl. | | | | | |
| HTTPS access & HTTP redirect | | | | | |

Scale:
- 1 = (Is not present or requires significant work)
Expand Down