Skip to content

Updates to Extensions section #2034

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

heitortsergent
Copy link
Collaborator

@heitortsergent heitortsergent commented Aug 12, 2025

What?

Updates to the extension section.

  • Update _index page to include an overview of k6 extensions.
  • Update structure for Explore extensions page.
  • Remove "Explanations" folder and move pages to "Create an extension" section.
  • Small style guide edits.

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the npm start command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/k6/next folder of the documentation.
  • I have reflected my changes in the docs/sources/k6/v{most_recent_release} folder of the documentation.
  • I have reflected my changes in the relevant folders of the two previous k6 versions of the documentation (if still applicable to previous versions).

Related PR(s)/Issue(s)

#2030

@@ -6,7 +6,32 @@ weight: 700

# Extensions
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@dgzlopes do you think we should get rid of all of this information?

I know we have other sections that just include the {{< section >}} shortcode, but I do think the information we had on this page was helpful.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see you removed a bunch of things we had there originally 👀

It's much better. Still, the use cases are outdated. xk6-kubernetes is not officially maintained. Prometheus RW is now in core, so being an extension is not relevant. The last one about distributed tracing is archived.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ok, that's helpful! I removed the use cases section, we do at least list some use cases when talking about the types of extensions in the introduction.

@@ -1,67 +1,65 @@
---
title: 'Explore extensions'
menuTitle: 'Explore extensions'
description: 'Explore the k6 extension ecosystem to find extensions that meet your requirements.'
description: 'Explore the k6 extension ecosystem to find extensions that fit your use cases.'
weight: 01
---

# Explore extensions
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@dgzlopes wanted to ask you again here, I saw there were some conversations around how to organize the official/community vs cloud/custom binary extensions.

What do you think if we change the headings on this page to what I did here:

  • Official extensions
  • Community extensions
  • Use extensions
    • Automatic extension resolution
    • Custom k6 binary

If that doesn't sound good, I can change it back, I just might tweak the headings a little bit.

Copy link
Contributor

Choose a reason for hiding this comment

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

This new iteration looks good to me 👍

@heitortsergent heitortsergent self-assigned this Aug 12, 2025
@heitortsergent heitortsergent added the Area:extensions Issues about the extension ecosystem label Aug 12, 2025
@heitortsergent heitortsergent marked this pull request as ready for review August 13, 2025 15:49
@heitortsergent heitortsergent requested a review from a team as a code owner August 13, 2025 15:49
@heitortsergent heitortsergent requested review from szkiba and removed request for a team August 13, 2025 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area:extensions Issues about the extension ecosystem
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants