tableau / connector-plugin-sdk

SDK for Developing Tableau Connector Plugins
https://tableau.github.io/connector-plugin-sdk/
MIT License
107 stars 107 forks source link

Add a `design.md` document #802

Open chiaradiamarcelo opened 3 years ago

chiaradiamarcelo commented 3 years ago

It would be nice to include a design.md document or something similar to describe the design, distribution, interaction, implementation, where-to-find, hows-and-whys, etc of the components of the TDVT. At the moment I find it quite hard to understand how everything works together, and by this I find it really hard to collaborate to the project. One small example, it's not easy to find tests, and determine how they are chosen and executed, and what does it mean if some tests pass and some fail (e.g, I noticed there are many vendor folders that contain tests, at first glance specifically for those vendor folders. Does this mean that all those tests are executed against a connector when running the TDVT? Does this mean that for a new connector a new vendor folder should be added? What does it mean if for a new connector, eg, the tests for PostgreSQL succeed but the ones from Oracle fail?).

Describe the solution you'd like A clear design document that would allow external contributors to understand and collaborate with the project.

About You Name: Marcelo Chiaradia Company: Exasol

jainam1995 commented 3 years ago

Hi, Thanks for raising this request. We have added this to the list of requested feature. Will update the issue when this request is worked on

VasanthiNeelagiri commented 2 years ago

Hi, I am a new PM for the Connector SDK and I am looking at our feature backlog and getting things prioritized. I would appreciate if you can give your feedback for our product via this form. It should only take 2-5 mins but would be super valuable to our team. Thanks in advance!! https://docs.google.com/forms/d/e/1FAIpQLSfs5OreNsxnva_uTO2vTxnoF-oq-37tEdrUpirUKwqud2Ib7g/viewform?usp=sf_link

chiaradiamarcelo commented 2 years ago

Hi, I am a new PM for the Connector SDK and I am looking at our feature backlog and getting things prioritized. I would appreciate if you can give your feedback for our product via this form. It should only take 2-5 mins but would be super valuable to our team. Thanks in advance!! https://docs.google.com/forms/d/e/1FAIpQLSfs5OreNsxnva_uTO2vTxnoF-oq-37tEdrUpirUKwqud2Ib7g/viewform?usp=sf_link

cc @redcatbear