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

Add simple usage instructions where appropriate #575

Open
bernhardreiter opened this issue Sep 12, 2024 · 0 comments
Open

Add simple usage instructions where appropriate #575

bernhardreiter opened this issue Sep 12, 2024 · 0 comments

Comments

@bernhardreiter
Copy link
Collaborator

bernhardreiter commented Sep 12, 2024

As https://oasis-open.github.io/csaf-documentation/tools.html directly links to https://github.com/csaf-poc/csaf_distribution/blob/main/docs/csaf_downloader.md it makes sense to add two things to the page:

a) a hint of simple usage example, aka "just use it with your domain". Rationale: the full technical documentation does not need to be read to use the downloader, it is more for reference and special cases.
b) a recommendation to use the prebuild binaries. Rationale: The home page with the instructions cannot be directly reached from the page and it documents too many variants.

For me this is part of maintenance for #550.

And we should check if the situation for a) and b) is similar to other tools from our set.

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

No branches or pull requests

1 participant