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

fix(docs): fixing docs build and variable sets #3047

Merged
merged 3 commits into from Aug 9, 2023
Merged

Conversation

xoscar
Copy link
Collaborator

@xoscar xoscar commented Aug 9, 2023

This PR fixes the docs build as it was failing due to some recent changes. It also updates the environment references to variable sets

Changes

  • Fixes build
  • Moves environment pages to variable sets
  • Adds new screenshots

Fixes

  • docs build

Checklist

  • tested locally
  • added new dependencies
  • updated the docs
  • added a test

https://www.loom.com/share/e8d4feeda9404a2eac319ce41c7d98b4

@xoscar xoscar self-assigned this Aug 9, 2023
@xoscar xoscar added the documentation Improvements or additions to documentation label Aug 9, 2023
@xoscar xoscar marked this pull request as ready for review August 9, 2023 16:00
tracetest apply variableset -f <variableset.yaml>
```

> If the file contains the property `spec.id`, the operation will be considered a variable set update. If you try to apply a variable set and you get an error: `could not apply variableset: 404 Not Found`, it means the provided id doesn't exist. Either update the id to reference an existing variable set, or just remove the property from the file, so Tracetest will create a new variable set and a new id.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> If the file contains the property `spec.id`, the operation will be considered a variable set update. If you try to apply a variable set and you get an error: `could not apply variableset: 404 Not Found`, it means the provided id doesn't exist. Either update the id to reference an existing variable set, or just remove the property from the file, so Tracetest will create a new variable set and a new id.
> If the file contains the property `spec.id`, the operation will be considered a variable set update. If you try to apply a variable set and you get the error: `could not apply variableset: 404 Not Found`, it means the provided ID doesn't exist. Either update the ID to reference an existing variable set or remove the property from the file. Tracetest will create a new variable set and a new ID.

Copy link
Member

@jfermi jfermi left a comment

Choose a reason for hiding this comment

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

Some minor editing suggestions.

@@ -29,7 +29,7 @@ outputs:
expression: attr:tracetest.time.start
```

This would create an output called `TIME_CANCEL_SUBSCRIPTION_MESSAGE_OBTAINED` that is obtained by reading the attribute `tracetest.time.start` from the span with `name` equal to `Process request from cancel subscription queue`. This value would would then be injected into the environment variables of that transaction to be accessed by other tests within the same transaction run.
This would create an output called `TIME_CANCEL_SUBSCRIPTION_MESSAGE_OBTAINED` that is obtained by reading the attribute `tracetest.time.start` from the span with `name` equal to `Process request from cancel subscription queue`. This value would would then be injected into the variables of that transaction to be accessed by other tests within the same transaction run.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This would create an output called `TIME_CANCEL_SUBSCRIPTION_MESSAGE_OBTAINED` that is obtained by reading the attribute `tracetest.time.start` from the span with `name` equal to `Process request from cancel subscription queue`. This value would would then be injected into the variables of that transaction to be accessed by other tests within the same transaction run.
This would create an output called `TIME_CANCEL_SUBSCRIPTION_MESSAGE_OBTAINED` that is obtained by reading the attribute `tracetest.time.start` from the span with `name` equal to `Process request from cancel subscription queue`. This value would then be injected into the variables of that transaction to be accessed by other tests within the same transaction run.

@xoscar xoscar merged commit 6301dbd into main Aug 9, 2023
30 checks passed
@xoscar xoscar deleted the fix/docs-variable-sets branch August 9, 2023 20:38
danielbdias pushed a commit that referenced this pull request Aug 11, 2023
* fix(docs): fixing docs build and variable sets

* Fixing test suite id param

* pr comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants