Rework documentation on vuln. DB

eclipse / steady

Analyses your Java applications for open-source dependencies with known vulnerabilities, using both static analysis and testing to determine code context and usage for greater accuracy. https://eclipse.github.io/steady/

Apache License 2.0

517 stars 123 forks source link

Rework documentation on vuln. DB #503

Closed copernico closed 2 years ago

copernico commented 2 years ago

General restructuring of docs, particularly the part on vulnerability db and library assessment.

copernico commented 2 years ago

@henrikplate @serenaponta could you take a look at these preliminary changes? In particular, I moved some stuff around and added a couple of "user manuals" but I am not sure that is the right place. NOTE: The page on Vuln. Data themselves is not done yet, it still contains some residues of old content.

copernico commented 2 years ago

I guess what remains to do is:

update user/manuals/updating_vuln_data.md with all the technical description of how statements end up in the Steady backend
document the standard (simple) docker-based deployment method (#502) and adjust links in the other docs in order to point to it

henrikplate commented 2 years ago

@copernico Thank you for the changes, you shortened quite a bit. I agree that the easy setup and start remains to be documented in the DevOps section.

serenaponta commented 2 years ago

The scripts from #502 still need to be documented but it can be done in a separate PR.