openmeter icon indicating copy to clipboard operation
openmeter copied to clipboard

test: reuse examples in quickstart

Open sagikazarmark opened this issue 1 year ago • 3 comments

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.

sagikazarmark avatar Sep 13 '24 11:09 sagikazarmark

To reduce the impact of event body is not visible anymore in .md, we can link from README to: https://openmeter.io/docs/get-started/quick-start

Where we have events.

hekike avatar Sep 13 '24 15:09 hekike

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.

sagikazarmark avatar Sep 14 '24 10:09 sagikazarmark

@hekike As an option, we could template the quickstart README with the JSONs if that sound better

GAlexIHU avatar Nov 15 '24 14:11 GAlexIHU