Idea: connect UI to docs for extractors
Problem to solve
So I was getting started, hoping to get some data out of GitLab. The tutorial is great getting me to the "connect data sources" step (http://meltano.com/docs/quickstart.html#connecting-data-sources) but once I selected GitLab, I was thrown off about what to put in "groups" and "projects" and "start date":
At that point I was a little stuck..and I started poking around the code itself. It was only then I realized "oh there's a great docs page on the GitLab tap itself": http://meltano.com/docs/plugins.html#gitlab
New users to the UI
(Include use cases, benefits, and/or goals)
So I propose that a simple iteration (in theory) that would improve the UX here would be to: If we have a docs page about a given tap, link with a
(?) to that docs page from the extractor configuration screen (above).
What does success look like, and how can we measure that?
Increase in from "start UI" to "actually configures an extractor" metric...which I'm sure has a better name than that
(Ensure the feature doesn't cause any regressions)
- Write adequate test cases and submit test results
- Test results should be reviewed by a person from the team
Links / references
Please note that this was taken from GitLab, to be changed accordingly