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.

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

Create best practice for browser module #1719

Open
2 tasks
ankur22 opened this issue Sep 13, 2024 · 0 comments
Open
2 tasks

Create best practice for browser module #1719

ankur22 opened this issue Sep 13, 2024 · 0 comments
Assignees
Labels
Area: browser The browser module Area: Cloud Content Docs issues about k6 Cloud Area: OSS Content Improvements or additions to community/oss documentation Priority: High type/docs

Comments

@ankur22
Copy link
Contributor

ankur22 commented Sep 13, 2024

What

Currently there are no best practice documentation when it comes to working with the browser module. Within the community and customer base, there's usually some confusion as to how to work with the APIs, which APIs to use, how to work with selectors and how to read the test results.

How

The first step is to start on a best practice doc, and the first topic should be on working with page.waitForTimeout instead of sleep. It should explain:

  1. why page.waitForTimeout is better than sleep;
  2. when to use it;
  3. how to use it with examples;
  4. future plans on visualising it in results in our cloud offering.

My tasks

@ankur22 ankur22 changed the title Create docs on working with page.waitForTimeout instead of sleep Create best practice for browser module Sep 13, 2024
@ankur22 ankur22 added Area: OSS Content Improvements or additions to community/oss documentation Priority: High Area: browser The browser module Area: Cloud Content Docs issues about k6 Cloud type/docs labels Sep 13, 2024
@ankur22 ankur22 self-assigned this Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: browser The browser module Area: Cloud Content Docs issues about k6 Cloud Area: OSS Content Improvements or additions to community/oss documentation Priority: High type/docs
Projects
None yet
Development

No branches or pull requests

1 participant