rgriff23
commented
4 years ago @shaunagm here is a list of connectors that definitely need work and which aspects require work. I apologize for the delay, I was worried that my initial audit was a bit too quick and dirty, so I went over them more carefully just now.
- Action Kit: fix typo in Quick Start (it imports VAN rather than ActionKit)
- Action Network: improve Overview, add Authentication Guide
- Airtable: add Quick Start
- Azure: add Authentication Guide
- Bill.com: improve Overview, add Authentication Guide
- Braintree: add Authentication Guide
- Civis: add Overview, add Authentication Guide, add Quick Start
- Copper: add Quick Start
- CrowdTangle: improve Overview, add Authentication Guide, add Quick Start
- Databases: Contains multiple classes and needs a global overview at the top to orient the reader. The documentation surrounding individual classes needs to be audited.
- FacebookAds: add Quick Start
- Freshdesk: improve Overview, add Authentication Guide, add Quick Start
- GitHub: improve Overview
- Google: Contains multiple classes and needs a global overview at the top to orient the reader. The documentation surrounding individual classes needs to be audited.
- Hustle: add Authentication Guide
- Mailchimp: add Authentication Guide
- Mobilize America: add Authentication Guide, add Quick Start
- New/Mode: improve Overview, add Authentication Guide
- PDI: improve Overview (in particular, the entire Overview should not be a single hyperlink)
- Phone2Action: improve Overview, add Authentication Guide, add Quick Start
- Redash: improve Overview, add Authentication Guide, add Quick Start
- Salesfoce: improve Overview, add Authentication Guide, add Quick Start
- SFTP: improve Overview, add Authentication Guide, add Quick Start
- TargetSmart: add Authentication Guide, add Quick Start
- Twilio: add Authentication Guide
- TurboVote: improve Overview, add Authentication Guide, add Quick Start
- Zoom: improve Overview, add Authentication Guide
shaunagm
davidpablocohn
The connector documentation to be more consistent. Each connector needs, in order:
1) an overview, which explains the service that the connector connects to, and summarizes what subsets of endpoints currently are covered.
2) a detailed guide to getting authentication info.
3) a "quick start guide" that demonstrates instantiating the connector and using a method.
See the action kit connector documentation for an example of what we're looking for.
This doesn't need to be done by a single person in a single PR - feel free to grab a connector by leaving a comment below and submit the updated docs as its own PR.
Here's the current status of the connector docs (thanks to @rgriff23 for the audit!):