Documentation: Add more information on how to test and get started #1835
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can one of the admins verify this patch? |
In `testing.md`, it was not explicitly stated that the protocol is needed when specifying the `src` and there was only a podman example shown for how to copy. In `getting_started.md` it was not mentioned that the config file has to be provided when running `clairctl report` and there was no advice on how to run directly on local image without having to start Quay. Signed-off-by: gabriel-farache <gfarache@redhat.com> Signed-off-by: Hank Donnay <hdonnay@redhat.com>
|
@gabriel-farache do my changes still hit the points you wanted to make? I removed the docker-specific command examples, replaced the |
|
@hdonnay Yep, perfect with me :) |
hdonnay
approved these changes
Sep 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on my experience when setting up and testing clair, I completed the doc with the following:
srcand there was no docker command command to show how to copy.If that type of information are not needed/wanted in the doc, then close the PR :)