Documentation: Add how to guides

[Niraj-Kamdar]

No description provided.

[codecov-commenter]

Codecov Report

Merging #864 into master will decrease coverage by 2.29%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #864      +/-   ##
==========================================
- Coverage   87.31%   85.02%   -2.30%     
==========================================
  Files         164      164              
  Lines        2705     2705              
  Branches      295      295              
==========================================
- Hits         2362     2300      -62     
- Misses        272      326      +54     
- Partials       71       79       +8     

Flag	Coverage Δ
#longtests	85.02% <ø> (-2.30%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
cve_bin_tool/checkers/xml2.py	61.36% <0.00%> (-27.28%)	⬇️
test/test_json.py	68.96% <0.00%> (-20.69%)	⬇️
test/test_cli.py	80.45% <0.00%> (-18.05%)	⬇️
test/test_scanner.py	79.77% <0.00%> (-11.24%)	⬇️
cve_bin_tool/cli.py	83.33% <0.00%> (-3.04%)	⬇️
cve_bin_tool/version_scanner.py	84.34% <0.00%> (-1.74%)	⬇️
cve_bin_tool/extractor.py	59.05% <0.00%> (-1.58%)	⬇️
cve_bin_tool/cvedb.py	84.25% <0.00%> (-0.79%)	⬇️
test/test_checkers.py	100.00% <0.00%> (ø)
test/test_data/glibc.py	100.00% <0.00%> (ø)
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cf7e827...de5f0db. Read the comment docs.

[terriko]

I wonder if (like in #862 ) we should use a symbolic link for the outputengine file rather than renaming. This one is less clear to me -- we don't have other documents pointing at it in its current location, and it is more of a user thing to do (as opposed to adding a checker which we expect to mostly be a developer thing to do).

[terriko]

And the docker scan stuff is looking good. I'm guessing from the dangling header at the end that you're not done with that doc yet.

[Niraj-Kamdar]

Yes, for docker scan, I have written one way which is install and run cve-bin-tool inside container and just export final report to host. Other way is export directory to scan on host and run cve-bin-tool like we run on normal directory.

I forget to draft PR.

[Niraj-Kamdar]

I have moved html template guide to how_to_guide directory because it will make our life easier when we host our site on Read-the-docs. And I think collecting every how to guide in one directory will be easy for user. We can just point user to this directory and he can find one which he is looking. But if we want to keep that on output_engine directory then I will change that.
I don't know about symbolic link but will look into it.

[terriko]

Thanks! I might do a few North American English nitpicks in a separate commit later, but since that's more window dressing than substance let's get this merged first.