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

Add xk6 documentation #169

Closed
imiric opened this issue Dec 2, 2020 · 2 comments · Fixed by #346
Closed

Add xk6 documentation #169

imiric opened this issue Dec 2, 2020 · 2 comments · Fixed by #346
Assignees
Labels
Area: OSS Content Improvements or additions to community/oss documentation

Comments

@imiric
Copy link
Contributor

imiric commented Dec 2, 2020

As discussed internally, we should add a high-level page in the docs that explains xk6, what it is, how to use it, etc., without going too much into details about developing an extension or showing any Go code for that matter.

This should include a large visible warning about the experimental stage of the project, no API stability guarantees, etc., and maybe a list of trusted extensions (the same ones mentioned in the upcoming article?) and link to https://github.com/topics/xk6.

@imiric imiric added the Area: OSS Content Improvements or additions to community/oss documentation label Dec 2, 2020
@na--
Copy link
Member

na-- commented Mar 11, 2021

Just a reminder that k6 v0.31.0 will bring support for output extensions as well, so those should also be documented.

@na-- na-- self-assigned this Mar 11, 2021
@imiric imiric assigned imiric and unassigned na-- Jun 14, 2021
@simskij
Copy link
Contributor

simskij commented Jun 14, 2021

From #338

A more factual/docsy version of what @imiric wrote for the blog at https://k6.io/blog/extending-k6-with-xk6/. Should include:

  • How to build an xk6 binary
  • How to utilize built-in modules in your script
  • Considerations and drawbacks for different running modes, like:
    • Locally
    • Operator
    • Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: OSS Content Improvements or additions to community/oss documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants