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

feat: add documentation #8593

Merged
merged 1 commit into from Jul 1, 2022
Merged

feat: add documentation #8593

merged 1 commit into from Jul 1, 2022

Conversation

jrandolf
Copy link
Contributor

@jrandolf jrandolf commented Jun 28, 2022 •
edited

This PR implements a new site generated by docusaurus and api-documenter.

  • All links have been changed to reference the site directly.
  • The CI and pre-release workflow have been inoculated with documentation generation and deployment tooling to automate documentation CI/CD.
    • During pre-release, documentation is versioned and amended into the release PR. See https://docusaurus.io/docs/versioning for more information.
    • Upon merge (happens always during CI), documentation is uploaded.
  • Post-release process has been removed.

Fixes: #8587
TODO: #8599, #8604, #8605

@jrandolf jrandolf requested a review from OrKoN June 28, 2022 11:02
@jrandolf jrandolf force-pushed the doc2 branch 14 times, most recently from f92abd4 to 40c9f8b Compare June 28, 2022 15:05
@jrandolf jrandolf linked an issue Jun 28, 2022 that may be closed by this pull request
The PR to unfreeze the docs should be done by the bot account #8587
Closed
@jrandolf jrandolf force-pushed the doc2 branch 14 times, most recently from c9591fd to 00cc870 Compare June 28, 2022 18:55
@jrandolf jrandolf force-pushed the doc2 branch 5 times, most recently from 1143aa3 to 55d62d2 Compare June 30, 2022 16:46
@OrKoN
Copy link
Collaborator

OrKoN commented Jul 1, 2022

  1. do we need website/static/img/docusaurus.png ?
  2. could you please double check that appropriate license headers are included into the new files?
  3. the issue from this comment feat: add documentation #8593 (comment) is still occurring?

@jrandolf jrandolf force-pushed the doc2 branch 2 times, most recently from 3cffe65 to 9b6f957 Compare July 1, 2022 11:20
OrKoN
OrKoN approved these changes Jul 1, 2022
View reviewed changes
Copy link
Collaborator

@OrKoN OrKoN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM % remove docuasarus images

@jrandolf jrandolf enabled auto-merge (squash) July 1, 2022 11:35
@jrandolf jrandolf disabled auto-merge July 1, 2022 11:46
@jrandolf jrandolf enabled auto-merge (squash) July 1, 2022 11:46
@jrandolf jrandolf disabled auto-merge July 1, 2022 11:48
@jrandolf jrandolf enabled auto-merge (squash) July 1, 2022 11:48
@jrandolf jrandolf merged commit 066f440 into main Jul 1, 2022
@jrandolf jrandolf deleted the doc2 branch July 1, 2022 11:52
@release-please release-please bot mentioned this pull request Jul 1, 2022
Merged
@YusukeIwaki YusukeIwaki mentioned this pull request Aug 14, 2022
Merged
y-yagi added a commit to y-yagi/puppeteer that referenced this pull request Oct 24, 2022
@y-yagi
chore: mention default value of timeout for page.pdf() and how to…
0d4054e 
… disable it

This was mentioned in the PR that adding this feature puppeteer#7508
But it has lost at puppeteer#8593.

I'm not sure why this was removed, but I think this info is useful for users.
@y-yagi y-yagi mentioned this pull request Oct 24, 2022
Closed
y-yagi added a commit to y-yagi/puppeteer that referenced this pull request Oct 26, 2022
@y-yagi
docs: mention how to disable timeout for page.pdf()
0db6a77 
This was mentioned in the PR that adding this feature puppeteer#7508
But it has lost at puppeteer#8593.

I'm not sure why this was removed, but I think this info is useful for users.
@y-yagi y-yagi mentioned this pull request Oct 26, 2022
Merged
OrKoN pushed a commit to y-yagi/puppeteer that referenced this pull request Nov 3, 2022
@y-yagi @OrKoN
docs: mention how to disable timeout for page.pdf()
d2a4b6e 
This was mentioned in the PR that adding this feature puppeteer#7508
But it has lost at puppeteer#8593.

I'm not sure why this was removed, but I think this info is useful for users.
OrKoN pushed a commit to y-yagi/puppeteer that referenced this pull request Dec 12, 2022
@y-yagi @OrKoN
docs: mention how to disable timeout for page.pdf()
6c122cd 
This was mentioned in the PR that adding this feature puppeteer#7508
But it has lost at puppeteer#8593.

I'm not sure why this was removed, but I think this info is useful for users.
OrKoN pushed a commit to y-yagi/puppeteer that referenced this pull request Dec 12, 2022
@y-yagi @OrKoN
docs: mention how to disable timeout for page.pdf()
5ae012c 
This was mentioned in the PR that adding this feature puppeteer#7508
But it has lost at puppeteer#8593.

I'm not sure why this was removed, but I think this info is useful for users.
OrKoN pushed a commit that referenced this pull request Dec 12, 2022
@y-yagi
docs: mention how to disable timeout for page.pdf() (#9167)
a304543 
**What kind of change does this PR introduce?**

Add how to disable timeout for `page.pdf()`.

**Summary**

This was mentioned in the PR that adding this feature
#7508 But it has lost at
#8593.

I'm not sure why this was removed, but I think this info is useful for
users.

**Does this PR introduce a breaking change?**

no
@yairvargasromero yairvargasromero mentioned this pull request Feb 4, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OrKoN OrKoN OrKoN approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

The PR to unfreeze the docs should be done by the bot account
2 participants
@jrandolf @OrKoN