Update xk6-browser docs for release v0.5.0 #789
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Unfortunately, links in h3s are not supported :-/
Resolves: #642 (comment) Resolves: #642 (comment) Resolves: #642 (comment) Resolves: #642 (comment) Resolves: #642 (comment) Resolves: #642 (comment) Resolves: #642 (comment)
- Finish the browser.newContext list - Started on browser.newPage
+ Removes descriptions of missing APIs (See: #508 (comment)) + Formats input and return value tables for all. + Adds a link for browser.close so that the link in browser.on description works. + Updates browser.on() to browser.on('disconnected') per Playwright docs
As discussed on Slack, methods with arguments don't work.
For example:
+ browser.on('disconnected') fails the Gatsby server.
+ browser.newContext([options]) has an invalid link on the left
navigation menu.
+ browser.newPage is similar to newContext.
We need to figure out how to move forward with these problems.
Almost finished. We should fix the navigation link problem, though. That's why I omitted the input parameters from the headers. It does not look good—we should fix them.
According to the discussion in #656 .
- Add a column to make it clear which features have been implemented, wip, or need to be started. - Add issues in the description for wip features.
- Add the tooltip to the emoji to descrive what it means. - If there is an issue open for the feature then link to it from the emoji. Resolves: #722 (comment)
By highlighting what isn't implemented and what is WIP, it makes it clearer for the reader to know what does work. Eventually all emojis will disappear signifying a fully functioning class. Resolves: #722 (comment)
It's only worth documenting what works and what is WIP. We've already mentioned that we're rough compatibility with playwright, and not replicating it fully. Resolves: #722 (comment)
Resolves: #722 (comment)
Also ensure that the example in newPage options page uses the correct method (browser.newPage()) instead of working with the context.
ankur22
force-pushed
the
docs/582-xk6-browser
branch
from
938e088 to
72baf02
Compare
Co-authored-by: Marie Cruz <mdcruz@users.noreply.github.com>
mdcruz
approved these changes
Sep 6, 2022
ankur22
changed the title
Now that we import chromium, which is essentially a BrowserType, we should document that as a separate class type and move it out of the landing page. In the landing page we should document the top level properties. Closes: grafana/xk6-browser#486
Co-authored-by: Ivan Mirić <ivan.miric@grafana.com>
Add the missing methods for BrowserType. Some of the methods have not been implemented so leave them as WIP. Also move the options and return details for each of the methods into their own page. This change will also make it consistent with the other classes. Resolves: /~https://github.com/grafana/k6-docs/pull/788/files#r963406887
inancgumus
approved these changes
Sep 8, 2022
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/01 Browser/close.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/01 Browser/contexts.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/01 Browser/contexts.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/01 Browser/isconnected.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/01 Browser/newcontext--options--.md
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/01 Browser/on--event--.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/02 BrowserContext/pages.md
Outdated
Show resolved
Hide resolved
Document the BrowserType class in its own page and document the top level module properties on the landing page
Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
ankur22
force-pushed
the
docs/582-xk6-browser
branch
from
7d95d3e to
2c107a1
Compare
ankur22
added a commit
that referenced
this pull request
Sep 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR incorporates the following PRs that have been approved and merged in:
locatorxk6-browser#459chromiuminstead oflauncherxk6-browser#465BrowserTypeJS API documentation xk6-browser#486