newrelic / nr1-community

An open-source library of useful components for building on New Relic One's programmability platform.
https://developer.newrelic.com
Apache License 2.0
11 stars 12 forks source link

Rename EventStream to EventTimeline or other #29

Closed Kav91 closed 4 years ago

Kav91 commented 4 years ago

Given we have a nerdpack called "Event Stream" already https://github.com/newrelic/nr1-event-stream

I think this component should be better named to Timeline since it is clearly a time based component, more-so then offering any streaming capabilities itself.

Also to avoid any confusion with an already used name within the same programmability ecosystem.

devfreddy commented 4 years ago

The original form of this one was Event-driven so it made sense at the time, but not anymore. It was originally called <Timeline> and I believe we changed it, for a specific project, to avoid confusion with another timeline-like component.

We've altered it to be more generic, the component's only real expectation is that you will provide it with at least one timestamp field + format for display.

We're thinking and acting on a change to make it <Timeline> as that best represents its purpose.

Thanks for pointing this out @Kav91