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.

Sign up for GitHub

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

Jump to bottom

docs: improve targets documentation #8305

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: improve targets documentation #8305

wants to merge 4 commits into from
+312 −659

Conversation

itaysk
Copy link
Contributor

@itaysk itaysk commented Jan 28, 2025 •
edited
Loading

Description

  • define target types and refer to them in relevant places
  • use consistent structure for all targets docs (also simplify it)
  • (also update scanner embedding doc)

Related issues

@itaysk itaysk requested a review from knqyf263 as a code owner January 28, 2025 13:41
@itaysk
Copy link
Contributor Author

itaysk commented Jan 28, 2025

some clarifications about the target docs structure:

  1. start with general description of the target
  2. clearly classify the target pre/post scan
  3. include general usage example the covers supported arguments
  4. state supported scanners, and default scanners for the target
  5. cover additional flags and options

removed some sections/examples that appeared in some of the target and were redundant IMO
for the image scanning specifically, I decided to demote the image config section as it is no so popular and wasn't consistent with the structure, I documented it like all the other flags. Also I wasn't sure the podman detailed description was necessary but left it

@itaysk
Copy link
Contributor Author

itaysk commented Jan 28, 2025

after rebase, I guess cache is also part of the target consistent structure

itaysk added 2 commits February 5, 2025 13:05
@itaysk
docs: improve targets documentation
213cd95 
    - define target types and refer to them in relevant places
    - use consistent structure for all targets docs (also simplify it)
    - (also update scanner embedding doc)
@itaysk
typos
582ce65
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nikpivkin nikpivkin nikpivkin left review comments

@knqyf263 knqyf263 Awaiting requested review from knqyf263 knqyf263 is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@itaysk @nikpivkin