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

docs: add sync status feature guide #5897

Merged
merged 5 commits into from
Oct 14, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs-website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,7 @@ module.exports = {
"docs/domains",
"docs/how/business-glossary-guide",
"docs/tags",
"docs/sync-status",
{
type: "doc",
id: "docs/managed-datahub/saas-slack-setup",
Expand Down
27 changes: 27 additions & 0 deletions docs/sync-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import FeatureAvailability from '@site/src/components/FeatureAvailability';

# About DataHub Sync Status

<FeatureAvailability/>

When looking at metadata in DataHub, it's useful to know if the information you're looking at is relevant.
Specifically, if metadata is stale, or hasn't been updated in a while, then you should consider refreshing that metadata
using [metadata ingestion](./../metadata-ingestion/README.md) or [deleting](TODO) it if it no longer exists.

## Sync Status Setup, Prerequisites, and Permissions

The sync status feature is enabled by default and does not require any special setup.

## Using Sync Status

The DataHub UI will display the sync status in the top right corner of the page.

![sync status](https://raw.githubusercontent.com/datahub-project/static-assets/master/imgs/sync-status.png)
hsheth2 marked this conversation as resolved.
Show resolved Hide resolved

The last synchronized date is computed as the most recent edit to the entity, excluding edits done through the UI.
hsheth2 marked this conversation as resolved.
Show resolved Hide resolved
We'll automatically assign a color based on the sync status recency, with green indicating a fresh entity and red indicating a stale one.
hsheth2 marked this conversation as resolved.
Show resolved Hide resolved
You can hover over the sync status message in the UI to view the exact timestamp of the most recent sync.

![hover card](https://raw.githubusercontent.com/datahub-project/static-assets/master/imgs/sync-status-hover-card.png)
hsheth2 marked this conversation as resolved.
Show resolved Hide resolved

_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_