ZachG update parametric documentation and add contributing doc #3325
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tp client in parametric.md
…server links for parametric.md
ZStriker19
commented
Nov 14, 2024
ZStriker19
commented
Nov 14, 2024
…ests into zachg/docs_contributing
mtoffl01
reviewed
Nov 14, 2024
cbeauchesne
requested changes
Nov 15, 2024
Co-authored-by: Charles de Beauchesne <[email protected]>
Co-authored-by: Mikayla Toffler <[email protected]>
Co-authored-by: Mikayla Toffler <[email protected]>
Co-authored-by: Mikayla Toffler <[email protected]>
Co-authored-by: Mikayla Toffler <[email protected]>
Co-authored-by: Mikayla Toffler <[email protected]>
Co-authored-by: Mikayla Toffler <[email protected]>
Co-authored-by: Mikayla Toffler <[email protected]>
Co-authored-by: Mikayla Toffler <[email protected]>
ZStriker19
commented
Nov 25, 2024
ZStriker19
commented
Nov 25, 2024
ZStriker19
commented
Nov 25, 2024
mabdinur
reviewed
Nov 26, 2024
ZStriker19
commented
Nov 26, 2024
Co-authored-by: Munir Abdinur <[email protected]>
Co-authored-by: Munir Abdinur <[email protected]>
ZStriker19
commented
Nov 26, 2024
ZStriker19
commented
Nov 26, 2024
ZStriker19
commented
Nov 26, 2024
ZStriker19
commented
Nov 26, 2024
mtoffl01
requested changes
Nov 26, 2024
Co-authored-by: Mikayla Toffler <[email protected]>
…ests into zachg/docs_contributing
Co-authored-by: Mikayla Toffler <[email protected]>
ZStriker19
commented
Nov 26, 2024
Co-authored-by: Mikayla Toffler <[email protected]>
ZStriker19
commented
Nov 26, 2024
Co-authored-by: Mikayla Toffler <[email protected]>
mabdinur
approved these changes
Nov 26, 2024
Co-authored-by: Munir Abdinur <[email protected]>
mtoffl01
approved these changes
Nov 27, 2024
There was a problem hiding this comment.
Some small nits but otherwise, good to go.
But also, since you said your docs don't contain contributing information for weblog, can you just make the change in your PR to remove the empty [TODO]: LINK TO CONTRIBUTING DOC link in this doc? https://github.com/DataDog/system-tests/blob/main/docs/edit/enable-test.md
|
|
||
| Several key points: | ||
|
|
||
| * Each new feature should be defined in [_features.py](/utils/_features.py). This consists of adding a feature in [Feature Parity Dashbaord](https://feature-parity.us1.prod.dog/), get the feature id and copying one of the already added features, changing the name and the feature id in the url, and the feature number. In this case we'd add |
There was a problem hiding this comment.
Suggested change
| * Each new feature should be defined in [_features.py](/utils/_features.py). This consists of adding a feature in [Feature Parity Dashbaord](https://feature-parity.us1.prod.dog/), get the feature id and copying one of the already added features, changing the name and the feature id in the url, and the feature number. In this case we'd add | |
| * Each new feature should be defined in [_features.py](/utils/_features.py). This consists of adding a feature in [Feature Parity Dashboard](https://feature-parity.us1.prod.dog/), get the feature id and copying one of the already added features, changing the name and the feature id in the url, and the feature number. In this case we'd add |
| return test_object | ||
| ``` | ||
|
|
||
| * One class test one feature |
There was a problem hiding this comment.
Suggested change
| * One class test one feature | |
| * One class tests one feature |
|
|
||
| 1. `./utils/scripts/parametric/run_reference_http.sh` | ||
| 2. Navigate to http://localhost:8000/docs in your web browser to access the documentation. | ||
| 3. You can download the OpenAPI schema from http://localhost:8000/openapi.json. This schema can be imported into tools like [Postman](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/) or other API clients to facilitate development and testing. | ||
|
|
||
| Not all endpoint implementations per language are up to spec with regards to their parameters and return values. To see these please reference the [feature parity board](https://feature-parity.us1.prod.dog/#/?runDateFilter=7d&feature=339) |
There was a problem hiding this comment.
Suggested change
| Not all endpoint implementations per language are up to spec with regards to their parameters and return values. To see these please reference the [feature parity board](https://feature-parity.us1.prod.dog/#/?runDateFilter=7d&feature=339) | |
| Not all endpoint implementations per language are up to spec with regards to their parameters and return values. To view endpoints that are not up to spec, see the [feature parity board](https://feature-parity.us1.prod.dog/#/?runDateFilter=7d&feature=339) |
cbeauchesne
reviewed
Nov 28, 2024
| @@ -8,6 +8,10 @@ System tests allow developers define scenarios and ensure datadog libraries prod | |||
|
|
|||
| To make changes, you must be able to run tests locally. Instructions for running **end-to-end** tests can be found [here](https://github.com/DataDog/system-tests/blob/main/docs/execute/README.md#run-tests) and for **parametric**, [here](https://github.com/DataDog/system-tests/blob/main/docs/scenarios/parametric.md#running-the-tests). | |||
|
|
|||
| **Note** | |||
|
|
|||
| For information on contributing to specifically **parametric** tests, see [here](/docs/scenarios/parametric_contributing.md). | |||
There was a problem hiding this comment.
Naming 😃
Suggested change
| For information on contributing to specifically **parametric** tests, see [here](/docs/scenarios/parametric_contributing.md). | |
| For information on contributing to specifically **parametric** scenario, see [here](/docs/scenarios/parametric_contributing.md). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
A guide on how to contribute to system-tests will be very helpful for first time contributors and those who haven't contributed for some time. This should greatly reduce the startup time on getting an engineer able to write the tests they need.
Changes
Contributing guide as well as updates to the current parametric docs.
Workflow
codeownersfile quickly.🚀 Once your PR is reviewed, you can merge it!
🛟 #apm-shared-testing 🛟
Reviewer checklist
[<language>], double-check that only<language>is impacted by the changebuild-XXX-imagelabel is present