Commit Graph

99 Commits

Author SHA1 Message Date
Alex Rudenko
1668d47b2f
docs: various doc improvements (#9396)
See commits for details.

Closes #1837, #5880, #7822, #8101, #8821, #9367, #9382, #9378, #4731
2022-12-09 13:57:39 +01:00
jrandolf
2d2120cea1
docs: improve docs (#9179)
This PR drastically improves the documentation by improving the sidebars
and adding a GitHub icon.

Fixed: https://github.com/puppeteer/puppeteer/pull/9176
Fixed: https://github.com/puppeteer/puppeteer/issues/9173


![image](https://user-images.githubusercontent.com/101637635/198374826-399219f6-e04f-4613-9613-f7e3281d332f.png)
2022-10-28 08:49:28 +02:00
jrandolf
f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00
jrandolf
535309feff
chore: update troubleshooting guide (#9123)
This PR updates the troubleshooting guide with some information
regarding the new `exports` resolution and cache directory.

This PR also reformats some of the other MD documents.
2022-10-17 13:07:41 +02:00
Alex Rudenko
eb6470931b
docs: add documentation about Docker (#8741)
Closes #3072
2022-08-05 11:00:09 +02:00
chakzefir
0180a882e2 docs: add gitlab-ci section to troubleshooting (#8664)
Adding explanatory section with detailed manual on how to launch puppeteer on GitlabCI
2022-07-20 10:15:14 +02:00
jrandolf
32c9f3e6fb
chore: update contributing.md (#8616) 2022-07-01 16:29:21 +02:00
jrandolf
066f440ba7
feat: add documentation (#8593) 2022-07-01 11:52:39 +00:00
jrandolf
274bd6b3b9
chore: drop Node 12 support (#8299)
This patches removes support for Node 12.

BREAKING CHANGE: Node 12 is no longer supported.
2022-05-03 08:59:40 +02:00
Andy Earnshaw
94cb08c859
docs: update troubleshooting.md with latest alpine details (#8271) 2022-04-29 06:25:20 +00:00
kirintw
213deb1921
docs(troubleshooting.md): fix alpine install adduser command (#8068) 2022-02-25 11:13:37 +00:00
ilya-sharonov
edb01972b9
fix: updated troubleshooting.md to meet latest dependencies changes (#7656) 2021-10-08 19:09:04 +00:00
Mathias Bynens
686030fe0d
chore: remove references to upstream master branches (#7412)
Chromium had its branch renamed to `main`, and for other projects we can just point to the `HEAD`.
2021-09-14 15:02:39 +00:00
Andy Chosak
32cb9e93d6
docs: bump recommended version for Alpine Docker (#7563)
The current documentation for running with an Alpine-based Docker image
recommends using Chromium 89 / Puppeteer 6.0.0.

Chromium 92 is now supported by Puppeteer 10.0.0; this commit bumps the
recommended versions.
2021-09-14 13:07:12 +00:00
Net
ae24bcaf6d
chore(docs): add instructions for headless GPU acceleration (#6924) 2021-09-13 09:47:18 +00:00
Vitalii Tverdokhlib
907290b2fd
chore(docs): update alpine version (#5099) 2021-09-11 10:07:29 +00:00
Conrad Magnus Kirschner
0075a714fd
chore: update Dockerfile in troubleshooting.md (#7015)
Update to fix no package.json failure on some systems
2021-09-11 08:44:53 +00:00
Nicholas C. Zakas
10e847404e
docs: add Google Cloud Run to troubleshooting guide (#7541)
Issue: #7519
2021-09-03 10:47:34 +02:00
Kiko Beats
a22aa5deac
docs(puppeteer-chromium): remove alpine freetype-dev dependency (#7098)
It was added by #4643 but doesn’t seem necessary anymore.
2021-04-19 07:28:01 +02:00
David Barton
c62b02f177
chore: automate prettier in docs (#7014)
Issue: #7012
Co-authored-by: Mathias Bynens <mathias@qiwi.be>
2021-03-23 10:02:34 +01:00
Maciej Brencz
35e66c4304
docs(troubleshooting): update Alpine section (#6960)
The latest Chromium provided by Alpine is at version 89.

Co-authored-by: Mathias Bynens <mathias@qiwi.be>
2021-03-09 09:02:24 +01:00
David Barton
58d5f9c3ae
docs(troubleshooting): update broken Dockerfile link to historical one (#6828)
Co-authored-by: Mathias Bynens <mathias@qiwi.be>
2021-02-09 09:45:36 +01:00
David Barton
b047023eee
chore: clean up remaining Travis references (#6826)
Issue: #6726
2021-02-08 07:41:26 +01:00
Aravind.H.U
26fa363443 docs(troubleshooting): describe EC2 Amazon-Linux setup (#6771)
Co-authored-by: Mathias Bynens <mathias@qiwi.be>
2021-01-22 09:25:58 +01:00
ghoussard
d606b8076f
docs(troubleshooting): update dumb-init version (#6585)
The latest released version of dumb-init is 1.2.2. Binary naming has changed: `dumb-init_x.x.x_amd64` became `dumb-init_x.x.x_x86_64`.
2020-11-05 07:49:20 +01:00
Maciej Brencz
8f4a79e193
docs(troubleshooting): update Alpine Chromium version (#6529)
The latest Chromium provided by Alpine is at version 85.
2020-10-27 15:26:43 +01:00
Prashant Ghimire
35cfbe1857
docs(troubleshooting.md): updated commands (#6296)
prior command installs stable version of chrome (RUN command), but after that, the docs is referring to unstable version.
added correct commands for troubleshooting in linux environment.
2020-09-09 14:39:32 +01:00
Clay Walker
b4c1e45388
docs: fix setuid sandbox link (#6310)
Minor documentation fix.
2020-08-10 10:34:09 +02:00
Maciej Brencz
142f88c7c4
docs(troubleshooting): update Alpine Chromium version (#6320)
The newest Chromium package is now using version 83, which corresponds to Puppeteer v3.1.0.
2020-08-10 07:44:22 +02:00
Hugo Des
1d08e274a8
docs(troubleshooting.md) fix error in docker guidelines (#6267) 2020-07-29 12:14:06 +01:00
Adrian Wisernig
2331584467
docs(troubleshooting): install libXss in Dockerfile (#6236)
The new version of chromium requires libxss.
2020-07-17 13:54:37 +01:00
Riccardo Magliocchetti
fb806109a0
docs(troubleshooting): drops obsolete dependencies (#5354)
It looks like chromium dropped gconf in 2017, while at it remove some other libs from the gtk2 era and bump libappindicator to a gtk3 version.

Current dependencies list for chromium 79 used as reference: https://chromium.googlesource.com/chromium/src.git/+/refs/tags/79.0.3945.144/build/install-build-deps.sh#232
2020-07-14 13:29:15 +02:00
Jack Franklin
b9667f9331
chore: document browser install breakage on Node 14.0.0 (#6187) 2020-07-09 12:32:49 +01:00
DAOUDI Soufian
d9bb52eab1
docs: fix sandboxing documentation link (#5288) 2020-07-03 14:10:52 +02:00
Pete LePage
c1490349bc chore: remove hardcoded ?hl=en from docs (#6097) 2020-06-25 13:01:46 +02:00
Mathias Bynens
f1ec6a3df0
chore: update references to branch names (#6022) 2020-06-15 17:34:16 +02:00
munrocket
ddb8ba1baf
chore: tidy up and de-duplicate Travis CI config (#5716) 2020-04-23 09:29:37 +01:00
Stano Bo
5c839f5e48
chore(docker): add missing libgbm1 dependency (#5693) 2020-04-20 17:28:18 +02:00
Ryō Igarashi
35fc65492d
docs: change the Alpine Docker example to use env instead of launch option (#5666) 2020-04-17 11:30:26 +02:00
Mathias Bynens
46ef9f79ca
docs(troubleshooting): list libgbm-dev dependency (#5667)
Fixes #5661.
2020-04-17 10:14:18 +02:00
Yuki Takizawa
a3d1536a6b
Bugfix: Docker build failure (#5400)
The recommended Dockerfile uses node:10-slim image as a base,
but the base image does not contain wget command anymore.
(About the reason, see https://github.com/nodejs/docker-node/issues/1185)
So fixed the problem.
2020-03-12 17:01:39 +01:00
Changhao Han
807fbbdc20
chore: drop Node.js v8 support (#5365)
* chore: update relevant Node.js versions from 8 to 10

* chore: remove node6 and node8 folders from puppeteer-firefox ci

* fix: loosen definition for proc.stdio

* fix: update typescript version used in npm run test-types
2020-03-10 21:55:32 +01:00
Erik Kotsiuba
6cc98a7b63 docs(troubleshooting): recommend using args for heroku (#5197)
Co-Authored-By: Mathias Bynens <mathias@qiwi.be>
2019-11-27 10:01:39 +01:00
Mathias Bynens
eddb23b521
chore: update URLs (#5185) 2019-11-26 13:12:25 +01:00
Julien Landuré
c0ba8f9a19 docs(troubleshooting): update Alpine Chromium versions (#4980)
Chromium 77 is now the default version installed in Alpine.
2019-10-16 10:05:17 +02:00
Vitalii Tverdokhlib
93843592da docs(troubleshooting): fix Alpine version link (#4927) 2019-09-11 10:30:59 +02:00
Artem Sheremet
cba0f98a2a docs(troubleshooting): Fix missing package in Docker instructions (#4877)
`ttf-freefont` is gone -- looks like it's [replaced](https://packages.debian.org/search?keywords=ttf-freefont) by `fonts-freefont-ttf`, which is [available since oldoldstable](https://packages.debian.org/search?keywords=fonts-freefont-ttf).
2019-08-24 20:13:56 -07:00
Vitalii Tverdokhlib
ff6d2a33f3 docs(puppeteer-chromium): docker alpine switch to Alpine 3.10 (#4644) 2019-08-13 16:37:49 -07:00
Drew Powers
656fe46047 docs(circleci): Improve CircleCI troubleshooting docs (#4813)
Adds note about Jest maxWorkers as well as the base image to start with. This is an improvement over the previous section I wrote, from me banging my head against a YAML file all week 🙃.
2019-08-07 08:51:31 -07:00
Drew Powers
374177b433 docs(circleci): Add CircleCI to troubleshooting docs (#4810)
This came from personal difficulties in running Puppeteer tests on CircleCI. I tried to keep the note as brief as possible, while being helpful for an entire CI platform.
2019-08-06 17:18:10 -07:00