Skip to content

Commit ea36d28

Browse files
authored
Update checks.md "Summary Table" doc (#1522)
The clomonitor_name field is mandatory to map entries in the landscape to the CLOMonitor data files. Without it, checks based on the landscape cannot be performed. This PR updated the doc accordingly, see #1519 Signed-off-by: Yacine Kheddache <[email protected]>
1 parent 28cd493 commit ea36d28

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/checks.md

+8
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,14 @@ This check passes if:
296296

297297
- At least *one* of the [summary_* fields](https://github.com/cncf/landscape/blob/master/docs/item_summary.md) has been set in the project's *extra* section in the [Landscape yaml file](https://github.com/cncf/landscape/blob/master/landscape.yml).
298298

299+
Please note that the clomonitor_name field is **mandatory** for this check to pass:
300+
```sh
301+
extra:
302+
clomonitor_name: project-name
303+
```
304+
305+
The project-name used in the clomonitor_name field must match exactly the project's name used in the corresponding CLOMonitor [data file](https://github.com/cncf/landscape2/blob/e45368319bf44b5894039f6b49c6468bdff67112/docs/config/data.yml#L140-L144).
306+
299307
### Website
300308

301309
**ID**: `website`

0 commit comments

Comments
 (0)