Improve connector documentation #269
Comments
shaunagm
added
the
documentation
shaunagm
added
the
high priority
shaunagm
changed the title
|
@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.
|
|
Thanks @rgriff23! This is amazingly helpful. |
|
Trying to get started helping, and have been looking at the Google Sheets doc. Setting up/enabling the API on the dev console is non-obvious, but the description of how to do so is probably longer than we want to put in the main doc. Is there an established place for ancillary HowTo docs to go? |
|
Is there a web page provided by Google that describes the API process in detail? You could do a 1-3 sentence summary and link out to the longer instructions. |
|
Not that I have found (though ironically, Googling Google stuff is often a black hole). The best I've found is a third-party description here: https://www.iperiusbackup.net/en/how-to-enable-google-drive-api-and-get-client-credentials/; I'm writing up a quick summary to see how concise I can get it, and will then shop around for a good location. |
Moves toward completion of move-coop#269.
* Make GoogleSheets __init__ compatible with other Google API connectors Retain all original GoogleSheets compatibility, but add ability for it to take a string as its init, same as GoogleBigQuery and GoogleCloudStorage. Also have it look in GOOGLE_APPLICATION_CREDENTIALS for its credentials (after checking it's original env variable GOOGLE_DRIVE_CREDENTIALS). So it should retain full backward compatibility, and no one currently using it should notice any difference, but it will now also be able to be instantiated using the same calling convention as other Google connectors. * Revert "Make GoogleSheets __init__ compatible with other Google API connectors" This reverts commit dc6d2f2. Should have been pushed to a branch. * Add Quickstart section to doc for Google connectors Also clean up internal docstrings for Google connector py files. * Add short overview to start of google.rst. Moves toward completion of #269. * Remove obsolete google_[civic,sheets].html Their content has been moved into google.html (via google.rst, but the autogenerated files google_civic.html and google_sheets.html) were never removed from repo. * Force add of .gitignored google.html * Update Google Drive to Google Service Account
|
@shaunagm Just making a note here that once #411 is merged (it should be ready), the AWS connectors are done. And with @davidpablocohn's PR #417 merged, the Google connectors are done too. Not sure if you want to close out this issue or keep it open for ongoing improvements to the documentation, but I think the goals outlined in description are achieved! :) |
|
That's so exciting! Do you have permission to close issues? If so, once 411 is merged, I'll let you do the honors. ;) |
@shaunagm Thanks! I am assuming I don't have permissions, because I don't see the 'Close' button (which I think would appear beneath the comment box). |
The connector documentation to be more consistent. Each connector needs, in order:
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!):
The text was updated successfully, but these errors were encountered: