diff --git a/docs/docs/getting-started/jupyter-lab-extension.md b/docs/docs/getting-started/jupyter-lab-extension.md index fc7d18a..fb783a9 100644 --- a/docs/docs/getting-started/jupyter-lab-extension.md +++ b/docs/docs/getting-started/jupyter-lab-extension.md @@ -63,7 +63,7 @@ You can also run a scan by clicking the `Scan with NB Defense` button in the not Within the side panel we display a list of issues detected during the scan. The information on the side bar includes the "Issue type", a short description of the issue, and which cell index the issue was found in. -![Side panel with results](../../imgs/side-panel-with-results.png){: style="height:600px"} +![Side panel with results](../imgs/side-panel-with-results.png){: style="height:600px"} Clicking on one of the issues here will focus the relevant cell. From here you can see that the characters that triggered the scan will be underlined in the editor. Additionally, all of the cells that contain issues will have a red background. diff --git a/docs/docs/have-an-issue.md b/docs/docs/have-an-issue.md deleted file mode 100644 index 43f81be..0000000 --- a/docs/docs/have-an-issue.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -hide: - - navigation ---- - -Thank you for your interest in contributing to NB Defense. We want to make tools with the community that data scientist and engineers can use and enjoy. Welcome to the community! - -## Found A Bug? 🐞 - -Found an issue with the NB Defense CLI or Jupyter Lab Extension? Lets get that fixed. Let us know what you've found by opening an issue using the following links: - -- [NB Defense Bug (SDK and CLI)](https://github.com/protectai/nbdefense/issues/new?labels=bug&template=bug_report.md&title=%5BA+Few+Words+Describing+the+Bug%5D) - -- [NB Defense Jupyter Bug (Jupyter Lab Extension)](https://github.com/protectai/nbdefense-jupyter/issues/new?labels=bug&template=bug_report.md&title=%5BA+Few+Words+Describing+the+Bug%5D) - -## Found An Issue With Our Documentation? 📄 - -We want to be clear, correct, and concise. Let us know where we can improve: - -- [NB Defense Documentation Issue (SDK, CLI and Jupyter Lab Extension)](https://github.com/protectai/nbdefense/issues/new?labels=bug%2C+documentation&template=documentation-issue-report.md&title=%5BA+Few+Words+Describing+the+Issue%5D) - -## Have An Idea For A New Feature? 💡 - -We'd love to hear about it. Tell us more by creating an issue below: - -- [NB Defense Feature Request (SDK and CLI)](https://github.com/protectai/nbdefense/issues/new?labels=enhancement&template=feature_request.md&title=%5BA+Few+Words+Describing+the+Feature%5D) - -- [NB Defense Jupyter Feature Request (Jupyter Lab Extension)](https://github.com/protectai/nbdefense/issues/new?labels=enhancement&template=feature_request.md&title=%5BA+Few+Words+Describing+the+Feature%5D) - -## Have A Question? ❓ - -Feel free to ask questions using github discussions by following the links below: - -- [NB Defense Discussions (SDK and CLI)](https://github.com/protectai/nbdefense/discussions) - -- [NB Defense Jupyter Discussions (Jupyter Lab Extension)](https://github.com/protectai/nbdefense-jupyter/discussions) diff --git a/docs/docs/supported-scans/scanning-dependencies-for-licenses.md b/docs/docs/supported-scans/scanning-dependencies-for-licenses.md deleted file mode 100644 index 757b328..0000000 --- a/docs/docs/supported-scans/scanning-dependencies-for-licenses.md +++ /dev/null @@ -1,27 +0,0 @@ -# Third Party License Validation - -NB Defense relies on the licensing reporting for packages hosted in PyPI as well as the locally stored copies of these packages where available. - -We simply parse the license information to determine if it matches licenses that are known to be friendly for commercial usage, specifically: - -```python -ACCEPTED_LICENSES = [ - "Apache License 2.0", - "Apache Software License", - "Apache 2.0", - "Apache-2.0", - "BSD", - "BSD License", - "BSD 3-Clause", - "BSD-3-Clause", - "GNU Library or Lesser General Public License (LGPL)", - "Microsoft Public License", - "MIT", - "MIT License", - "Python Software Foundation License", - "ISC License (ISCL)", - "MIT-0", -] -``` - -More customization coming soon! \ No newline at end of file