Skip to content

Commit

Permalink
fix(docs): fix cli transactions menu (#2593)
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeepc committed May 25, 2023
1 parent d395724 commit 2eb75be
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 34 deletions.
16 changes: 8 additions & 8 deletions docs/docs/cli/creating-transactions.md
@@ -1,19 +1,19 @@
# Creating Transactions

Just like other structures of Tracetest, you can also manager your transactions using the CLI and definition files.
Just like other structures of Tracetest, you can also manage your transactions using the CLI and definition files.

A definition file for a transaction looks like the following:

```yaml
type: Transaction
spec:
name: Test purchase flow
description: Test a flow of purchasing an item
steps:
- ./tests/create-product.yaml
- ./tests/add-product-to-cart.yaml
- ./tests/complete-purschase.yaml
- testID # you can also reference tests by their ids instead of referencing the definition file
name: Test purchase flow
description: Test a flow of purchasing an item
steps:
- ./tests/create-product.yaml
- ./tests/add-product-to-cart.yaml
- ./tests/complete-purschase.yaml
- testID # you can also reference tests by their ids instead of referencing the definition file
```

In order to apply this transaction to your Tracetest instance, make sure to have your [CLI configured](./configuring-your-cli.md) and run:
Expand Down
48 changes: 22 additions & 26 deletions docs/sidebars.js
Expand Up @@ -32,7 +32,8 @@ const sidebars = {
type: "category",
label: "Getting Started",
link: {
type: 'doc', id: 'getting-started/installation'
type: "doc",
id: "getting-started/installation",
},
items: [
{
Expand All @@ -46,7 +47,8 @@ const sidebars = {
type: "category",
label: "Configuration",
link: {
type: 'doc', id: 'configuration/overview'
type: "doc",
id: "configuration/overview",
},
items: [
// {
Expand Down Expand Up @@ -156,7 +158,8 @@ const sidebars = {
type: "category",
label: "Deployment",
link: {
type: 'doc', id: 'deployment/overview'
type: "doc",
id: "deployment/overview",
},
items: [
// {
Expand Down Expand Up @@ -241,11 +244,6 @@ const sidebars = {
type: "category",
label: "Web UI",
items: [
{
type: "doc",
id: "web-ui/creating-environments",
label: "Creating environments",
},
{
type: "doc",
id: "web-ui/creating-tests",
Expand All @@ -266,11 +264,6 @@ const sidebars = {
id: "web-ui/test-results",
label: "Test Results",
},
{
type: "doc",
id: "web-ui/creating-transactions",
label: "Creating transactions",
},
{
type: "doc",
id: "web-ui/exporting-tests",
Expand All @@ -297,11 +290,11 @@ const sidebars = {
id: "cli/creating-data-stores",
label: "Creating Data Stores",
},
// {
// type: "doc",
// id: "cli/creating-environments",
// label: "Creating environments",
// },
{
type: "doc",
id: "cli/creating-environments",
label: "Creating Environments",
},
{
type: "doc",
id: "cli/creating-tests",
Expand All @@ -312,11 +305,11 @@ const sidebars = {
id: "cli/running-tests",
label: "Running Tests",
},
// {
// type: "doc",
// id: "cli/creating-transactions",
// label: "Creating transactions",
// },
{
type: "doc",
id: "cli/creating-transactions",
label: "Creating Transactions",
},
// {
// type: "doc",
// id: "cli/exporting-tests",
Expand All @@ -333,7 +326,8 @@ const sidebars = {
type: "category",
label: "CI/CD Automation",
link: {
type: 'doc', id: 'ci-cd-automation/overview'
type: "doc",
id: "ci-cd-automation/overview",
},
items: [
{
Expand All @@ -347,7 +341,8 @@ const sidebars = {
type: "category",
label: "Tools & Integrations",
link: {
type: 'doc', id: 'tools-and-integrations/overview'
type: "doc",
id: "tools-and-integrations/overview",
},
items: [
{
Expand All @@ -371,7 +366,8 @@ const sidebars = {
type: "category",
label: "Examples & Tutorials",
link: {
type: 'doc', id: 'examples-tutorials/overview'
type: "doc",
id: "examples-tutorials/overview",
},
items: [
{
Expand Down

0 comments on commit 2eb75be

Please sign in to comment.