Docs: Browser documentation updates for v1.0.0 #1208
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
|
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/1208/merge It will be deleted automatically in 30 days. |
This was referenced Jun 8, 2023
inancgumus
force-pushed
the
update/browser-cloud-updates
branch
2 times, most recently
from
7a84879
to
ad97215
Compare
ankur22
force-pushed
the
update/browser-cloud-updates
branch
from
ad97215
to
b47ee30
Compare
inancgumus
changed the title
inancgumus
changed the title
inancgumus
changed the title
Due to the changes made to k6 browser's API, for which the browser's launch and close methods are no longer delegated/exposed to end users, but instead handled automatically by the extension's implementation itself, the browser.on() method is no longer applicable, as it was only supporting the 'disconnect' event type. Therefor it is no longer exposed to the JS API and removed from the documentation.
Resolves: #1200 (comment)
We no longer use it as we're using k6 versions.
As we're now handing off a ready browser from the get to.
Co-authored-by: ka3de <daniel.jimenez@grafana.com>
We've made a change which means that there is now a 1-to-1 mapping between browser and a browserContext. This means that there can only ever be one browserContext open at any given point per browser. So the contexts method on browser now only needs to return the current browserContext.
The discription on browser.newContext needs to reflect the new change where only one browserContext can be open at any given time per browser. We need to notify the user how they can work with this new behaviour.
The description on browser.newPage needs to reflect the new change where only one browserContext can be open at any given time per browser. We need to notify the user how they can work with this new behaviour.
… browser/context.md Co-authored-by: ka3de <daniel.jimenez@grafana.com>
inancgumus
force-pushed
the
update/browser-cloud-updates
branch
from
4a6e6b2
to
913786c
Compare
inancgumus
changed the title
The main reason of this change is to collect recommended practices of using k6 browser under a single menu. We have usage examples already in the other API documents. These examples are more like "recommended practices". Also, "Recommended practices and examples" didn't fit the menu and become weird like "Recommended practices an..."
inancgumus
force-pushed
the
update/browser-cloud-updates
branch
from
d44da73
to
5921afb
Compare
src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser.md
Show resolved
Hide resolved
inancgumus
changed the title
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 collects all the phase 1 cloud updates for the browser.
🚨 For changes to this PR's branch, please open a new PR, and once your PR is approved, rebase merge your PR to this branch instead of
main.Tasks
checkfrom the root browser module API example as it is not used.runcommand examples. See for more info.newContextand its options.main