test: reuse examples in quickstart #1507
Open
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
Signed-off-by: Mark Sagi-Kazar <[email protected]>
|
To reduce the impact of event body is not visible anymore in .md, we can link from README to: Where we have events. |
|
It's kind of the point though: use a single source of truth for those events and make sure changing them in one place propagates to everywhere else. So linking to the docs isn't any better either. The docs should have the same instructions. |
chrisgacsal
approved these changes
Oct 4, 2024
|
@hekike As an option, we could template the quickstart README with the JSONs if that sound better |
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.
Overview
This PR ensures that the examples in the quick start guide are the same used in tests to make sure the quick start guide works.
Notes for reviewer
A downside of this change that the README no longer contains the ingested event JSON, but IMO that's a small price to pay. User can always look at the files themselves and it's actually easier to copy the command this way.