Skip to content

Commit 4c54d1c

Browse files
committed
Add Followers explanation and AI Governance model
1 parent 8cd2ffa commit 4c54d1c

File tree

17 files changed

+916
-14
lines changed

17 files changed

+916
-14
lines changed

docs/core-concepts/followers.md

Lines changed: 475 additions & 0 deletions
Large diffs are not rendered by default.

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1363,6 +1363,34 @@ for details on defining and using custom properties.
13631363

13641364
---
13651365

1366+
## Followers
1367+
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.
1391+
1392+
---
1393+
13661394
## API Operations
13671395

13681396
### List API Endpoints

docs/data-assets/dashboards/chart.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,6 +1012,34 @@ for details on defining and using custom properties.
10121012

10131013
---
10141014

1015+
## Followers
1016+
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.
1040+
1041+
---
1042+
10151043
## API Operations
10161044

10171045
All Chart operations are available under the `/v1/charts` endpoint.

docs/data-assets/dashboards/dashboard.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1034,6 +1034,34 @@ for details on defining and using custom properties.
10341034

10351035
---
10361036

1037+
## Followers
1038+
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.
1062+
1063+
---
1064+
10371065
## API Operations
10381066

10391067
All Dashboard operations are available under the `/v1/dashboards` endpoint.

docs/data-assets/databases/database-schema.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ The **DatabaseSchema** entity represents a logical namespace within a database t
1414
graph LR
1515
A[DatabaseService] --> B[Database]
1616
B --> C[Schema]
17-
C --> D[Table]
18-
D --> E[Column]
17+
C --> D1[Table]
18+
C --> D2[StoredProcedure]
19+
D1 --> E[Column]
1920
2021
style A fill:#667eea,color:#fff
2122
style B fill:#4facfe,color:#fff
2223
style C fill:#00f2fe,color:#333
23-
style D fill:#00f2fe,color:#333
24+
style D1 fill:#00f2fe,color:#333
25+
style D2 fill:#00f2fe,color:#333
2426
style E fill:#e0f2fe,color:#333
2527
```
2628

docs/data-assets/databases/database.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ The **Database** entity represents a logical database within a database service.
1414
graph LR
1515
A[DatabaseService] --> B[Database]
1616
B --> C[Schema]
17-
C --> D[Table]
18-
D --> E[Column]
17+
C --> D1[Table]
18+
C --> D2[StoredProcedure]
19+
D1 --> E[Column]
1920
2021
style A fill:#667eea,color:#fff
2122
style B fill:#4facfe,color:#fff
2223
style C fill:#00f2fe,color:#333
23-
style D fill:#00f2fe,color:#333
24+
style D1 fill:#00f2fe,color:#333
25+
style D2 fill:#00f2fe,color:#333
2426
style E fill:#e0f2fe,color:#333
2527
```
2628

@@ -34,6 +36,7 @@ graph LR
3436
### Child Entities
3537
- **DatabaseSchema**: Schemas within this database
3638
- **Table**: All tables across all schemas in this database
39+
- **StoredProcedure**: All stored procedures across all schemas in this database
3740

3841
### Associated Entities
3942
- **Owner**: User or team owning this database
@@ -746,6 +749,39 @@ for details on defining and using custom properties.
746749

747750
---
748751

752+
## Followers
753+
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
782+
783+
---
784+
749785
## API Operations
750786

751787
All Database operations are available under the `/v1/databases` endpoint.

docs/data-assets/databases/table.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1322,6 +1322,47 @@ for details on defining and using custom properties.
13221322

13231323
---
13241324

1325+
## Followers
1326+
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
1363+
1364+
---
1365+
13251366
## API Operations
13261367

13271368
All Table operations are available under the `/v1/tables` endpoint.

docs/data-assets/messaging/topic.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1233,6 +1233,34 @@ for details on defining and using custom properties.
12331233

12341234
---
12351235

1236+
## Followers
1237+
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.
1261+
1262+
---
1263+
12361264
## API Operations
12371265

12381266
All Topic operations are available under the `/v1/topics` endpoint.

docs/data-assets/ml/mlmodel.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1419,6 +1419,34 @@ for details on defining and using custom properties.
14191419

14201420
---
14211421

1422+
## Followers
1423+
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.
1447+
1448+
---
1449+
14221450
## API Operations
14231451

14241452
All ML Model operations are available under the `/v1/mlmodels` endpoint.

docs/data-assets/pipelines/pipeline.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1207,6 +1207,34 @@ for details on defining and using custom properties.
12071207

12081208
---
12091209

1210+
## Followers
1211+
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.
1235+
1236+
---
1237+
12101238
## API Operations
12111239

12121240
All Pipeline operations are available under the `/v1/pipelines` endpoint.

0 commit comments

Comments
 (0)