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.

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

Updates to Managing Airbyte Cloud doc #16941

Merged
merged 8 commits into from
Oct 3, 2022
Merged

Conversation

sophia-wiley
Copy link
Contributor

@sophia-wiley sophia-wiley commented Sep 20, 2022

Updated the Managing Airbyte Cloud doc:

  • Added Remove users section
  • Edited Sync summary section
  • Added Display connection state section

Related to 15795 and 16936.

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Sep 20, 2022
@sophia-wiley sophia-wiley self-assigned this Sep 20, 2022
@sophia-wiley
Copy link
Contributor Author

@marcosmarxm @timroes Please review the info in this commit.

@timroes
Copy link
Collaborator

timroes commented Sep 23, 2022

@sophia-wiley I'm not sure if the docs are technically true like this. 0 Bytes will just mean 0 Bytes have been transfered. This could be because it was cancelled, but could also just happen if no bytes have been transferred. Can we just remove this part from the documentation? I feel "0 bytes" should be rather self-explanatory to the user to understand?

Copy link
Collaborator

@timroes timroes left a comment

Choose a reason for hiding this comment

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

LGTM

@sophia-wiley sophia-wiley changed the title Changed NaN bytes to zero bytes Updates to Managing Airbyte Cloud doc Sep 27, 2022
3. Under Sync History, a list of syncs for that connection is displayed.

The sync status is displayed (Succeeded, Cancelled, Failed, or Running) along with the [summary of the sync log](#sync-log-summary).
Sync History displays the sync status or [reset](https://docs.airbyte.com/operator-guides/reset/) status (Succeeded, Partial Success, Failed, Cancelled, or Running) and the [sync summary](#sync-summary).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Amruta-Ranade Do you think I should link to this Reset doc?

Copy link
Contributor

Choose a reason for hiding this comment

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

yep

4. For more information about a sync, click the sync log dropdown.
:::note

Airbyte will try to sync your data three times. After a third failure, it will stop attempting to sync.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Amruta-Ranade Do you think I should keep or delete this note about Airbyte syncing data three times before stopping?

Copy link
Contributor

Choose a reason for hiding this comment

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

let's keep it for now

@sophia-wiley
Copy link
Contributor Author

@Amruta-Ranade this doc is ready for review :)

3. Under Sync History, a list of syncs for that connection is displayed.

The sync status is displayed (Succeeded, Cancelled, Failed, or Running) along with the [summary of the sync log](#sync-log-summary).
Sync History displays the sync status or [reset](https://docs.airbyte.com/operator-guides/reset/) status (Succeeded, Partial Success, Failed, Cancelled, or Running) and the [sync summary](#sync-summary).
Copy link
Contributor

Choose a reason for hiding this comment

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

yep

4. For more information about a sync, click the sync log dropdown.
:::note

Airbyte will try to sync your data three times. After a third failure, it will stop attempting to sync.
Copy link
Contributor

Choose a reason for hiding this comment

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

let's keep it for now

@sophia-wiley sophia-wiley merged commit a5ec71a into master Oct 3, 2022
@sophia-wiley sophia-wiley deleted the edit_sync_log_info branch October 3, 2022 16:29
jhammarstedt pushed a commit to jhammarstedt/airbyte that referenced this pull request Oct 31, 2022
* chagned NaN bytes to zero bytes

* added remove user and connection state sections'

cd ..
cd docs

* edited wording in connection state section

* Added aditional information to connection state section

* removed cancelled and failed sync info

* edited wording

* edits to the sync summary section

* Edited spacing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants