Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📝 Docs: update Stripe docs page #29254

Merged
merged 6 commits into from
Aug 9, 2023
Merged

📝 Docs: update Stripe docs page #29254

merged 6 commits into from
Aug 9, 2023

Conversation

ChristoGrab
Copy link
Contributor

What

Updated the main and in-app docs pages for the Stripe source connector.

How

  • Updated API Key setup steps in main docs, and added link to them in in-app page.
  • The current description of the Lookback Window seems to imply the window is tied to the replication start date, but my understanding is the window is meant to capture data changes from the most recent N days, rather than syncing data from N days before the Start Date. I've changed the explanation and example to reflect this, let me know if this is a misunderstanding on my part!
  • Added an example for the data request window
  • Alphabetized streams
  • Moved events stream warning from top of page to "supported streams" section

@ChristoGrab ChristoGrab added area/documentation Improvements or additions to documentation connectors/source/stripe labels Aug 9, 2023
@ChristoGrab ChristoGrab requested a review from sherifnada August 9, 2023 14:21
@ChristoGrab ChristoGrab changed the title Docs: update Source Stripe docs page 📝 Docs: update Stripe docs page Aug 9, 2023
@ChristoGrab ChristoGrab marked this pull request as ready for review August 9, 2023 15:37
sherifnada
sherifnada approved these changes Aug 9, 2023
View reviewed changes
docs/integrations/sources/stripe.md
5. For **Account ID**, enter your Stripe Account ID. This ID begins with `acct_`, and can be found in the top-right corner of your Stripe [account settings page](https://dashboard.stripe.com/settings/account).
6. For **Secret Key**, enter the restricted key you created for the connection.
7. For **Replication Start Date**, use the provided datepicker or enter a UTC date and time programmatically in the format `YYYY-MM-DDTHH:mm:ssZ`. The data added on and after this date will be replicated.
8. (Optional) For **Lookback Window**, you may specify a number of days from the present day to reread data. This allows the connector to retrieve data that might have been updated after its initial creation, and is useful for handling any post-transaction adjustments (such as tips, refunds, chargebacks, etc).
Copy link
Contributor

Choose a reason for hiding this comment

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

great context!

@ChristoGrab ChristoGrab merged commit 3da1a2f into master Aug 9, 2023
@ChristoGrab ChristoGrab deleted the stripe-docs branch August 9, 2023 17:11
harrytou pushed a commit to KYVENetwork/airbyte that referenced this pull request Sep 1, 2023
@ChristoGrab @harrytou
📝 Docs: update Stripe docs page (airbytehq#29254)
8277431 
* add API key setup instructions

* re-order bullet points

* complete main docs update

* update lookback window explanation

* small fix to lookback window example

* update data request description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sherifnada sherifnada sherifnada approved these changes

Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation connectors/source/stripe
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ChristoGrab @sherifnada