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

Enhance TUF Documentation with Architecture Diagrams and Visual Aids #2639

Open
Ayush9026 opened this issue May 23, 2024 · 1 comment
Open

Comments

@Ayush9026
Copy link

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.

@Ayush9026
Copy link
Author

/assign @Ayush9026 i will raise PR for this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant