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.

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

Basic documentation #603

Closed
Hritik14 opened this issue Feb 2, 2022 · 5 comments · Fixed by #631
Closed

Basic documentation #603

Hritik14 opened this issue Feb 2, 2022 · 5 comments · Fixed by #631
Milestone
v30.0

Comments

@Hritik14
Copy link
Collaborator

Hritik14 commented Feb 2, 2022 •
edited
Loading

We'll be reusing the docs structure from https://scancodeio.readthedocs.io/en/latest/
@Hritik14 Hritik14 added this to the v30.0 milestone Feb 2, 2022
@pombredanne pombredanne changed the title Basic documenation Basic documentation Feb 2, 2022
@karan-vaishnav
Copy link

May I work on this issue??

@Hritik14
Copy link
Collaborator Author

Hritik14 commented Feb 2, 2022

Hello @karan-vaishnav
This issue is highly dependent on the recent restructuring of our codebase #525
Maybe you could start with a good first issue according to the difficulty marked.

@karan-vaishnav
Copy link

Okay

@Hritik14
Copy link
Collaborator Author

  • Info about severity systemssystems
  • 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 mentioned this issue Feb 15, 2022
Merged
@Hritik14 Hritik14 linked a pull request Mar 1, 2022 that will close this issue
Improve RTD documentation #631
Merged
@Hritik14
Copy link
Collaborator Author

Hritik14 commented Mar 1, 2022

More of this will be taken care in #638

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v30.0
Development

Successfully merging a pull request may close this issue.

Improve RTD documentation Hritik14/vulnerablecode
2 participants
@Hritik14 @karan-vaishnav