Skip to content

Commit

Permalink
Tweaks
Browse files Browse the repository at this point in the history
Signed-off-by: Prabhu Subramanian <[email protected]>
  • Loading branch information
prabhu committed Feb 19, 2025
1 parent b8341bd commit a5c210e
Show file tree
Hide file tree
Showing 7 changed files with 801 additions and 718 deletions.
2 changes: 1 addition & 1 deletion contrib/CSAF_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ path_to_your_csaf_file`
Feel free to reach out to us on [discord](https://discord.gg/DCNxzaeUpd) or
start a discussion tagging
[@cerrussell](https://github.com/cerrussell) on
the [OWASP Dep-Scan Repo](https://github.com/owasp-dep-scan/dep-scan).
the [OWASP dep-scan Repo](https://github.com/owasp-dep-scan/dep-scan).
6 changes: 3 additions & 3 deletions contrib/GUI_README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Enabling GUI mode for Dep-Scan
## Enabling GUI mode for dep-scan

Dep-Scan can be run in GUI mode by passing the `--gui` or `-g` flag to the command line. This will open a new window with the GUI and show the available input options.
dep-scan can be run in GUI mode by passing the `--gui` or `-g` flag to the command line. This will open a new window with the GUI and show the available input options.


The code to enable the GUI is present at: https://github.com/saketjajoo/dep-scan/commit/27c397bb551ada79bfc344d39399a896ecd38cef.
Expand All @@ -17,4 +17,4 @@ The GUI mode is introduced via the [Gooey Python library](https://pypi.org/proje
wxPython uses the underlying host OS's architecture to build the GUI. Thus, this feature may require additional steps than just simply installing Gooey via pip as the installation is host OS architecture dependent. This means that if this change is introduced in dep-scan, the builds will need to be OS architecture based. Hence, this feature can be a breaking change and it is yet to figured out how to introduce this in the dep-scan environment.

### Example GUI
![Dep-Scan GUI](dep-scan-gui.png)
![dep-scan GUI](dep-scan-gui.png)
24 changes: 0 additions & 24 deletions docs/pre-push.sh

This file was deleted.

4 changes: 2 additions & 2 deletions documentation/docs/dep-scan.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: /
sidebar_position: 1
---

# Dep-Scan
# dep-scan

OWASP dep-scan is a next-generation security and risk audit tool based on known vulnerabilities, advisories, and license limitations for project dependencies. Both local repositories and container images are supported as the input, and the tool is ideal for integration with ASPM/VM platforms and in CI environments.

Expand Down Expand Up @@ -49,5 +49,5 @@ Application vulnerabilities would be reported for all Linux distros and Windows.

This project is funded through [NGI Zero Core](https://nlnet.nl/core), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/OWASP-dep-scan).

[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" />](https://nlnet.nl)
[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" />](https://nlnet.nl)
[<img src="https://nlnet.nl/image/logos/NGI0_tag.svg" alt="NGI Zero Logo" width="20%" />](https://nlnet.nl/core)
21 changes: 8 additions & 13 deletions documentation/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type * as Preset from '@docusaurus/preset-classic';


const config: Config = {
title: 'Dep-Scan',
title: 'OWASP dep-scan',
tagline: 'Next generation security audit',
favicon: 'img/dep-scan-large.png',

Expand All @@ -31,9 +31,9 @@ const config: Config = {
{
docs: {
sidebarPath: './sidebars.ts',

routeBasePath: '/',

editUrl:
'https://github.com/owasp-dep-scan/dep-scan/tree/master/documentation',
},
Expand All @@ -43,9 +43,9 @@ const config: Config = {
type: ['rss', 'atom'],
xslt: true,
},

editUrl:
'https://github.com/owasp-dep-scan/dep-scan/tree/master/docs',
'https://github.com/owasp-dep-scan/dep-scan/tree/master/documentation',
onInlineTags: 'warn',
onInlineAuthors: 'warn',
onUntruncatedBlogPosts: 'warn',
Expand All @@ -58,11 +58,10 @@ const config: Config = {
],

themeConfig: {
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'OWASP Dep-Scan',
title: 'OWASP dep-scan',
logo: {
alt: 'Dep-Scan Logo',
alt: 'dep-scan Logo',
src: 'img/dep-scan-large.png',
},
items: [
Expand All @@ -80,18 +79,14 @@ const config: Config = {
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
},
{
label: 'Github',
href: 'https://github.com/owasp-dep-scan/dep-scan',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} OWASP Foundation. Built with Docusaurus and ❤️.`,
copyright: `Copyright © ${new Date().getFullYear()} OWASP Foundation.`,
},
prism: {
theme: prismThemes.github,
Expand Down
2 changes: 1 addition & 1 deletion vendor/choosealicense.com/_licenses/mit-0.txt

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a5c210e

Please sign in to comment.