Skip to content

Commit 29a44cb

Browse files
committed
updated docs with description filed
1 parent 46171f0 commit 29a44cb

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

docs/configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ cf_parameter:
4545
| `osc_region` | No | Geographical region label (default: `Global`). |
4646
| `dataset_status` | No | One of `ongoing`, `completed`, or `planned` (default: `ongoing`). |
4747
| `access_link` | No | Public S3 URL of the Zarr store. Defaults to `s3://deep-esdl-public/{dataset_id}`. |
48+
| `description` | No | Human-readable description of the dataset. Overrides the `description` attribute in the Zarr store; falls back to `"No description available."` if neither is set. |
4849
| `documentation_link` | No | URL to dataset documentation. |
4950
| `visualisation_link` | No | URL to a visualisation of the dataset (e.g. xcube Viewer, WMS). Added as a `visualisation` link with title `"Dataset visualisation"`. |
5051
| `cf_parameter` | No | List of CF metadata dicts to override variable attributes (e.g. `name`, `units`). |

0 commit comments

Comments
 (0)