docs: add comprehensive k6/x/dns extension documentation #2073
Conversation
oleiade
force-pushed
the
document-k6-x-dns
branch
from
81b9c46 to
228a414
Compare
|
💻 Deploy preview deleted (docs: add comprehensive k6/x/dns extension documentation). |
oleiade
force-pushed
the
document-k6-x-dns
branch
2 times, most recently
from
8083bb5 to
a096157
Compare
heitortsergent
left a comment
heitortsergent
left a comment
There was a problem hiding this comment.
Thanks for creating these docs @oleiade 🙇 .
A lot of my comments are just removing the code shortcode, we only need them for tabbed code samples.
You can also replace some of the <!-- md-k6:skip --> statements and just add a <!-- md-k6:skipall --> at the top of the page. I'm happy to make that change if you want to, just let me know. 🙇
AGENTS.md
Outdated
| @@ -0,0 +1,30 @@ | |||
| # Repository Guidelines | |||
There was a problem hiding this comment.
This is really helpful @oleiade! I just added the AGENTS.md file with the instructions we have for general technical writing guidance in a previous PR, but maybe we can merge them together?
| } | ||
| ``` | ||
|
|
||
| {{< /code >}} |
There was a problem hiding this comment.
| {{< /code >}} |
oleiade
force-pushed
the
document-k6-x-dns
branch
from
429e5aa to
36a4b7f
Compare
- Add complete documentation for k6/x/dns module with _index.md overview - Create resolve.md documenting dns.resolve() function with parameters, examples, and error handling - Create lookup.md documenting dns.lookup() function for system DNS resolution - Include installation instructions, API reference, and metrics documentation - Add comprehensive examples for IPv4/IPv6 resolution, performance testing, and validation - Use IPv6 DNS server (2606:4700:4700::1111) in IPv6 examples for consistency - Replace check() usage with k6-jslib-testing expect() assertions throughout examples - Follow k6 documentation conventions matching existing API documentation structure
oleiade
force-pushed
the
document-k6-x-dns
branch
from
36a4b7f to
fa137c5
Compare
|
Thanks @heitortsergent! Addressed all your comments 🙇🏻 |
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
2 participants
What?
This pull request adds comprehensive documentation for the new
k6/x/dnsextension module, which enables DNS resolution testing in k6. The documentation introduces the module, details its API, provides usage examples, explains error handling, and describes the metrics generated. The changes are organized into three new documentation pages: an overview, and detailed pages for theresolveandlookupfunctions.New documentation for the DNS extension:
Overview and Introduction
docs/sources/k6/next/javascript-api/k6-x-dns/_index.mdwith an overview of thek6/x/dnsmodule, its key features, use cases, API summary, available metrics, and practical code examples for DNS testing scenarios.API Reference and Usage Details
docs/sources/k6/next/javascript-api/k6-x-dns/resolve.mdwith detailed documentation for thedns.resolve()function, including parameters, return values, usage examples (A and AAAA record resolution, multiple DNS servers, performance comparison), error handling, metrics, and important notes on usage.docs/sources/k6/next/javascript-api/k6-x-dns/lookup.mdwith detailed documentation for thedns.lookup()function, including parameters, return values, usage examples (basic lookup, comparison with custom DNS, load testing, configuration validation), error handling, metrics, and usage notes.Checklist
npm startcommand locally and verified that the changes look good.docs/sources/k6/nextfolder of the documentation.Related PR(s)/Issue(s)