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

Update FAQ #33

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update FAQ #33

wants to merge 2 commits into from

Conversation

badarahmed
Copy link
Collaborator

No description provided.

@badarahmed badarahmed requested review from milesjos and cherbel April 5, 2023 03:48
Copy link
Member

@cherbel cherbel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

Copy link
Member

@milesjos milesjos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!


### Does NB Defense JupyterLab Extension run in my kernel?

We recommend that you isolate NB Defense from the kernel that you are using for your notebook. If you have installed NB Defense into a separate python environment, it will not run in your kernel. We do use your active kernels python path to determine which third party dependencies are installed, so we can scan them for CVEs and licenses.
No. We recommend installing NB Defense Jupyterlab extension outside of Kernel specific environment. NB Defense runs its code on the Jupyter Server instead of Notebook specific Kernel(s). We do use your active kernels python path to determine which third party dependencies are installed, so we can scan them for CVEs and licenses.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current

We recommend installing NB Defense Jupyterlab extension outside of Kernel specific environment.

Recommended

We recommend installing NB Defense JupyterLab extension outside of a kernel-specific environment.

Also, we should add an apostrophe for kernel's and capitalize Python in active kernel's Python path in the next sentence.


NB Defense is special because it allows you to scan Jupyter Notebooks. We provide both a [JupyterLab Extension](./getting-started/jupyter-lab-extension.md) that you can use to scan notebooks while you're working, and a [CLI](./getting-started/cli.md) that you can use to scan groups of notebooks or repositories. Using both of these tools, you can scan your notebooks for personally identifiable information (PII), secrets, common exposures and vulnerabilities (CVEs), and non permissive licenses.

NB Defense allows you to scan Jupyter Notebooks. Currently most security tools do not support Notebook `.ipynb` formatted files. NB Defense fills this gap. We provide both a [JupyterLab Extension](./getting-started/jupyter-lab-extension.md) that you can use to scan notebooks within Jupyterlab environment, and a [CLI](./getting-started/cli.md) that you can use to scan groups of notebooks or repositories. Using both of these tools, you can scan your notebooks for personally identifiable information (PII), secrets, common exposures and vulnerabilities (CVEs), and non permissive licenses.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current

that you can use to scan notebooks within Jupyterlab environment

Recommended

that you can use to scan notebooks within a JupyterLab environment

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps instead of saying they don't support .ipynb files, state that they aren't rendering findings in a way that a Jupyter user understands. Specifically they will report an issue on a line of a JSON file, not within a specific cell or output.

@badarahmed badarahmed requested a review from chrisking April 6, 2023 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants