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 Website Structure for User-Friendly Document Access #61

Open
yizha1 opened this issue Apr 7, 2024 · 0 comments
Open

Enhance Website Structure for User-Friendly Document Access #61

yizha1 opened this issue Apr 7, 2024 · 0 comments

Comments

@yizha1
Copy link
Contributor

yizha1 commented Apr 7, 2024

The current website mixed user documents and developer documents together. As a user who only uses Ratify, it is not easy to find user guides, such as tutorials or how-to to use Ratify under different scenarios. For example, the vulnerability report document is under Home/External Plugins/Verifier, which is not intuitive for a user who wants to set up Ratify for verifying vulnerability report. "External Plugins" are advanced concepts for users who want to plug in their own plugins. we may organize the website structure like below:

  • Overview
  • Quick Start
    • Quick start on Vallina K8s
    • Quick start on AWS
    • Quick start on Azure
    • Quick start on ...
  • Users Guides
    • Ensure image authenticity and integrity by verifying Notary Project signatures
    • Ensure image authenticity and integrity by verifying Cosign signatures
    • Ensure images compliant to vulnerability policies
    • Ensure images not containing non-compliant software licenses
  • Developer Guides
    • Overview of plugin framework
    • Extend verifiers
    • Extend key management providers
    • Extend authentication
  • Adopters
  • FAQ

/cc: @FeynmanZhou

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