From c03f5922f8f4c4a4d8ff7ebb6b8e44571d09699d Mon Sep 17 00:00:00 2001 From: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> Date: Wed, 5 Apr 2023 18:06:33 +0200 Subject: [PATCH] docs: small misc. updates (#9978) Co-authored-by: Alex Rudenko --- README.md | 8 +++++--- docs/contributing.md | 6 ++++-- docs/faq.md | 12 ------------ docs/index.md | 8 +++++--- test/installation/package.json | 2 +- .../versioned_docs/version-19.8.3/contributing.md | 6 ++++-- 6 files changed, 19 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 4f2b49be99e..ecd7eab401b 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Here are a few examples to get you started: - Capture a [timeline trace](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference) of your site to help diagnose performance issues. -- Test Chrome Extensions. +- [Test Chrome Extensions](https://pptr.dev/guides/chrome-extensions). ## Getting Started @@ -39,8 +39,10 @@ To use Puppeteer in your project, run: ```bash npm i puppeteer -# or `yarn add puppeteer` -# or `pnpm i puppeteer` +# or using yarn +yarn add puppeteer +# or using pnpm +pnpm i puppeteer ``` When you install Puppeteer, it automatically downloads a recent version of diff --git a/docs/contributing.md b/docs/contributing.md index ec8981e3df3..a35ea55d8d7 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -98,13 +98,15 @@ rely on complex conditions (such as names of distinct files) that cannot be captured by the build system. To clean artifacts, you can run ```sh -npm run clean # or npm run clean --workspace +npm run clean +# or specify the package +npm run clean --workspace ``` ## Comprehensive testing Outside of `npm test`, there are several other -[`npm` scripts](https://docs.npmjs.com/cli/v8/using-npm/scripts) that are +[`npm` scripts](https://docs.npmjs.com/cli/using-npm/scripts) that are usually check through CI: - `test-install` - Tests whether `puppeteer` and `puppeteer-core` install diff --git a/docs/faq.md b/docs/faq.md index d063ff336f9..3790b69f705 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -97,17 +97,6 @@ taking place in the Chromium repository. Here’s a typical story: - Once the upstream fix is landed, we roll updated Chromium into Puppeteer: https://github.com/puppeteer/puppeteer/pull/2769 -However, oftentimes it is desirable to use Puppeteer with the official Google -Chrome rather than Chromium. For this to work, you should install a -`puppeteer-core` version that corresponds to the Chrome version. - -For example, in order to drive Chrome 71 with puppeteer-core, use `chrome-71` -npm tag: - -```bash -npm install puppeteer-core@chrome-71 -``` - ## Q: Which Chromium version does Puppeteer use? Find the version using one of the following ways: @@ -135,7 +124,6 @@ To fetch Firefox Nightly as part of Puppeteer installation: ```bash PUPPETEER_PRODUCT=firefox npm i puppeteer -# or "yarn add puppeteer" ``` #### Q: What’s considered a “Navigation”? diff --git a/docs/index.md b/docs/index.md index 4f2b49be99e..ecd7eab401b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,7 +29,7 @@ Here are a few examples to get you started: - Capture a [timeline trace](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference) of your site to help diagnose performance issues. -- Test Chrome Extensions. +- [Test Chrome Extensions](https://pptr.dev/guides/chrome-extensions). ## Getting Started @@ -39,8 +39,10 @@ To use Puppeteer in your project, run: ```bash npm i puppeteer -# or `yarn add puppeteer` -# or `pnpm i puppeteer` +# or using yarn +yarn add puppeteer +# or using pnpm +pnpm i puppeteer ``` When you install Puppeteer, it automatically downloads a recent version of diff --git a/test/installation/package.json b/test/installation/package.json index 9b11b9f8d00..3176dd7053c 100644 --- a/test/installation/package.json +++ b/test/installation/package.json @@ -26,7 +26,7 @@ ] }, "build:packages": { - "command": "npm pack --workspace puppeteer --workspace puppeteer-core --workspace @puppeteer/browsers", + "command": "npm pack --quiet --workspace puppeteer --workspace puppeteer-core --workspace @puppeteer/browsers", "dependencies": [ "../../packages/puppeteer:build", "../../packages/puppeteer-core:build", diff --git a/website/versioned_docs/version-19.8.3/contributing.md b/website/versioned_docs/version-19.8.3/contributing.md index ec8981e3df3..a35ea55d8d7 100644 --- a/website/versioned_docs/version-19.8.3/contributing.md +++ b/website/versioned_docs/version-19.8.3/contributing.md @@ -98,13 +98,15 @@ rely on complex conditions (such as names of distinct files) that cannot be captured by the build system. To clean artifacts, you can run ```sh -npm run clean # or npm run clean --workspace +npm run clean +# or specify the package +npm run clean --workspace ``` ## Comprehensive testing Outside of `npm test`, there are several other -[`npm` scripts](https://docs.npmjs.com/cli/v8/using-npm/scripts) that are +[`npm` scripts](https://docs.npmjs.com/cli/using-npm/scripts) that are usually check through CI: - `test-install` - Tests whether `puppeteer` and `puppeteer-core` install