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

Move Test authoring section to root level of docs #1867

Open
heitortsergent opened this issue Feb 13, 2025 · 0 comments · May be fixed by #1868
Open

Move Test authoring section to root level of docs #1867

heitortsergent opened this issue Feb 13, 2025 · 0 comments · May be fixed by #1868
Assignees
Labels
Area: OSS Content Improvements or additions to community/oss documentation type/docs

Comments

@heitortsergent
Copy link
Collaborator

Related to #1860.

From feedback with folks on the team, the k6 OSS docs don't have a clear section focused on how to write tests. We explain all the options available for how to use k6, but we are missing a clear "How to write tests" section. This is something that we have in the Grafana Cloud k6 docs, under "Author and run tests".

We do have a "Test authoring" section two levels deep in the current IA. We've just added a new page to it documenting the k6 new command, but this seems like a good time to update that section and bring it up in the current hierarchy.

We could:

  • Move the "Test authoring section" to the root level, above "Using k6".
  • Rename the section to "Author and run tests" to match the Grafana Cloud k6 docs.
  • Add content to the index page for the section.
  • Review the existing pages in that section (Test builder, Create tests from a recording)
@heitortsergent heitortsergent self-assigned this Feb 13, 2025
@heitortsergent heitortsergent added type/docs Area: OSS Content Improvements or additions to community/oss documentation labels Feb 13, 2025
@heitortsergent heitortsergent linked a pull request Feb 13, 2025 that will close this issue
7 tasks
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 type/docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant