Document k6/experimental/fs module

[oleiade]

The k6/experimental/fs module will land in v0.48.0 and will empower users to read files efficiently and conveniently within their k6 scripts.

This Pull Request documents the module's APIs.

[codebien]

@oleiade does it work make docs for you? I wasn't able to see the preview with the current changes included.

[oleiade]

@codebien make docs does work on my side, what error are you experiencing?

$ cd docs/

$ make docs
docker pull -q grafana/docs-base:latest
docker.io/grafana/docs-base:latest
/Users/theocrevon/Dev/grafana/documentation/k6-docs/docs/make-docs k6:UNVERSIONED:k6-docs
node scripts/docs/versions.js
k6 -> v0.47.x
/usr/local/bin/hugo server --environment=docs -p 3003 --buildDrafts=false --buildFuture=false --bind 0.0.0.0 --noHTTPCache --minify --poll 700ms --renderToDisk -d dist | grep -Ev 'REF_NOT_FOUND: Ref "/(go|blog)/'
Start building sites …
hugo v0.115.2 linux/arm64 BuildDate=unknown


                   |  EN  |  DE  |  FR  |  ES  | PT-BR | ZH-CN
-------------------+------+------+------+------+-------+--------
  Pages            | 2328 |   12 |   12 |   12 |    12 |    12
  Paginator pages  |    0 |    0 |    0 |    0 |     0 |     0
  Non-page files   |    0 |    0 |    0 |    0 |     0 |     0
  Static files     | 1274 | 1274 | 1274 | 1274 |  1274 |  1274
  Processed images |    0 |    0 |    0 |    0 |     0 |     0
  Aliases          |    4 |    0 |    0 |    0 |     0 |     0
  Sitemaps         |    2 |    1 |    1 |    1 |     1 |     1
  Cleaned          |    0 |    0 |    0 |    0 |     0 |     0

Built in 2541 ms
Watching for changes in /hugo/{content,data,i18n,layouts,package.json,static}
Use watcher with poll interval 700ms
Watching for config changes in /hugo/config/_default, /hugo/config/docs
Environment: "docs"
Serving pages from disk
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender

View documentation locally:
                             http://localhost:3002/docs/k6/

                                                           Press Ctrl+C to stop the server

[heitortsergent]

Left a few comments, mostly small nits!

[heitortsergent]

Just as a comment, the {{< code >}} shortcode main purpose is to support multiple code snippets (how to do X in JavaScript, and in Ruby, for example). It still works if you have a single code snippet inside of it, but we don't necessarily need it here. 😄

[oleiade]

Oh, that's good to know! I think it still makes sense to have it even with a single example? Makes it more explicit too as it will display "Javascript" above the code right?

[heitortsergent]

You still get the "JavaScript" title even without the code shortcode. (I wasn't sure about it so I tested it out 😆). The only UI difference seems to be the underline in the shortcode version.