-
Notifications
You must be signed in to change notification settings - Fork 4.5k
[Docs] Update "Reset" to "Clear" #37357
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.
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c9c4752
Clear
nataliekwong 6c8df6f
oopsie
nataliekwong d73ac9f
Apply suggestions from code review
nataliekwong b913faf
subset
nataliekwong 124c3d7
add screenshot
nataliekwong bbec510
docs
nataliekwong 527a1de
image
nataliekwong f30b9a0
image2
nataliekwong File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,21 @@ | ||
# Rss Migration Guide | ||
# RSS Migration Guide | ||
|
||
## Upgrading to 1.0.0 | ||
The verison migrates the Rss connector to the low-code framework for greater maintainability. You may need to refresh the connection schema (with the reset), and run a sync. | ||
We're continuously striving to enhance the quality and reliability of our connectors at Airbyte. | ||
|
||
As part of our commitment to delivering exceptional service, we are transitioning our RSS source from the Python Connector Development Kit (CDK) | ||
to our new low-code framework improving maintainability and reliability of the connector. Due to differences between the Python and low-code CDKs, this migration constitutes a breaking change. | ||
|
||
## Migration Steps | ||
|
||
Clearing your data is required for the affected streams in order to continue syncing successfully. To clear your data for the affected streams, follow the steps below: | ||
|
||
1. Select **Connections** in the main navbar and select the connection(s) affected by the update. | ||
2. Select the **Schema** tab. | ||
1. Select **Refresh source schema** to bring in any schema changes. Any detected schema changes will be listed for your review. | ||
2. Select **OK** to approve changes. | ||
3. Select **Save changes** at the bottom of the page. | ||
1. Ensure the **Clear affected streams** option is checked to ensure your streams continue syncing successfully with the new schema. | ||
4. Select **Save connection**. | ||
|
||
This will clear the data in your destination for the subset of streams with schema changes. After the clear succeeds, trigger a sync by clicking **Sync Now**. For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset). |
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,25 @@ | ||
# SFTP Bulk Migration Guide | ||
|
||
## Upgrading to 1.0.0 | ||
This release upgrades the SFTP Bulk connector to file-based CDK which causes the following changes: | ||
We're continuously striving to enhance the quality and reliability of our connectors at Airbyte. | ||
|
||
- Configuration changes | ||
- Stream changes | ||
As part of our commitment to delivering exceptional service, we are transitioning our SFTP Bulk source from the Python Connector Development Kit (CDK) to our new low-code framework improving maintainability and reliability of the connector. Due to differences between the Python and low-code CDKs, this migration constitutes a breaking change for the following: | ||
|
||
Users should: | ||
- Changes to the source configuration | ||
- Changes to the schema (added, removed fields and/or streams) | ||
|
||
- Reconfigure the source | ||
- Refresh the source schema | ||
- Reset affected streams after upgrading to ensure uninterrupted syncs. | ||
## Migration Steps | ||
|
||
This version change requires you to re-verify the configuration of your source. To do this, click on "Source" in the left-hand sidebar and navigate to your SFTP Bulk source. Test the source and ensure the configuration is valid before moving forward. | ||
|
||
### Refresh affected schemas and reset data | ||
Clearing your data is required for the affected streams in order to continue syncing successfully. To clear your data for the affected streams, follow the steps below: | ||
|
||
1. Select **Connections** in the main navbar. | ||
1. Select the connection(s) affected by the update. | ||
2. Select the **Replication** tab. | ||
1. Select **Refresh source schema**. | ||
2. Select **OK**. | ||
```note | ||
Any detected schema changes will be listed for your review. | ||
``` | ||
3. Select **Save changes** at the bottom of the page. | ||
1. Ensure the **Reset affected streams** option is checked. | ||
```note | ||
Depending on destination type you may not be prompted to reset your data. | ||
``` | ||
1. Select **Connections** in the main navbar and select the connection(s) affected by the update. | ||
2. Select the **Schema** tab. | ||
1. Select **Refresh source schema** to bring in any schema changes. Any detected schema changes will be listed for your review. | ||
2. Select **OK** to approve changes. | ||
3. Select **Save changes** at the bottom of the page. | ||
1. Ensure the **Clear affected streams** option is checked to ensure your streams continue syncing successfully with the new schema. | ||
4. Select **Save connection**. | ||
```note | ||
This will reset the data in your destination and initiate a fresh sync. | ||
``` | ||
|
||
For more information on resetting your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset). | ||
This will clear the data in your destination for the subset of streams with schema changes. After the clear succeeds, trigger a sync by clicking **Sync Now**. For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset). |
This file contains hidden or 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: I'm adjusting this wording in https://github.com/airbytehq/airbyte-platform-internal/pull/12152 after feedback from support
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the image for now!