Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Initial README #120

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
Merged
merged 12 commits into from
Aug 4, 2020
Merged

Initial README #120

merged 12 commits into from
Aug 4, 2020

Conversation

@wagoodman
Copy link
Contributor

@wagoodman wagoodman commented Aug 4, 2020 •
edited
Loading

This PR adds the initial README and fixes to support the descriptions in the README.

Specific fixes:

  • default to squashed scope, which makes more sense from a user perspective than all-layers
  • allow for all-layers instead of alllayers scope selection
  • some log entries were not appearing in the log file when the ETUI is selected and the log file was configured

Partially addresses #102

luhring
luhring suggested changes Aug 4, 2020
View reviewed changes
Copy link
Contributor

@luhring luhring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just some minor tweaks would increase polish, IMHO

alfredodeza
alfredodeza suggested changes Aug 4, 2020
View reviewed changes
wagoodman and others added 7 commits August 4, 2020 09:28
@wagoodman
simplify phrasing
c69adf6 
Co-authored-by: Alfredo Deza <[email protected]>
@wagoodman
add comment for example gif
d3d6906 
Co-authored-by: Alfredo Deza <[email protected]>
@wagoodman
spelling fix
5ade9d5 
Co-authored-by: Alfredo Deza <[email protected]>
@wagoodman
update phrasing
77b9ce7 
Co-authored-by: Alfredo Deza <[email protected]>
@wagoodman
simplify TODO note
43cd035 
Co-authored-by: Alfredo Deza <[email protected]>
@wagoodman
grammar fix
a1e32d1 
Co-authored-by: Alfredo Deza <[email protected]>
@wagoodman
phrase fix
4f4a2fb 
Co-authored-by: Alfredo Deza <[email protected]>
alfredodeza
alfredodeza reviewed Aug 4, 2020
View reviewed changes
README.md Outdated
- `~/.syft.yaml`
- `<XDG_CONFIG_HOME>/syft/config.yaml`

Configuration options:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was actually just looking for these values. Can we have all of the values (perhaps these are all!) with the defaults? That way we don't need to add "the default is X" anywhere except once at the top.

Copy link
Contributor Author

@wagoodman wagoodman Aug 4, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, this is all of our configuration values (grype will have a few more)

With regard to default values, that's currently what's indicated (but is not apparent I think, so I've tweaked it). That is, the given example values are the default values, only one exception is noted since it clarifies the behavior of having an empty default value (the log file).

I've added a note to the top of that section noting that "example values are the default value"... think that's good enough? or is there a better place/phrase, @alfredodeza ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not seeing the note that these example values are the default. Is that in this doc or somewhere else?

alfredodeza
alfredodeza reviewed Aug 4, 2020
View reviewed changes
@wagoodman
rm value
e72c50e 
Co-authored-by: Alfredo Deza <[email protected]>
@wagoodman wagoodman merged commit 2560266 into master Aug 4, 2020
@wagoodman wagoodman deleted the add-basic-readme branch August 4, 2020 19:22
@wagoodman wagoodman linked an issue Aug 4, 2020 that may be closed by this pull request
Add documentation #102
Closed
4 tasks
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
@wagoodman
Initial README (anchore#120)
fa0d63e 
* initial readme + logging and output fixes to support descriptions

* minor tweaks to README descriptions

* simplify phrasing

Co-authored-by: Alfredo Deza <[email protected]>

* add comment for example gif

Co-authored-by: Alfredo Deza <[email protected]>

* spelling fix

Co-authored-by: Alfredo Deza <[email protected]>

* update phrasing

Co-authored-by: Alfredo Deza <[email protected]>

* simplify TODO note

Co-authored-by: Alfredo Deza <[email protected]>

* grammar fix

Co-authored-by: Alfredo Deza <[email protected]>

* phrase fix

Co-authored-by: Alfredo Deza <[email protected]>

* rm readme bash block indicators

* clarify config examples are default values

* rm value

Co-authored-by: Alfredo Deza <[email protected]>

Co-authored-by: Alfredo Deza <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

3 more reviewers

@alfredodeza alfredodeza alfredodeza approved these changes

@rossturk rossturk rossturk approved these changes

@luhring luhring luhring approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add documentation

4 participants

@wagoodman @alfredodeza @rossturk @luhring