tracetest icon indicating copy to clipboard operation
tracetest copied to clipboard

Docs: Break Creating Tests into different pages per trigger type

Open kdhamric opened this issue 1 year ago • 2 comments

Currently, 'Creating Tests' is a single page that shows how to create a test with a HTTP based trigger. Tracetest supports 6 other trigger types:

  1. gRPC
  2. Kafka
  3. TraceID
  4. Cypress
  5. Playwright
  6. k6

For importing tests, we have a page detailing each way to import a test (definition, cURL, and Postman).

Proposal: Create detailed pages for each of the 6 trigger types above, and have 'Creating Tests' expand to show the 6 options. Each page should:

  • if appropriate, discuss the why / benefit (what does Tracetest add to a Cypress test, for example). This should be brief as this is a 'how to' page and not marketing, but we should at least state it.
  • detail the steps to create a test with that test type
  • link to any specific recipes or examples that show how to use that trigger type. May want to link to the marketing integration page for that product if appropriate (example: https://tracetest.io/integrations/cypress or https://tracetest.io/integrations/k6)

Impetus for doing this work: We recently had a user ask how to create a TraceID based test, and we did not have a great link to point them to. In addition, having dedicated pages to create tests based on these keywords such as 'Creating a Kafka based test' will be attractive for individuals looking for solutions for particular technologies such as k6, Kafka, gRPC, Cypress and Playwright.

@adnanrahic Wanted your thoughts before we decide to work on this. Once we get that, lets have @jfermi create the pages. For topics such as Playwright, Cypress & k6 that are fully documented on separate pages, we can have a short paragraph stating what it is for an pointing to the alternative page(s).

image

image

image

kdhamric avatar Feb 05 '24 20:02 kdhamric

@kdhamric @jfermi I like this idea a lot. Let's pull the trigger and start working on it ASAP.

adnanrahic avatar Feb 06 '24 08:02 adnanrahic

Step 1 is done!

PR: https://github.com/kubeshop/tracetest/pull/3750

adnanrahic avatar Apr 01 '24 11:04 adnanrahic

Step 2 is done!

PR: https://github.com/kubeshop/tracetest/pull/3828

adnanrahic avatar Apr 26 '24 13:04 adnanrahic

Live:

  • https://docs.tracetest.io/web-ui/creating-tests
  • https://docs.tracetest.io/cli/creating-tests

adnanrahic avatar Apr 26 '24 14:04 adnanrahic