Skip to content

Commit b5d92ae

Browse files
committed
Add documentation about reporting
1 parent 9565c4d commit b5d92ae

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Explanations
3+
weight: 4
4+
---
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Reporting
3+
weight: 1
4+
---
5+
6+
# Reporting
7+
8+
Once services are declared in a collection and this collection starts tracking these terms, it becomes crucial to monitor whether the tracking is functioning properly. It is important to know if there are any terms whose tracking has been interrupted or has failed.
9+
10+
## How the reporting system works
11+
12+
To address this need, the Open Terms Archive engine implements an automated reporting system that creates issues in the declarations repository. This system helps maintainers stay informed about which terms are not being tracked and why.
13+
14+
When tracking is interrupted for a specific term, the system opens an issue that explains why the term is not being tracked and associates labels to categorize the cause of the tracking interruption. The system automatically closes issues when tracking resumes after declarations are fixed and deployed.
15+
16+
## Understanding labels
17+
18+
The reporting system uses labels to categorize issues and indicate what action is needed.
19+
20+
### Auto-managed labels
21+
22+
All labels that are marked with `- Auto-managed by OTA engine` in their description are managed by the engine. These labels should:
23+
24+
- **Not** be manually added to issues by maintainers
25+
- **Not** be modified or removed from issues by maintainers
26+
- **Not** have their descriptions or colors edited by maintainers
27+
28+
The engine will automatically manage these labels as needed.
29+
30+
### Issues requiring intervention
31+
32+
The label `⚠ needs intervention` indicates that manual contributor intervention is required to restore tracking. When this label appears on an issue, it means the problem won't be resolved automatically and requires human action to fix the declarations or configuration.
33+
34+
Issues without this label represent tracking interruptions that need investigation to determine the appropriate course of action. These issues may resolve themselves automatically once the underlying problem (such as a temporary network outage or service downtime) is fixed. However, some may not be fixable at all, for example when the tracking engine is detected and blocked as a bot by the target service.

0 commit comments

Comments
 (0)