theupdateframework / theupdateframework/python-tuf

Enhance TUF Documentation with Architecture Diagrams and Visual Aids

Open
#2,639 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
304
Avg merge
1d 2h
Merged PRs (30d)
17

Description

Description of issue or feature request:
We need to enhance the documentation for The Update Framework (TUF) by adding architecture diagrams and other visual aids, aligning with the CNCF TechDocs Assessment criteria. These additions should be similar to those found in Kubernetes and Falco documentation to improve understanding and clarity for users and contributors.

Current behavior:
The current documentation for TUF lacks detailed architecture diagrams and visual representations, making it challenging for users to grasp the system's design and components easily.

Expected behavior:
We expect to see the addition of comprehensive architecture diagrams and other visual aids in the TUF documentation, similar to the ones found in Kubernetes and Falco documentation. These diagrams should clearly illustrate the system's architecture, key components, data flow, and interactions, providing an intuitive understanding of TUF's workings.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No documentation files, tests, or entry points are specified. Start by reviewing the existing TUF documentation against the linked CNCF TechDocs criteria and the Kubernetes and Falco examples. Done means the documentation includes agreed architecture diagrams and visual aids covering TUF’s components, data flow, and interactions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.