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

docs: add tip about harmless vulnerabilities #10535

Merged
merged 3 commits into from
Oct 3, 2024
Merged

docs: add tip about harmless vulnerabilities #10535

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7ec4ca
installation.mdx: add a :::tip for harmless vulnerabilities
ilg-ul Sep 29, 2024
888427e
Trigger tests again.
ilg-ul Sep 30, 2024
992df80
Update website/docs/installation.mdx
slorber Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions website/docs/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,12 @@ Then, in the directory containing `package.json`, run your package manager's ins
npm install
```

:::tip

`npm install` may report several vulnerabilities and recommend running `npm audit` to address them. Typically, these reported vulnerabilities, such as RegExp DOS vulnerabilities, are harmless and can be safely ignored. Also read this article, which reflects our thinking: [npm audit: Broken by Design](https://overreacted.io/npm-audit-broken-by-design/).

:::

To check that the update occurred successfully, run:

```bash
Expand Down