Skip to content

Commit

Permalink
Docs: TUF docs Analysis and Improvement (cncf#261)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dindihub committed Aug 10, 2024
1 parent 552c917 commit 0ed4ff9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 19 deletions.
10 changes: 0 additions & 10 deletions analyses/0012-TUF/analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,6 @@ Scale:
issues that are still open which may confuse contributors looking for issues
to work on.
- Information about the TUF **slack channel** is available on the website in
- Information about the TUF **slack channel** is available on the website in
- Information about the TUF **slack channel** is available on the website in
areas of interest

Expand All @@ -345,7 +344,6 @@ Scale:
visible on the website repo README for easy access. visible on the website
repo README for easy access.

no information about project meetings. Instead, the users are directed to join
no information about project meetings. Instead, the users are directed to join
the
[Python reference implementation](https://github.com/theupdateframework/python-tuf?tab=readme-ov-file)
Expand Down Expand Up @@ -404,8 +402,6 @@ Scale:
- Maintain issues, track,close and stale old issues to reduce backlog.
- Include instructions on how to contribute to a CONTRIBUTING guideline, e.g.,
how interest.
- Include instructions on how to contribute to a CONTRIBUTING guideline, e.g.,
how interest.

#### New contributor getting started content

Expand Down Expand Up @@ -446,8 +442,6 @@ Scale:

4 = Meets or exceeds standards

- There's no guideline or tutorial to assist users in generating the website
from 5 = Exemplary
- There's no guideline or tutorial to assist users in generating the website
from 5 = Exemplary

Expand All @@ -456,9 +450,6 @@ Scale:
navigation option is a menu bar. This makes it difficult to find information.
the website repo.

navigation option is a menu bar. This makes it difficult to find information.
the website repo.

- Information about the website build, tools and how to generate it are not
available on the website or the docs repo.
- Intra-site search mechanism is not available from the website. The only
Expand All @@ -481,7 +472,6 @@ The website docs analysis is in progress.
- The website follows a mobile-first design with all pages, menu's and features
visible on smaller screens.
- There's a recognizable brand for the project, a logo, and a blue-white color
- There's a recognizable brand for the project, a logo, and a blue-white color
- The website does not provide a text-to-speech option for users.

#### Branding and design
Expand Down
14 changes: 5 additions & 9 deletions analyses/0012-TUF/implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,11 @@ structure:
- **Home page**
- **Documentation**: Overview of TUF

- Getting started: Adopters, contributors, Timeline, and History
- Project
- Metadata
- Enhancement proposals
- Overview: Metadata,Project,Security
- Getting started: Adopters, contributors,
- History
- Timeline
- Adoptions
- Implementations
- Security audits
- FAQ

- **Community**: You can have two sections.
Expand Down Expand Up @@ -182,7 +180,7 @@ notifications about meetings. I like how the

## Proposed Information Architecture for the TUF Website

The table below outlines the current information architecture (IA) of the
The table below outlines the current information architecture(IA) of the
[TUF website](https://theupdateframework.io/) and the proposed IA for the new
website.

Expand Down Expand Up @@ -218,8 +216,6 @@ website.
| | | - Getting started |
| | | - Adoptions |
| | | - FAQ |
| | Specification | -Specification (latest) |
| | | - Specification index |
| | Community | - Code of conduct |
| | | - Learn and connect |
| | | - Develop and contribute |
Expand Down

0 comments on commit 0ed4ff9

Please sign in to comment.