Skip to content

Conversation

mdcruz
Copy link
Contributor

@mdcruz mdcruz commented Jan 23, 2023

This PR has the following changes for the xk6-browser documentation, which needs to be merged after v.0.43.0 release

  • Code examples to use async/await
  • Path updated to "k6/experimental/browser"
  • Removal of eslint-skip on the browser code examples
  • Path updated from xk6-browser to k6-browser (Need to test on Staging env.)
  • Link k6 browser docs to k6/experimental (short-term)

@github-actions
Copy link
Contributor

There's a version of the docs published here:

https://mdr-ci.staging.k6.io/docs/refs/pull/996/merge

It will be deleted automatically in 30 days.

@inancgumus inancgumus self-requested a review January 24, 2023 11:17
Copy link
Contributor

@inancgumus inancgumus left a comment

Choose a reason for hiding this comment

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

LGTM 👏 Thanks for this!!

Copy link
Contributor

@ankur22 ankur22 left a comment

Choose a reason for hiding this comment

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

The import paths will need to change after we complete the merge.

Looks good otherwise, thanks for this!

@mdcruz mdcruz force-pushed the update-xk6-browser-docs branch from f3db542 to a4fd4b9 Compare February 8, 2023 11:47
@mdcruz mdcruz force-pushed the update-xk6-browser-docs branch from 4ed1018 to 98aeb88 Compare February 8, 2023 17:16
@mdcruz mdcruz force-pushed the update-xk6-browser-docs branch from 0d8d5f5 to ba32672 Compare February 9, 2023 11:50
@mdcruz mdcruz force-pushed the update-xk6-browser-docs branch from ba32672 to 0ea0174 Compare February 9, 2023 11:52
@mdcruz mdcruz changed the title Draft: update xk6-browser code examples to async/await update xk6-browser code examples to async/await Feb 9, 2023
@mdcruz mdcruz removed the WIP label Feb 9, 2023
@mdcruz mdcruz requested review from andrewslotin and ka3de February 9, 2023 13:46
Copy link
Contributor

@ka3de ka3de left a comment

Choose a reason for hiding this comment

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

Awesome @mdcruz ! 🥇
I added a couple of small comments.

Besides the content, I personally like the change from xk6-browser naming to k6 browser, but, as mentioned, I will not enter in discussing organization matters in terms of where should these docs be placed etc as I believe I'm not the best person to do that.

Copy link
Contributor

@inancgumus inancgumus left a comment

Choose a reason for hiding this comment

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

Nice work 👏

I have one suggestion and this comment about Docker.

mdcruz and others added 2 commits February 10, 2023 18:02
…setDefaultTimeout.md

Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
Copy link
Contributor

@inancgumus inancgumus left a comment

Choose a reason for hiding this comment

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

Re-approved 😄

@mdcruz mdcruz requested a review from ppcano February 13, 2023 16:43
Copy link
Contributor

@ka3de ka3de left a comment

Choose a reason for hiding this comment

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

LGTM.

@imiric
Copy link
Contributor

imiric commented Feb 20, 2023

@mdcruz k6 v0.43.0 was just released, and v0.42.0 docs have been archived. Can we merge this PR?

@mdcruz
Copy link
Contributor Author

mdcruz commented Feb 20, 2023

@mdcruz k6 v0.43.0 was just released, and v0.42.0 docs have been archived. Can we merge this PR?

All good from my side and I have addressed @ankur22's comments 👍🏼

Copy link
Contributor

@ankur22 ankur22 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for this! 🙏

@mdcruz mdcruz merged commit 4cde4e9 into main Feb 20, 2023
@mdcruz mdcruz deleted the update-xk6-browser-docs branch February 20, 2023 14:13
@inancgumus inancgumus added the Area: browser The browser module label Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: browser The browser module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants