Skip to content

Commit

Permalink
[Doc] Add note about Node 12 deprecation warnings (#2566)
Browse files Browse the repository at this point in the history
* Add note about Node 12 deprecation warnings

* Update message based on feedback

Co-authored-by: Devagouda <[email protected]>
  • Loading branch information
jcalcaben and dpatil-magento committed Jul 21, 2020
1 parent dce8779 commit 4c649b6
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 0 deletions.
10 changes: 10 additions & 0 deletions pwa-devdocs/src/tutorials/pwa-studio-fundamentals/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ During the course of the tutorials, you will create a new storefront application
- Node >= 10.14.1
- Yarn (recommended) or NPM

### Node 12 deprecation warning

If you are using Node 12, you may see the following deprecation warning in the log when you run `yarn watch:venia`.

```sh
(node:89176) [DEP0066] DeprecationWarning: OutgoingMessage.prototype._headers is deprecated
```

This is caused by a project dependency used by PWA Studio and not by PWA Studio itself.

## Tutorials available

- [Project setup][] - Setup a local development environment using the scaffolding tool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ yarn -v

If entering these commands does not show you a version number, install Node.js, Yarn, or both.

### Node 12 deprecation warning

If you are using Node 12, you may see the following deprecation warning in the log when you run `yarn watch:venia`.

```sh
(node:89176) [DEP0066] DeprecationWarning: OutgoingMessage.prototype._headers is deprecated
```

## Run the scaffolding tool

In your terminal, navigate to the directory where you want to install your storefront project and run the scaffolding tool:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ This lets you leverage Venia functionality in your own PWA projects.

- Node >=10.14.1

### Node 12 deprecation warning

If you are using Node 12, you may see the following deprecation warning in the log when you run `yarn watch:venia`.

```sh
(node:89176) [DEP0066] DeprecationWarning: OutgoingMessage.prototype._headers is deprecated
```

This is caused by a project dependency used by PWA Studio and not by PWA Studio itself.

## Install package dependency

Use **Yarn** to install the `@magento/venia-concept` package:
Expand Down
10 changes: 10 additions & 0 deletions pwa-devdocs/src/venia-pwa-concept/setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ If you experience problems with the project setup, see [Troubleshooting][] in th
- Python 2.7 and build tools, [see the Installation instructions on `node-gyp`](https://github.com/nodejs/node-gyp#installation) for your platform.
- [A running instance of Magento 2.3.1 or above](#choosing-the-magento-23-backend)

### Node 12 deprecation warning

If you are using Node 12, you may see the following deprecation warning in the log when you run `yarn watch:venia`.

```sh
(node:89176) [DEP0066] DeprecationWarning: OutgoingMessage.prototype._headers is deprecated
```

This is caused by a project dependency used by PWA Studio and not by PWA Studio itself.

## Step 1. Clone the PWA Studio repository

Clone the [PWA Studio][] repository into your development environment.
Expand Down

0 comments on commit 4c649b6

Please sign in to comment.