docs: tweaks to auth + pptr docs (#10277)

GoogleChrome · Jan 30, 2020 · 3e0e5f0 · 3e0e5f0
1 parent 8d8a052
commit 3e0e5f0
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 7 deletions.
diff --git a/docs/authenticated-pages.md b/docs/authenticated-pages.md
@@ -8,6 +8,10 @@ Default runs of Lighthouse load a page as a "new user", with no previous session
 
 See [a working demo at /docs/recipes/auth](./recipes/auth).
 
+View our full documentation for using [Lighthouse along with Puppeteer](https://github.com/GoogleChrome/lighthouse/blob/master/docs/puppeteer.md).
+
+You may want to use Puppeteer's [`page.setCookie`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetcookiecookies).
+
 ## Option 2: Leverage logged-in state with Chrome DevTools
 
 The Audits panel in Chrome DevTools will never clear your cookies, so you can log in to the target site and then run Lighthouse. If `localStorage` or `indexedDB` is important for your authentication purposes, be sure to uncheck `Clear storage`.
@@ -28,7 +32,7 @@ const result = await lighthouse('http://www.example.com', {
 });
 ```
 
-You could also set the `Cookie` header, but beware: it will [override any other Cookies you expect to be there](https://github.com/GoogleChrome/lighthouse/pull/9170). A workaround is to use Puppeteer's [`page.setCookie`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetcookiecookies).
+You could also set the `Cookie` header, but beware: it will [override any other Cookies you expect to be there](https://github.com/GoogleChrome/lighthouse/pull/9170).
 
 ## Option 4: Open a debug instance of Chrome and manually log in
 

diff --git a/docs/puppeteer.md b/docs/puppeteer.md
@@ -1,9 +1,6 @@
-# Recipes Puppeteer with Lighthouse
+# Using Puppeteer with Lighthouse
 
-**Note**: https://github.com/GoogleChrome/lighthouse/issues/3837 tracks the discussion for making Lighthouse work in concert with Puppeteer.
-Some things are possible today (login to a page using Puppeteer, audit it using Lighthouse) while others (A/B testing the perf of UI changes) are trickier or not yet possible.
-
-### Inject JS/CSS before the page loads
+### Option 1: Launch Chrome with Puppeteer and handoff to Lighthouse
 
 The example below shows how to inject CSS into the page before Lighthouse audits the page.
 A similar approach can be taken for injecting JavaScript.
@@ -60,7 +57,7 @@ await browser.close();
 })();
 ```
 
-### Connecting Puppeteer to a browser instance launched by chrome-launcher.
+### Option 2: Launch Chrome with Lighthouse/chrome-launcher and handoff to Puppeteer
 
 When using Lighthouse programmatically, you'll often use chrome-launcher to launch Chrome.
 Puppeteer can reconnect to this existing browser instance like so:
@@ -100,3 +97,10 @@ await chrome.kill();
 
 })();
 ```
+
+### [Using Puppeteer in a custom gatherer](https://github.com/GoogleChrome/lighthouse/tree/master/docs/recipes/custom-gatherer-puppeteer)
+
+
+--------------
+
+**Note**: https://github.com/GoogleChrome/lighthouse/issues/3837 tracks the overall discussion for making Lighthouse work in concert with Puppeteer. Some things, like A/B testing the perf of UI changes, are tricky or not yet possible.