Updates to low-code documentation #17121
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
area/documentation
girarda
commented
Sep 25, 2022
| @@ -0,0 +1,47 @@ | |||
| # Substreams | |||
There was a problem hiding this comment.
Moved from stream-slicers.md
girarda
commented
Sep 25, 2022
| @@ -1,22 +1,31 @@ | |||
| :warning: This framework is in alpha stage. Support is not in production and is available only to select users. :warning: | |||
There was a problem hiding this comment.
add warning to the index
girarda
commented
Sep 25, 2022
| | [Pagination](./pagination.md) | [Page limit](./pagination.md#page-increment)<br/>[Offset](./pagination.md#offset-increment)<br/>[Cursor](./pagination.md#cursor) | | ||
| | [Authentication](./authentication.md) | [Header based](./authentication.md#ApiKeyAuthenticator)<br/>[Bearer](./authentication.md#BearerAuthenticator)<br/>[Basic](./authentication.md#BasicHttpAuthenticator)<br/>[OAuth](./authentication.md#OAuth) | | ||
| | Sync mode | Full refresh<br/>Incremental | | ||
| | Schema discovery | Only static schemas | | ||
| | Schema discovery | Static schemas | |
There was a problem hiding this comment.
remove superfluous word
girarda
commented
Sep 25, 2022
| 2. Paginator: Describes how to navigate through the API's pages | ||
| 3. Record selector: Describes how to extract records from a HTTP response | ||
| 4. Stream Slicer: Describes how to partition the stream, enabling incremental syncs and checkpointing | ||
| 2. [Paginator](./pagination.md): Describes how to navigate through the API's pages |
girarda
commented
Sep 25, 2022
| @@ -209,5 +205,5 @@ pagination_strategy: | |||
| The following connectors can serve as example of what production-ready config-based connectors look like | |||
|
|
|||
| - [Greenhouse](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-greenhouse) | |||
There was a problem hiding this comment.
no need to update the greenhouse link because the production connector is using low-code
girarda
commented
Sep 25, 2022
| @@ -209,5 +205,5 @@ pagination_strategy: | |||
| The following connectors can serve as example of what production-ready config-based connectors look like | |||
|
|
|||
| - [Greenhouse](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-greenhouse) | |||
| - [Sendgrid](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-sendgrid) | |||
| - [Sentry](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-sentry) | |||
| - [Sendgrid](https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-sendgrid/source_sendgrid/sendgrid.yaml) | |||
There was a problem hiding this comment.
update links to point to the yaml file for sendgrid and sentry because the connector is not using low-code
girarda
commented
Sep 25, 2022
| @@ -118,54 +118,10 @@ the resulting stream slices are | |||
| ] | |||
| ``` | |||
|
|
|||
| ### Substream slicer | |||
There was a problem hiding this comment.
Move to substreams.md to make it easier to find
misteryeo
reviewed
Sep 26, 2022
| @@ -1,22 +1,31 @@ | |||
| :warning: This framework is in alpha stage. Support is not in production and is available only to select users. :warning: | |||
There was a problem hiding this comment.
Suggested change
| :warning: This framework is in alpha stage. Support is not in production and is available only to select users. :warning: | |
| :warning: This framework is in [alpha](https://docs.airbyte.com/project-overview/product-release-stages/#alpha). It is still in active development and may include backward-incompatible changes. Please share feedback and requests directly with us at feedback@airbyte.io :warning: |
There was a problem hiding this comment.
thank you @misteryeo!
misteryeo
approved these changes
Sep 26, 2022
Co-authored-by: Andy <andy@airbyte.io>
This was referenced Sep 27, 2022
robbinhan
pushed a commit
to robbinhan/airbyte
that referenced
this pull request
Sep 29, 2022
* Update docs * move substreams to another file * Update link * rename * link to alpha definition * Update docs/connector-development/config-based/index.md Co-authored-by: Andy <andy@airbyte.io> Co-authored-by: Andy <andy@airbyte.io>
jhammarstedt
pushed a commit
to jhammarstedt/airbyte
that referenced
this pull request
Oct 31, 2022
* Update docs * move substreams to another file * Update link * rename * link to alpha definition * Update docs/connector-development/config-based/index.md Co-authored-by: Andy <andy@airbyte.io> Co-authored-by: Andy <andy@airbyte.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
A few small updates to the low-code documentation
How
Recommended reading order
docs/connector-development/config-based/index.mddocs/connector-development/config-based/overview.mddocs/connector-development/config-based/stream-slicers.mddocs/connector-development/config-based/substreams.mddocs/connector-development/config-based/tutorial/0-getting-started.md