Open source projects need help with their documentation! The TUF project is a good place to start. We'd welcome help from others to help here and become contributors to other projects / TAGs later in the project period. The mentee will (with minimal guidance from the CNCF team and TUF project) do a CNCF assessment (https://github.com/cncf/techdocs/blob/main/assessments/howto.md) for the TUF documentation. Expected Outcome: Both an improvement of project docs and the development of a new contributor. A mentee will understand how to do technical writing for an open source project.
No project history available for this organization.
Counts are based on projects listed in the Contribo catalog.
Showing 2 of 2 projects. Click any project card for scope, mentors, and proposal studio.
A TUF (https://theupdateframework.com/) metadata repository consists of signed metadata files, which are read by TUF clients when securely downloading artifacts. The metadata (https://theupdateframework.com/docs/metadata/) contains information about the artifacts and about the metadata itself, most notably, who is trusted to sign what. A suitable visual representation of this trust hierarchy makes TUF's security properties more accessible to end-users, and, more importantly, allows metadata signers to carefully review metadata changes before signing them. In this project you will, together with your mentor and the TUF community, identify requirements for the visualization of a TUF metadata repository and build a corresponding web app. Expected Outcome: Identify requirements and build a basic web app to visualize TUF metadata. (Initial requirements may be inspired by the tuf-on-ci use case.)
Open source projects need help with their documentation! The TUF project is a good place to start. We'd welcome help from others to help here and become contributors to other projects / TAGs later in the project period. The mentee will (with minimal guidance from the CNCF team and TUF project) do a CNCF assessment (https://github.com/cncf/techdocs/blob/main/assessments/howto.md) for the TUF documentation. Expected Outcome: Both an improvement of project docs and the development of a new contributor. A mentee will understand how to do technical writing for an open source project.