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

Docs: Browser documentation updates for v1.0.0 #1208

Merged
merged 56 commits into from
Aug 14, 2023
Merged

Docs: Browser documentation updates for v1.0.0 #1208

merged 56 commits into from
Aug 14, 2023

Commits on Aug 4, 2023

  1. Remove this later

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    1195e76 View commit details
    Browse the repository at this point in the history

  2. Remove k6 browser's browser.on method doc (#1197) 

    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.
    @ka3de @inancgumus
    ka3de authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    ed89187 View commit details
    Browse the repository at this point in the history

  3. Update browser example

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    490460c View commit details
    Browse the repository at this point in the history

  4. Update running browser tests

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    162010b View commit details
    Browse the repository at this point in the history

  5. Update browser overview

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    7885bd1 View commit details
    Browse the repository at this point in the history

  6. Update browser metrics

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    457ef6c View commit details
    Browse the repository at this point in the history

  7. Update k6 version to latest 

    Resolves: #1200 (comment)
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    aad2885 View commit details
    Browse the repository at this point in the history

  8. Change testk6 to browser 

    Resolves: #1200 (comment)
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    516f00a View commit details
    Browse the repository at this point in the history

  9. Remove web vitals explanation 

    Resolves: #1200 (comment)
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    ed5419b View commit details
    Browse the repository at this point in the history

  10. Update k6 version to latest

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    aeffe8b View commit details
    Browse the repository at this point in the history

  11. Remove browser module version 

    We no longer use it as we're using k6 versions.
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    2abf2bd View commit details
    Browse the repository at this point in the history

  12. Fix browser example

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    e73d149 View commit details
    Browse the repository at this point in the history

  13. Remove BrowserType 

    As we're now handing off a ready browser from the get to.
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    e4c4b22 View commit details
    Browse the repository at this point in the history

  14. Remove BrowserContext.Browser 

    If users access the browser, they can do undocumented stuff with it.
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    342ab2c View commit details
    Browse the repository at this point in the history

  15. Rename Browser class to module

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    b7c48d5 View commit details
    Browse the repository at this point in the history

  16. Move Browser to the root page

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    3369ce0 View commit details
    Browse the repository at this point in the history

  17. Update the browser module example in the root

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    32e7c0f View commit details
    Browse the repository at this point in the history

  18. Fix links to browser class

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    87986f2 View commit details
    Browse the repository at this point in the history

  19. Rename browsertest to browserTest 

    Co-authored-by: Marie Cruz <mdcruz@users.noreply.github.com>
    @inancgumus @mdcruz
    inancgumus and mdcruz committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    81d81cc View commit details
    Browse the repository at this point in the history

  20. Rephrase browser related text 

    Co-authored-by: Marie Cruz <mdcruz@users.noreply.github.com>
    @inancgumus @mdcruz
    inancgumus and mdcruz committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    f8a5396 View commit details
    Browse the repository at this point in the history

  21. Replace newContext with newPage 

    Resolves: #1200 (comment)
Resolves: #1200 (comment)
Resolves: #1200 (comment)
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    09a57b0 View commit details
    Browse the repository at this point in the history

  22. Remove browser.on 

    Resolves: #1200 (comment)
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    4695b5f View commit details
    Browse the repository at this point in the history

  23. Update browser examples 

    Removes the close method as well.
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    c3dbbd9 View commit details
    Browse the repository at this point in the history

  24. Update running browser tests explanation 

    Resolves: #1200 (comment)
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    5c2725d View commit details
    Browse the repository at this point in the history

  25. Remove browser.close 

    Resolves: #1200 (comment)
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    e4993fa View commit details
    Browse the repository at this point in the history

  26. Remove auto chromium launch explanation 

    Resolves: #1200 (comment)
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    7bf47eb View commit details
    Browse the repository at this point in the history

  27. Rename to fid web vital 

    Renames from webvital_first_input_delay to browser_web_vital_fid.
    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    7ed9fae View commit details
    Browse the repository at this point in the history

  28. Rename to ttfb web vital 

    Rename from webvital_time_to_first_byte to browser_web_vital_ttfb.
    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    eb2f30d View commit details
    Browse the repository at this point in the history

  29. Rename cls web vital 

    Rename from webvital_cumulative_layout_shift to browser_web_vital_cls.
    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    94790f3 View commit details
    Browse the repository at this point in the history

  30. Rename fcp web vital 

    Rename from webvital_first_contentful_paint to browser_web_vital_fcp
    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    b5a752c View commit details
    Browse the repository at this point in the history

  31. Disable vale for web vital metrics reference page

    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    1c65670 View commit details
    Browse the repository at this point in the history

  32. Remove browser.close from the module API

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    8c23da4 View commit details
    Browse the repository at this point in the history

  33. Add browser launch options to the root page 

    Also update the guide to refer to these options for an example.
    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    ba054f3 View commit details
    Browse the repository at this point in the history

  34. Remove unnecessary check

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    9c50c69 View commit details
    Browse the repository at this point in the history

  35. Add link to the browser API root

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    99cd9e3 View commit details
    Browse the repository at this point in the history

  36. Fix the browser guide link

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    1d3be6d View commit details
    Browse the repository at this point in the history

  37. Add browser cmd example

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    732a3fa View commit details
    Browse the repository at this point in the history

  38. Fix typo in browser guide 

    Co-authored-by: ka3de <daniel.jimenez@grafana.com>
    @inancgumus @ka3de
    inancgumus and ka3de committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    5427f8e View commit details
    Browse the repository at this point in the history

  39. Add check back to waitforfunc

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    e5bba26 View commit details
    Browse the repository at this point in the history

  40. Add browser module run example

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    aa4c614 View commit details
    Browse the repository at this point in the history

  41. Update devices example to H2

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    b567e1b View commit details
    Browse the repository at this point in the history

  42. Add headful to vale accepts

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    8514dcd View commit details
    Browse the repository at this point in the history

  43. Update browser.contexts to browser.context 

    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.
    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    158f1a7 View commit details
    Browse the repository at this point in the history

  44. Rename contexts to context

    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    5fba848 View commit details
    Browse the repository at this point in the history

  45. Update newContext to reflect 1-to-1 change 

    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.
    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    356c2e4 View commit details
    Browse the repository at this point in the history

  46. Update newPage to reflect 1-to-1 change 

    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.
    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    2ba2508 View commit details
    Browse the repository at this point in the history

  47. Update src/data/markdown/docs/02 javascript api/07 k6-experimental/01… 

    … browser/context.md

Co-authored-by: ka3de <daniel.jimenez@grafana.com>
    @ankur22 @ka3de @inancgumus
    2 people authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    76a32df View commit details
    Browse the repository at this point in the history

  48. Fix example and close declared page instances

    @ankur22 @inancgumus
    ankur22 authored and inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    1d2d85e View commit details
    Browse the repository at this point in the history

  49. Add browser page close notice (#1270)

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    913786c View commit details
    Browse the repository at this point in the history

  50. Fix unopened blockquote

    @inancgumus
    inancgumus committed Aug 4, 2023
    Configuration menu
    Copy the full SHA
    f8e97e8 View commit details
    Browse the repository at this point in the history

Commits on Aug 7, 2023

  1. Add running browser tests with scenarios notice (#1280)

    @inancgumus
    inancgumus authored Aug 7, 2023
    Configuration menu
    Copy the full SHA
    cde2145 View commit details
    Browse the repository at this point in the history

Commits on Aug 10, 2023

  1. Move some browser docs to recommended practices. 

    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
    inancgumus committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    cb5fc9d View commit details
    Browse the repository at this point in the history

  2. Redirect selecting elements

    @inancgumus
    inancgumus committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    2bfcbbb View commit details
    Browse the repository at this point in the history

  3. Redirect page object model

    @inancgumus
    inancgumus committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    6f62153 View commit details
    Browse the repository at this point in the history

Commits on Aug 11, 2023

  1. update k6 run command to include docker example

    @mdcruz @inancgumus
    mdcruz authored and inancgumus committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    5921afb View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2023

  1. Improve importable properties explanation

    @inancgumus
    inancgumus committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    a4beb46 View commit details
    Browse the repository at this point in the history