diff --git a/docs/data-assets/apis/api-endpoint.md b/docs/data-assets/apis/api-endpoint.md index 8281506..c7a5f53 100644 --- a/docs/data-assets/apis/api-endpoint.md +++ b/docs/data-assets/apis/api-endpoint.md @@ -1365,29 +1365,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about API endpoint changes** - -Followers allow users to "follow" API endpoints and receive notifications when they change. This is critical for: - -- **API Consumers**: Monitor endpoints your applications depend on -- **Backend Engineers**: Track endpoints you own or maintain -- **Integration Teams**: Stay informed about contract changes -- **API Product Managers**: Monitor endpoint usage and evolution - -**Key Benefits**: -- Receive notifications about breaking changes to request/response schemas -- Track deprecation notices and versioning changes -- Monitor authentication or rate limiting updates -- Get alerts for SLA or performance threshold changes - -**Common Use Cases**: -- Frontend developers follow endpoints their apps consume -- Backend engineers follow production endpoints they maintain -- DevOps teams follow critical API endpoints for monitoring -- Product teams follow public API endpoints for customer impact - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow API endpoints to receive notifications about schema changes, deprecation notices, and authentication updates. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/dashboards/chart.md b/docs/data-assets/dashboards/chart.md index 7431d51..ac8cb15 100644 --- a/docs/data-assets/dashboards/chart.md +++ b/docs/data-assets/dashboards/chart.md @@ -1014,29 +1014,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about chart changes** - -Followers allow users to "follow" individual charts and receive notifications when they change. This is useful for: - -- **Chart Creators**: Monitor charts they've built -- **Metric Owners**: Track visualizations of key business metrics -- **Stakeholders**: Stay informed about specific KPI visualizations -- **Collaboration**: Work with team members on chart refinements - -**Key Benefits**: -- Receive notifications about chart configuration changes -- Track changes to underlying queries or data sources -- Monitor visualization type or display property updates -- Get alerts for ownership or deprecation changes - -**Common Use Cases**: -- Analysts follow charts they created or maintain -- Business users follow charts showing their KPIs -- Data teams follow charts using complex calculations -- Executives follow critical metric visualizations - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow charts to receive notifications about visualization changes, query modifications, and data source updates. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/dashboards/dashboard.md b/docs/data-assets/dashboards/dashboard.md index 7e2ab07..eaa8928 100644 --- a/docs/data-assets/dashboards/dashboard.md +++ b/docs/data-assets/dashboards/dashboard.md @@ -1036,29 +1036,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about dashboard changes** - -Followers allow users to "follow" a dashboard and receive notifications when it changes. This is particularly valuable for: - -- **Business Stakeholders**: Track dashboards with key business metrics and KPIs -- **Report Consumers**: Get notified when dashboards are updated or metrics change -- **Collaboration**: Stay in sync with team members working on shared dashboards -- **Governance**: Monitor dashboards for compliance and data quality - -**Key Benefits**: -- Receive notifications about dashboard updates and refreshes -- Track changes to underlying data sources or calculations -- Monitor chart additions, removals, or modifications -- Get alerts for ownership, tier, or governance changes - -**Common Use Cases**: -- Executives follow executive dashboards for KPI tracking -- Product managers follow dashboards tracking product metrics -- Analysts follow dashboards they've created or contributed to -- Data engineers follow dashboards to monitor data pipeline health - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow dashboards to receive notifications about updates, chart changes, and data source modifications. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/databases/database.md b/docs/data-assets/databases/database.md index 37aa7c1..82e92a5 100644 --- a/docs/data-assets/databases/database.md +++ b/docs/data-assets/databases/database.md @@ -751,34 +751,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about database changes** - -Followers allow users to "follow" a database and receive notifications when it changes. This is useful for: - -- **Monitoring Dependencies**: Get notified when databases your applications depend on change -- **Staying Informed**: Track databases you're interested in without being the owner -- **Collaboration**: Stay in sync with team members working on the same databases -- **Governance**: Monitor databases with compliance requirements - -**Key Benefits**: -- Receive notifications about schema changes, new schemas, or deletions -- Track governance changes (tags, ownership, domain assignments) -- Monitor data quality issues at the database level -- Get alerts for deprecation notices - -**Following vs Ownership**: -- **Ownership** = Responsibility and accountability for the database -- **Following** = Interest and awareness about the database - -Any user can follow any database they have access to. A database can have multiple followers. - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about: - - - How to follow databases via UI and API - - Notification preferences and configuration - - Best practices for using followers effectively - - Integration with webhooks and activity feeds +Users can follow databases to receive notifications about changes such as schema updates, governance changes, or deprecation notices. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/databases/table.md b/docs/data-assets/databases/table.md index efeae02..e49d443 100644 --- a/docs/data-assets/databases/table.md +++ b/docs/data-assets/databases/table.md @@ -1324,42 +1324,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about table changes** - -Followers allow users to "follow" a table and receive notifications when it changes. This is one of the most useful features for data practitioners: - -- **Monitor Dependencies**: Get notified when tables your applications or dashboards depend on change -- **Schema Changes**: Receive alerts when columns are added, removed, or modified -- **Data Quality**: Be notified of test failures, anomalies, or freshness issues -- **Collaboration**: Track tables you're working on with others - -**Key Benefits**: -- Receive notifications about schema changes (new columns, type changes) -- Track data quality test results and failures -- Monitor data profiling anomalies (unusual null rates, distribution changes) -- Get alerts for deprecation, tier changes, or ownership updates -- Stay informed about query usage patterns and popularity - -**Following vs Ownership**: -- **Ownership** = Responsibility and accountability for the table's quality and accuracy -- **Following** = Interest in being notified about changes to the table - -Any user can follow any table they have access to. Tables typically have multiple followers (analysts, engineers, data scientists who use the data). - -**Common Use Cases**: -- Data scientists follow source tables for their ML models -- Analysts follow tables used in their reports and dashboards -- Data engineers follow tables in production pipelines -- Compliance officers follow tables containing PII or sensitive data - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about: - - - How to follow tables via UI and API - - Configuring notification preferences (immediate vs digest) - - Best practices for avoiding notification overload - - Bulk following patterns (e.g., follow all tables in a domain) - - Integration with webhooks and Slack/Teams +Users can follow tables to receive notifications about schema changes, data quality issues, profiling anomalies, and ownership updates. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/messaging/topic.md b/docs/data-assets/messaging/topic.md index d9a2778..a169ab5 100644 --- a/docs/data-assets/messaging/topic.md +++ b/docs/data-assets/messaging/topic.md @@ -1235,29 +1235,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about topic changes** - -Followers allow users to "follow" a topic and receive notifications when it changes. This is critical for: - -- **Event Producers**: Monitor topics they publish to -- **Event Consumers**: Track schema changes in topics they consume -- **Platform Teams**: Get notified of topic configuration changes -- **Compliance**: Monitor topics with sensitive data - -**Key Benefits**: -- Receive notifications about schema changes (critical for compatibility) -- Track partition count or replication factor changes -- Monitor retention policy or configuration updates -- Get alerts for deprecation, ownership, or governance changes - -**Common Use Cases**: -- Developers follow topics their services consume -- Platform engineers follow all production topics -- Data scientists follow topics with ML training events -- Compliance officers follow topics with PII or sensitive data - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow topics to receive notifications about schema changes, partition updates, and configuration modifications. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/ml/mlmodel.md b/docs/data-assets/ml/mlmodel.md index 2e3889a..d9ad9d6 100644 --- a/docs/data-assets/ml/mlmodel.md +++ b/docs/data-assets/ml/mlmodel.md @@ -1421,29 +1421,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about ML model changes** - -Followers allow users to "follow" an ML model and receive notifications when it changes. This is valuable for: - -- **Data Scientists**: Monitor models they've developed or deployed -- **ML Engineers**: Track model version changes and deployments -- **Stakeholders**: Stay informed about production model updates -- **Compliance**: Monitor models for governance and regulatory requirements - -**Key Benefits**: -- Receive notifications about model version updates -- Track feature or algorithm changes -- Monitor performance metrics and drift -- Get alerts for ownership, deprecation, or governance updates - -**Common Use Cases**: -- Data scientists follow models in production -- ML engineers follow models they deploy and maintain -- Product managers follow models powering product features -- Compliance teams follow models with regulatory implications - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow ML models to receive notifications about version updates, performance metrics, and deployment changes. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/pipelines/pipeline.md b/docs/data-assets/pipelines/pipeline.md index 4b2cd0d..feef2c8 100644 --- a/docs/data-assets/pipelines/pipeline.md +++ b/docs/data-assets/pipelines/pipeline.md @@ -1209,29 +1209,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about pipeline changes** - -Followers allow users to "follow" a pipeline and receive notifications when it changes. This is essential for: - -- **Data Engineers**: Monitor pipelines they own or maintain -- **Pipeline Dependencies**: Track upstream/downstream pipeline changes -- **Operations**: Get notified of pipeline failures or configuration changes -- **Stakeholders**: Stay informed about ETL processes affecting their data - -**Key Benefits**: -- Receive notifications about pipeline configuration changes -- Track task additions, removals, or modifications -- Monitor pipeline schedule or trigger changes -- Get alerts for ownership, deprecation, or governance updates - -**Common Use Cases**: -- Data engineers follow production pipelines they maintain -- Analysts follow pipelines that refresh their reports -- Data scientists follow pipelines feeding their ML models -- Operations teams follow critical data pipelines - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow pipelines to receive notifications about configuration changes, task modifications, and schedule updates. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/storage/container.md b/docs/data-assets/storage/container.md index 8444ed3..4dda140 100644 --- a/docs/data-assets/storage/container.md +++ b/docs/data-assets/storage/container.md @@ -1509,29 +1509,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about container changes** - -Followers allow users to "follow" storage containers and receive notifications when they change. This is important for: - -- **Data Engineers**: Monitor data lake containers with production data -- **Analytics Teams**: Track containers with analytical datasets -- **Data Scientists**: Stay informed about ML training data locations -- **Operations**: Monitor storage usage and data lifecycle - -**Key Benefits**: -- Receive notifications about new files or partitions added -- Track schema changes in structured files (Parquet, Avro) -- Monitor retention policy or lifecycle rule changes -- Get alerts for access control or governance updates - -**Common Use Cases**: -- Data engineers follow production data lake containers -- Analysts follow containers with datasets they use -- ML engineers follow containers with training/test data -- Compliance teams follow containers with sensitive data - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow containers to receive notifications about new files, schema changes, and retention policy updates. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/storage/directory.md b/docs/data-assets/storage/directory.md index d9e1d54..a8c8b2c 100644 --- a/docs/data-assets/storage/directory.md +++ b/docs/data-assets/storage/directory.md @@ -307,29 +307,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about directory changes** - -Followers allow users to "follow" directories and receive notifications when they change. This is helpful for: - -- **Team Collaboration**: Monitor shared team directories -- **Project Management**: Track project-specific directories -- **Data Organization**: Stay informed about organizational changes -- **Access Control**: Monitor permission changes to directories - -**Key Benefits**: -- Receive notifications about new files or subdirectories added -- Track permission or sharing updates -- Monitor organizational structure changes -- Get alerts for moves, renames, or deletions - -**Common Use Cases**: -- Teams follow shared project directories -- Managers follow departmental directories -- Collaborators follow document repositories -- Admins follow critical system directories - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow directories to receive notifications about new files, permission changes, and organizational structure updates. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/storage/spreadsheet.md b/docs/data-assets/storage/spreadsheet.md index b164d30..782ec28 100644 --- a/docs/data-assets/storage/spreadsheet.md +++ b/docs/data-assets/storage/spreadsheet.md @@ -442,29 +442,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about spreadsheet changes** - -Followers allow users to "follow" spreadsheet files and receive notifications when they change. This is useful for: - -- **Business Teams**: Monitor spreadsheets with business-critical data -- **Collaborators**: Track spreadsheets shared across teams -- **Analysts**: Stay informed about data source spreadsheets -- **Managers**: Monitor planning or reporting spreadsheets - -**Key Benefits**: -- Receive notifications about new worksheets added -- Track structural changes to the spreadsheet -- Monitor sharing or permission updates -- Get alerts for version updates or major edits - -**Common Use Cases**: -- Teams follow shared planning spreadsheets -- Analysts follow spreadsheets they import data from -- Managers follow budget or forecast spreadsheets -- Collaborators follow project tracking spreadsheets - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow spreadsheets to receive notifications about worksheet additions, structural changes, and sharing updates. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-assets/storage/worksheet.md b/docs/data-assets/storage/worksheet.md index ac28811..15014ea 100644 --- a/docs/data-assets/storage/worksheet.md +++ b/docs/data-assets/storage/worksheet.md @@ -467,29 +467,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about worksheet changes** - -Followers allow users to "follow" individual worksheets and receive notifications when they change. This is valuable for: - -- **Business Users**: Monitor worksheets with key business data -- **Analysts**: Track worksheets they reference in reports -- **Data Teams**: Stay informed about collaborative data sources -- **Stakeholders**: Monitor shared data worksheets - -**Key Benefits**: -- Receive notifications about data updates or refreshes -- Track column additions, removals, or type changes -- Monitor formula or calculation updates -- Get alerts for sharing or permission changes - -**Common Use Cases**: -- Business users follow worksheets with KPIs or metrics -- Analysts follow worksheets they use as data sources -- Teams follow collaborative worksheets for planning -- Finance teams follow budget or forecast worksheets - -!!! tip "Learn More" - See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow worksheets to receive notifications about data updates, column changes, and formula modifications. See **[Followers](../../metadata-specifications/followers.md)** for details. --- diff --git a/docs/data-quality/test-case.md b/docs/data-quality/test-case.md index 85e51e5..3f2d9fc 100644 --- a/docs/data-quality/test-case.md +++ b/docs/data-quality/test-case.md @@ -977,29 +977,7 @@ for details on defining and using custom properties. ## Followers -**Stay informed about test case changes** - -Followers allow users to "follow" test cases and receive notifications when they change. This is critical for: - -- **Data Quality Engineers**: Monitor test cases they've created -- **Data Owners**: Track quality tests on their data assets -- **Operations Teams**: Get notified of test failures or changes -- **Compliance**: Monitor tests for regulatory requirements - -**Key Benefits**: -- Receive notifications about test failures or successes -- Track changes to test parameters or thresholds -- Monitor test result trends and anomalies -- Get alerts for test case deprecation or updates - -**Common Use Cases**: -- Data engineers follow critical data quality tests -- Data owners follow tests on their tables -- Operations teams follow tests that trigger alerts -- Compliance officers follow regulatory compliance tests - -!!! tip "Learn More" - See the complete **[Followers Guide](../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks. +Users can follow test cases to receive notifications about test failures, parameter changes, and result trends. See **[Followers](../metadata-specifications/followers.md)** for details. --- diff --git a/docs/core-concepts/followers.md b/docs/metadata-specifications/followers.md similarity index 99% rename from docs/core-concepts/followers.md rename to docs/metadata-specifications/followers.md index 7b69316..3f8363f 100644 --- a/docs/core-concepts/followers.md +++ b/docs/metadata-specifications/followers.md @@ -435,6 +435,7 @@ for change in changes: ## Related Features +- **[Custom Properties](custom-properties.md)**: Extend entities with custom fields - **[Ownership](../teams-users/overview.md#ownership)**: Formal responsibility for data assets - **[Webhooks](../operations/webhook.md)**: Real-time event notifications - **[Alerts](../data-quality/alert.md)**: Data quality and operational alerts diff --git a/mkdocs.yml b/mkdocs.yml index d9878ef..ce1ce6e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -151,7 +151,6 @@ nav: - Introduction: getting-started/introduction.md - Quick Start: getting-started/quick-start.md - Core Concepts: getting-started/core-concepts.md - - Followers: core-concepts/followers.md - Use Cases: getting-started/use-cases.md - Metadata Specifications: - Overview: metadata-specifications/overview.md @@ -251,6 +250,7 @@ nav: - Overview: events/overview.md - Change Event: events/change-event.md - Custom Properties: metadata-specifications/custom-properties.md + - Followers: metadata-specifications/followers.md - Metadata Standards: - Overview: metadata-standards/overview.md - JSON Schema: metadata-standards/json-schemas.md