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

Group Examples pages into sections #1767

Open
heitortsergent opened this issue Oct 8, 2024 · 1 comment
Open

Group Examples pages into sections #1767

heitortsergent opened this issue Oct 8, 2024 · 1 comment
Assignees
Labels
Area: OSS Content Improvements or additions to community/oss documentation examples Issues about a missing example type/docs Type: needsMaintainerHelp Good issue for k6 maintainers

Comments

@heitortsergent
Copy link
Collaborator

heitortsergent commented Oct 8, 2024

The Examples section of our docs is really helpful, but it can be hard to find what you're looking for when looking at the menu.

Image

We should try to find common themes for the Example pages and group them into sections so users can find them more easily.

@tom-miseur and I have come up with a first draft:

  • HTTP authentication
    • OAuth authentication
  • HTTP scripting
    • Correlation and Dynamic data
    • Data parameterization
    • Parse HTML
    • HTML forms
    • Cookies example
    • Data uploads
    • API CRUD operations
    • SOAP
    • URLs with query parameters
    • Functional testing
    • Get timings for an HTTP metric
  • Test design
    • Distribute workloads across VUs
    • Error handling
  • Utility
    • Generating UUIDs
    • Track transmitted data per URL
    • Generating realistic data
  • Protocols
    • HTTP2
    • WebSockets
  • Security
    • Transport Layer Security

Are there other ways we could structure this?

@heitortsergent heitortsergent self-assigned this Oct 8, 2024
@heitortsergent heitortsergent added Area: OSS Content Improvements or additions to community/oss documentation Type: needsMaintainerHelp Good issue for k6 maintainers examples Issues about a missing example type/docs labels Oct 8, 2024
@ankur22
Copy link
Contributor

ankur22 commented Oct 9, 2024

Are there other ways we could structure this?

Browser tests. Such as:

  • Hybrid testing
  • Any others? 🤔

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 examples Issues about a missing example type/docs Type: needsMaintainerHelp Good issue for k6 maintainers
Projects
None yet
Development

No branches or pull requests

2 participants