Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

SaaS connection documentation #478

Merged
merged 13 commits into from
May 19, 2022
Merged

SaaS connection documentation #478

merged 13 commits into from
May 19, 2022

Conversation

conceptualshark
Copy link
Contributor

Purpose

  • As we roll out additional connectors, having a template and basic instructions on how to use them will become more important. Additionally, the "Guides" section in the docs site was growing, with enough SaaS documentation pages to warrant their own director.

Changes

  • Call out implemented saas connectors on their own pages
  • Provide a breakdown of available endpoints in the listed/available example configuration
  • Restructure some of the docs pages to break out saas config/docs into their own section

Checklist

  • Applicable documentation updated (guides, quickstart, postman collections, tutorial, fidesdemo, database diagram.
  • If docs updated (select one):
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
  • Good unit test/integration test coverage
  • This PR contains a DB migration. If checked, the reviewer should confirm with the author that the down_revision correctly references the previous migration before merging
  • The Run Unsafe PR Checks label has been applied, and checks have passed, if this PR touches any external services

Ticket

Fixes #450


# Hubspot

## Implementation Summary
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like the way you linked out to the API docs and summarized the available actions in a single place. What are your thoughts on adding something like a Right to Update column? Each endpoint can have a read, update, or delete so it's important to make the distinction between update and delete.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it the case that we use "Update" to satisfy a "Delete" - ie, updating information where it cannot be deleted? If that's the case I think I'd rather change "Right to Delete" to be inclusive of Update endpoints, otherwise just make this a simple read/update/delete breakdown (without promising it satisfies right to access or right to delete).

Copy link
Collaborator

@galvana galvana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like how each SaaS connector has it's own dedicated page with very relevant API links and action summaries. I fixed a few typos with the Stripe endpoint to avoid the back and forth, so all that's left is your thoughts on the "right to update" addition.

@conceptualshark conceptualshark requested a review from galvana May 19, 2022 17:32
Copy link
Collaborator

@galvana galvana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good direction for SaaS connector documentation. Each connector integration is its own mini project so the more documentation we have the better!

@galvana galvana merged commit 0eecb2f into main May 19, 2022
@galvana galvana deleted the cg-saas-connectors branch May 19, 2022 18:16
sanders41 pushed a commit that referenced this pull request Sep 22, 2022
Updating SaaS connector docs layout and stub in connectors guides
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include instructions and visible samples for implemented SaaS connectors
2 participants