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.

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

Better Documentation #638

Open
5 tasks
Hritik14 opened this issue Mar 1, 2022 · 0 comments
Open
5 tasks

Better Documentation #638

Hritik14 opened this issue Mar 1, 2022 · 0 comments
Labels
documentation Everything about documentation

Comments

@Hritik14
Copy link
Collaborator

Hritik14 commented Mar 1, 2022

#631 and #624 gives a basic documentation but there is scope for improvement.

  • Info about severity systems
  • Info about version_api (githubtagsapi, etc) and time traveling
  • Open a draft PR (preferably) or an issue when you start working on something so that the project direction is visible to everyone.
  • runserver with --insecure or DEBUG=True in settings for UI
  • Add this somewhere in readme: OWASP Top 10 2021 (https://owasp.org/Top10/)
    A06:2021-Vulnerable and Outdated Components was previously titled Using Components with Known Vulnerabilities and is #1 Query cve-search' database for package vulnerabilities #2 in the industry survey, but also had enough data to make the Top 10 via data analysis. This category moves up from Collect vulnerabilities and package references from cve-search (and/or via4cve) #9 in 2017 and is a known issue that we struggle to test and assess risk. It is the only category not to have any CVEs mapped to the included CWEs, so a default exploit and impact weights of 5.0 are factored into their scores.
@Hritik14 Hritik14 added the documentation Everything about documentation label Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Everything about documentation
Projects
None yet
Development

No branches or pull requests

1 participant