Skip to content

Commit c44b842

Browse files
authored
Merge pull request #10 from open-metadata/fix_build
Fix followers specification
2 parents a8d07fe + d70eb02 commit c44b842

File tree

15 files changed

+15
-318
lines changed

15 files changed

+15
-318
lines changed

docs/data-assets/apis/api-endpoint.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1365,29 +1365,7 @@ for details on defining and using custom properties.
13651365

13661366
## Followers
13671367

1368-
**Stay informed about API endpoint changes**
1369-
1370-
Followers allow users to "follow" API endpoints and receive notifications when they change. This is critical for:
1371-
1372-
- **API Consumers**: Monitor endpoints your applications depend on
1373-
- **Backend Engineers**: Track endpoints you own or maintain
1374-
- **Integration Teams**: Stay informed about contract changes
1375-
- **API Product Managers**: Monitor endpoint usage and evolution
1376-
1377-
**Key Benefits**:
1378-
- Receive notifications about breaking changes to request/response schemas
1379-
- Track deprecation notices and versioning changes
1380-
- Monitor authentication or rate limiting updates
1381-
- Get alerts for SLA or performance threshold changes
1382-
1383-
**Common Use Cases**:
1384-
- Frontend developers follow endpoints their apps consume
1385-
- Backend engineers follow production endpoints they maintain
1386-
- DevOps teams follow critical API endpoints for monitoring
1387-
- Product teams follow public API endpoints for customer impact
1388-
1389-
!!! tip "Learn More"
1390-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1368+
Users can follow API endpoints to receive notifications about schema changes, deprecation notices, and authentication updates. See **[Followers](../../metadata-specifications/followers.md)** for details.
13911369

13921370
---
13931371

docs/data-assets/dashboards/chart.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,29 +1014,7 @@ for details on defining and using custom properties.
10141014

10151015
## Followers
10161016

1017-
**Stay informed about chart changes**
1018-
1019-
Followers allow users to "follow" individual charts and receive notifications when they change. This is useful for:
1020-
1021-
- **Chart Creators**: Monitor charts they've built
1022-
- **Metric Owners**: Track visualizations of key business metrics
1023-
- **Stakeholders**: Stay informed about specific KPI visualizations
1024-
- **Collaboration**: Work with team members on chart refinements
1025-
1026-
**Key Benefits**:
1027-
- Receive notifications about chart configuration changes
1028-
- Track changes to underlying queries or data sources
1029-
- Monitor visualization type or display property updates
1030-
- Get alerts for ownership or deprecation changes
1031-
1032-
**Common Use Cases**:
1033-
- Analysts follow charts they created or maintain
1034-
- Business users follow charts showing their KPIs
1035-
- Data teams follow charts using complex calculations
1036-
- Executives follow critical metric visualizations
1037-
1038-
!!! tip "Learn More"
1039-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1017+
Users can follow charts to receive notifications about visualization changes, query modifications, and data source updates. See **[Followers](../../metadata-specifications/followers.md)** for details.
10401018

10411019
---
10421020

docs/data-assets/dashboards/dashboard.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,29 +1036,7 @@ for details on defining and using custom properties.
10361036

10371037
## Followers
10381038

1039-
**Stay informed about dashboard changes**
1040-
1041-
Followers allow users to "follow" a dashboard and receive notifications when it changes. This is particularly valuable for:
1042-
1043-
- **Business Stakeholders**: Track dashboards with key business metrics and KPIs
1044-
- **Report Consumers**: Get notified when dashboards are updated or metrics change
1045-
- **Collaboration**: Stay in sync with team members working on shared dashboards
1046-
- **Governance**: Monitor dashboards for compliance and data quality
1047-
1048-
**Key Benefits**:
1049-
- Receive notifications about dashboard updates and refreshes
1050-
- Track changes to underlying data sources or calculations
1051-
- Monitor chart additions, removals, or modifications
1052-
- Get alerts for ownership, tier, or governance changes
1053-
1054-
**Common Use Cases**:
1055-
- Executives follow executive dashboards for KPI tracking
1056-
- Product managers follow dashboards tracking product metrics
1057-
- Analysts follow dashboards they've created or contributed to
1058-
- Data engineers follow dashboards to monitor data pipeline health
1059-
1060-
!!! tip "Learn More"
1061-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1039+
Users can follow dashboards to receive notifications about updates, chart changes, and data source modifications. See **[Followers](../../metadata-specifications/followers.md)** for details.
10621040

10631041
---
10641042

docs/data-assets/databases/database.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -751,34 +751,7 @@ for details on defining and using custom properties.
751751

752752
## Followers
753753

754-
**Stay informed about database changes**
755-
756-
Followers allow users to "follow" a database and receive notifications when it changes. This is useful for:
757-
758-
- **Monitoring Dependencies**: Get notified when databases your applications depend on change
759-
- **Staying Informed**: Track databases you're interested in without being the owner
760-
- **Collaboration**: Stay in sync with team members working on the same databases
761-
- **Governance**: Monitor databases with compliance requirements
762-
763-
**Key Benefits**:
764-
- Receive notifications about schema changes, new schemas, or deletions
765-
- Track governance changes (tags, ownership, domain assignments)
766-
- Monitor data quality issues at the database level
767-
- Get alerts for deprecation notices
768-
769-
**Following vs Ownership**:
770-
- **Ownership** = Responsibility and accountability for the database
771-
- **Following** = Interest and awareness about the database
772-
773-
Any user can follow any database they have access to. A database can have multiple followers.
774-
775-
!!! tip "Learn More"
776-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about:
777-
778-
- How to follow databases via UI and API
779-
- Notification preferences and configuration
780-
- Best practices for using followers effectively
781-
- Integration with webhooks and activity feeds
754+
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.
782755

783756
---
784757

docs/data-assets/databases/table.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1324,42 +1324,7 @@ for details on defining and using custom properties.
13241324

13251325
## Followers
13261326

1327-
**Stay informed about table changes**
1328-
1329-
Followers allow users to "follow" a table and receive notifications when it changes. This is one of the most useful features for data practitioners:
1330-
1331-
- **Monitor Dependencies**: Get notified when tables your applications or dashboards depend on change
1332-
- **Schema Changes**: Receive alerts when columns are added, removed, or modified
1333-
- **Data Quality**: Be notified of test failures, anomalies, or freshness issues
1334-
- **Collaboration**: Track tables you're working on with others
1335-
1336-
**Key Benefits**:
1337-
- Receive notifications about schema changes (new columns, type changes)
1338-
- Track data quality test results and failures
1339-
- Monitor data profiling anomalies (unusual null rates, distribution changes)
1340-
- Get alerts for deprecation, tier changes, or ownership updates
1341-
- Stay informed about query usage patterns and popularity
1342-
1343-
**Following vs Ownership**:
1344-
- **Ownership** = Responsibility and accountability for the table's quality and accuracy
1345-
- **Following** = Interest in being notified about changes to the table
1346-
1347-
Any user can follow any table they have access to. Tables typically have multiple followers (analysts, engineers, data scientists who use the data).
1348-
1349-
**Common Use Cases**:
1350-
- Data scientists follow source tables for their ML models
1351-
- Analysts follow tables used in their reports and dashboards
1352-
- Data engineers follow tables in production pipelines
1353-
- Compliance officers follow tables containing PII or sensitive data
1354-
1355-
!!! tip "Learn More"
1356-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about:
1357-
1358-
- How to follow tables via UI and API
1359-
- Configuring notification preferences (immediate vs digest)
1360-
- Best practices for avoiding notification overload
1361-
- Bulk following patterns (e.g., follow all tables in a domain)
1362-
- Integration with webhooks and Slack/Teams
1327+
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.
13631328

13641329
---
13651330

docs/data-assets/messaging/topic.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1235,29 +1235,7 @@ for details on defining and using custom properties.
12351235

12361236
## Followers
12371237

1238-
**Stay informed about topic changes**
1239-
1240-
Followers allow users to "follow" a topic and receive notifications when it changes. This is critical for:
1241-
1242-
- **Event Producers**: Monitor topics they publish to
1243-
- **Event Consumers**: Track schema changes in topics they consume
1244-
- **Platform Teams**: Get notified of topic configuration changes
1245-
- **Compliance**: Monitor topics with sensitive data
1246-
1247-
**Key Benefits**:
1248-
- Receive notifications about schema changes (critical for compatibility)
1249-
- Track partition count or replication factor changes
1250-
- Monitor retention policy or configuration updates
1251-
- Get alerts for deprecation, ownership, or governance changes
1252-
1253-
**Common Use Cases**:
1254-
- Developers follow topics their services consume
1255-
- Platform engineers follow all production topics
1256-
- Data scientists follow topics with ML training events
1257-
- Compliance officers follow topics with PII or sensitive data
1258-
1259-
!!! tip "Learn More"
1260-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1238+
Users can follow topics to receive notifications about schema changes, partition updates, and configuration modifications. See **[Followers](../../metadata-specifications/followers.md)** for details.
12611239

12621240
---
12631241

docs/data-assets/ml/mlmodel.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,29 +1421,7 @@ for details on defining and using custom properties.
14211421

14221422
## Followers
14231423

1424-
**Stay informed about ML model changes**
1425-
1426-
Followers allow users to "follow" an ML model and receive notifications when it changes. This is valuable for:
1427-
1428-
- **Data Scientists**: Monitor models they've developed or deployed
1429-
- **ML Engineers**: Track model version changes and deployments
1430-
- **Stakeholders**: Stay informed about production model updates
1431-
- **Compliance**: Monitor models for governance and regulatory requirements
1432-
1433-
**Key Benefits**:
1434-
- Receive notifications about model version updates
1435-
- Track feature or algorithm changes
1436-
- Monitor performance metrics and drift
1437-
- Get alerts for ownership, deprecation, or governance updates
1438-
1439-
**Common Use Cases**:
1440-
- Data scientists follow models in production
1441-
- ML engineers follow models they deploy and maintain
1442-
- Product managers follow models powering product features
1443-
- Compliance teams follow models with regulatory implications
1444-
1445-
!!! tip "Learn More"
1446-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1424+
Users can follow ML models to receive notifications about version updates, performance metrics, and deployment changes. See **[Followers](../../metadata-specifications/followers.md)** for details.
14471425

14481426
---
14491427

docs/data-assets/pipelines/pipeline.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1209,29 +1209,7 @@ for details on defining and using custom properties.
12091209

12101210
## Followers
12111211

1212-
**Stay informed about pipeline changes**
1213-
1214-
Followers allow users to "follow" a pipeline and receive notifications when it changes. This is essential for:
1215-
1216-
- **Data Engineers**: Monitor pipelines they own or maintain
1217-
- **Pipeline Dependencies**: Track upstream/downstream pipeline changes
1218-
- **Operations**: Get notified of pipeline failures or configuration changes
1219-
- **Stakeholders**: Stay informed about ETL processes affecting their data
1220-
1221-
**Key Benefits**:
1222-
- Receive notifications about pipeline configuration changes
1223-
- Track task additions, removals, or modifications
1224-
- Monitor pipeline schedule or trigger changes
1225-
- Get alerts for ownership, deprecation, or governance updates
1226-
1227-
**Common Use Cases**:
1228-
- Data engineers follow production pipelines they maintain
1229-
- Analysts follow pipelines that refresh their reports
1230-
- Data scientists follow pipelines feeding their ML models
1231-
- Operations teams follow critical data pipelines
1232-
1233-
!!! tip "Learn More"
1234-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1212+
Users can follow pipelines to receive notifications about configuration changes, task modifications, and schedule updates. See **[Followers](../../metadata-specifications/followers.md)** for details.
12351213

12361214
---
12371215

docs/data-assets/storage/container.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1509,29 +1509,7 @@ for details on defining and using custom properties.
15091509

15101510
## Followers
15111511

1512-
**Stay informed about container changes**
1513-
1514-
Followers allow users to "follow" storage containers and receive notifications when they change. This is important for:
1515-
1516-
- **Data Engineers**: Monitor data lake containers with production data
1517-
- **Analytics Teams**: Track containers with analytical datasets
1518-
- **Data Scientists**: Stay informed about ML training data locations
1519-
- **Operations**: Monitor storage usage and data lifecycle
1520-
1521-
**Key Benefits**:
1522-
- Receive notifications about new files or partitions added
1523-
- Track schema changes in structured files (Parquet, Avro)
1524-
- Monitor retention policy or lifecycle rule changes
1525-
- Get alerts for access control or governance updates
1526-
1527-
**Common Use Cases**:
1528-
- Data engineers follow production data lake containers
1529-
- Analysts follow containers with datasets they use
1530-
- ML engineers follow containers with training/test data
1531-
- Compliance teams follow containers with sensitive data
1532-
1533-
!!! tip "Learn More"
1534-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1512+
Users can follow containers to receive notifications about new files, schema changes, and retention policy updates. See **[Followers](../../metadata-specifications/followers.md)** for details.
15351513

15361514
---
15371515

docs/data-assets/storage/directory.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -307,29 +307,7 @@ for details on defining and using custom properties.
307307

308308
## Followers
309309

310-
**Stay informed about directory changes**
311-
312-
Followers allow users to "follow" directories and receive notifications when they change. This is helpful for:
313-
314-
- **Team Collaboration**: Monitor shared team directories
315-
- **Project Management**: Track project-specific directories
316-
- **Data Organization**: Stay informed about organizational changes
317-
- **Access Control**: Monitor permission changes to directories
318-
319-
**Key Benefits**:
320-
- Receive notifications about new files or subdirectories added
321-
- Track permission or sharing updates
322-
- Monitor organizational structure changes
323-
- Get alerts for moves, renames, or deletions
324-
325-
**Common Use Cases**:
326-
- Teams follow shared project directories
327-
- Managers follow departmental directories
328-
- Collaborators follow document repositories
329-
- Admins follow critical system directories
330-
331-
!!! tip "Learn More"
332-
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
310+
Users can follow directories to receive notifications about new files, permission changes, and organizational structure updates. See **[Followers](../../metadata-specifications/followers.md)** for details.
333311

334312
---
335313

0 commit comments

Comments
 (0)