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
Update Documentation for config and input engine #857
Conversation
update manual update update image update
Codecov Report
@@ Coverage Diff @@
## master #857 +/- ##
==========================================
- Coverage 87.85% 85.60% -2.26%
==========================================
Files 164 164
Lines 2710 2710
Branches 295 295
==========================================
- Hits 2381 2320 -61
- Misses 258 311 +53
- Partials 71 79 +8
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of small comments here, but overall this is looking good.
| | netpbm | nginx | node | openafs | openldap | openssh | openssl | | ||
| | openswan | openvpn | png | polarssl_fedora | postgresql | python | qt | | ||
| | radare2 | rsyslog | samba | sqlite | strongswan | syslogng | systemd | | ||
| | tcpdump | varnish | wireshark | xerces | xml2 | zlib | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: should we even list them here? I don't really mind for ease of searching, but the list is starting to get pretty long and I'm wondering if we're at the point where we may wish to just tell people how to get the list rather than showing it in the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The reason I have made table was the same because points are taking to much space and I agree list is only going to increase so a solution would be to redirect user to checkers directory.
doc/MANUAL.md
Outdated
|
|
||
| The last release of this tool to support python 2.7 is 0.3.1. Please use | ||
| python 3.6+ for development and future versions. Linux and Windows are | ||
| The last release of this tool to support python 2.7 is 0.3.1. Please use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, I think it's a waste of time to switch to one space after period when most of the doc is two and the rendering will look the same anyhow.
Co-authored-by: Terri Oda <terri@toybox.ca> Update README.md Co-authored-by: Terri Oda <terri@toybox.ca> Update README.md Co-authored-by: Terri Oda <terri@toybox.ca> Update README.md Co-authored-by: Terri Oda <terri@toybox.ca> Update doc/MANUAL.md Co-authored-by: Terri Oda <terri@toybox.ca> Update doc/MANUAL.md Co-authored-by: Terri Oda <terri@toybox.ca> update docs update doc/MANUAL.md update manual.md update manual accessibility change update
| <figure> | ||
| <img src="https://i.imgur.com/UwH6vA7.png" | ||
| alt=" | ||
| cve-bin-tool: Report Generated: 2020-07-31 17:49:56 | ||
| 1. NewFound CVEs: | ||
| Vendor, Product, Version, CVE Number , Severity | ||
| haxx , curl , 7.34.0 , CVE-2014-0138, HIGH | ||
| haxx , curl , 7.34.0 , CVE-2014-0139, CRITICAL | ||
| haxx , curl , 7.34.0 , CVE-2014-0015, MEDIUM | ||
| " | ||
| style="width:100%;white-space:pre;"> | ||
| <figcaption>formated console output</figcaption> | ||
| </figure> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have any easy way to do this in markdown. So, I am using html here since github supports it.
Depends on #846
Fixes: #806