Added auto-detect schema info to docs #21501
Conversation
octavia-squidington-iv
added
the
area/documentation
docs/cloud/managing-airbyte-cloud.md
Outdated
| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | If your connection’s source schema has breaking changes, the syncs will be stopped and you must review the changes before continuing syncs or editing the connection. | If you choose to ignore non-breaking changes in your connection's source schema, the syncs will continue. You can change how Airbyte handles syncs when it detects non-breaking changes in the source schema by [editing the stream configuration](#edit-stream-configuration). | | ||
|
|
||
| To review schema changes: |
There was a problem hiding this comment.
@edmundito @alovew Are the steps for reviewing a non-breaking change and a breaking change the same? I couldn't find a breaking change in a workspace to test this.
There was a problem hiding this comment.
If there are breaking schema changes, the user will have to fix what is causing the connection to be broken. This will mean either selecting a new cursor field or new primary key.
docs/cloud/managing-airbyte-cloud.md
Outdated
| To review schema changes: | ||
| 1. On the [Airbyte Cloud](http://cloud.airbyte.io/) dashboard, click **Connections** and select the connection you want to review. | ||
|
|
||
| 2. Click the **Replication** tab. |
There was a problem hiding this comment.
No need to click on the replication tab. the "Review changes" button is anywhere in the connection and will automatically navigate the user to the replication tab.
docs/cloud/managing-airbyte-cloud.md
Outdated
|
|
||
| 4. The **Refreshed source schema** dialog displays. Click the dropdowns to review the changes. | ||
|
|
||
| 5. Click **Confirm** to close the dialog. |
There was a problem hiding this comment.
We will change the label in the button to OK to make it clear that the change has already been applied. PR
docs/cloud/managing-airbyte-cloud.md
Outdated
| @@ -276,7 +278,70 @@ To refresh the source schema: | |||
|
|
|||
| 2. If there are changes to the schema, the **Refreshed source schema** dialog displays them. | |||
|
|
|||
| ## Review schema changes | |||
There was a problem hiding this comment.
Change "Review schema changes" > "Manage schema changes"
docs/cloud/managing-airbyte-cloud.md
Outdated
| ## Review schema changes | ||
| Airbyte detects changes in your source schema and allows you to review the changes. | ||
|
|
||
| ### Non-breaking changes |
There was a problem hiding this comment.
Change "Non-breaking changes" > "Review non-breaking schema changes"
docs/cloud/managing-airbyte-cloud.md
Outdated
|
|
||
| ::: | ||
|
|
||
| ### Breaking changes |
There was a problem hiding this comment.
Change "Breaking changes" > "Fix breaking schema changes"
docs/cloud/managing-airbyte-cloud.md
Outdated
|
|
||
| ### Breaking changes | ||
|
|
||
| To review breaking schema changes: |
There was a problem hiding this comment.
Change "To review breaking schema changes:" > "To review and fix breaking schema changes:"
docs/cloud/managing-airbyte-cloud.md
Outdated
|
|
||
| 2. Click the **Replication** tab. | ||
|
|
||
| The **Transfer** and **Streams** settings include the following parameters: | ||
| The first section includes the following parameters: |
There was a problem hiding this comment.
This sentence implies there's a second section, but I didn't see any info about it in the doc. What are we trying to say here?
There was a problem hiding this comment.
@Amruta-Ranade I realized that the new wording here reflected the new streams table redesign, which hasn't been implemented yet. I reverted this text back.
docs/cloud/managing-airbyte-cloud.md
Outdated
| @@ -276,7 +278,70 @@ To refresh the source schema: | |||
|
|
|||
| 2. If there are changes to the schema, the **Refreshed source schema** dialog displays them. | |||
There was a problem hiding this comment.
Change "If there are changes to the schema" > "If the schema has changed"
docs/cloud/managing-airbyte-cloud.md
Outdated
|
|
||
| 3. The **Refreshed source schema** dialog displays the changes. | ||
|
|
||
| 4. Click **OK** to close the dialog. |
There was a problem hiding this comment.
Change "Click OK to close the dialog." to "Review the changes and click OK to close the dialog."
docs/cloud/managing-airbyte-cloud.md
Outdated
|
|
||
| 4. Click **OK** to close the dialog. | ||
|
|
||
| 5. In the streams table, the stream with a breaking change is highlighted |
There was a problem hiding this comment.
Missing (.) at end of sentence
docs/cloud/managing-airbyte-cloud.md
Outdated
|
|
||
| :::note | ||
|
|
||
| Breaking changes can only occur in the **Cursor** or **Primary key** fields. |
There was a problem hiding this comment.
This info should be earlier in the doc. Right after "Airbyte detects changes in your source schema and allows you to review the changes."
| ## Manage schema changes | ||
|
|
||
| Airbyte detects changes in your source schema and allows you to review the changes. | ||
|
|
There was a problem hiding this comment.
@Amruta-Ranade what do you think about grouping this information in a note here?
docs/cloud/managing-airbyte-cloud.md
Outdated
|
|
||
| :::note | ||
|
|
||
| * Schema changes are flagged in your connection, but they will not affect your destination. |
There was a problem hiding this comment.
All three points don't seem to have the same level of importance. I'd leave the point about schema changes not being propagated to the destination as a note, and make the other two points simple statements.
I'd write the start of the section as follows:
Once every 24 hours, Airbyte checks for changes in your source schema and allows you to review the changes and fix breaking changes.
:::note
Schema changes are flagged in your connection but are not propagated to your destination.
:::
I know I said we could put the line about breaking changes at the top of the section, but with the new content, I think we can move it to the top of the section about breaking changes. Let me know what you think.
There was a problem hiding this comment.
I agree. I'll add those changes :)
Added auto-detect schema info to docs.