Skip to content

Commit 02eedf6

Browse files
committed
update doc
1 parent b25a68b commit 02eedf6

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

docs/configuration.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Configuration
22

3+
The quickest way to get started is to generate starter templates with the CLI:
4+
5+
```bash
6+
deep-code generate-config # writes to current directory
7+
deep-code generate-config -o ./configs # custom output folder
8+
```
9+
10+
This creates `dataset_config.yaml` and `workflow_config.yaml` with all supported fields and placeholder values. Fill them in, then run [`deep-code publish`](cli.md#publish-metadata).
11+
12+
The sections below document every field in those templates.
13+
14+
---
15+
316
## Dataset config (YAML)
417
```yaml
518
# Required
@@ -80,6 +93,7 @@ properties:
8093
keywords: ["Earth Science"]
8194
themes: ["cryosphere"]
8295
license: proprietary
96+
# jupyter_kernel_info is optional — only published when jupyter_notebook_url is set
8397
jupyter_kernel_info:
8498
name: deepesdl-xcube-1.8.3
8599
python_version: 3.11
@@ -111,8 +125,8 @@ links:
111125
| `properties.keywords` | No | List of keyword strings. |
112126
| `properties.themes` | No | List of OSC theme slugs. |
113127
| `properties.license` | No | License identifier (e.g. `proprietary`, `CC-BY-4.0`). |
114-
| `properties.jupyter_kernel_info` | No | Kernel name, Python version, and environment file URL. |
115128
| `jupyter_notebook_url` | No | Link to the source notebook on GitHub. When omitted, kernel and application links are skipped. |
129+
| `properties.jupyter_kernel_info` | No | Kernel name, Python version, and environment file URL. Only published when `jupyter_notebook_url` is set. |
116130
| `contact` | No | List of contact objects with `name`, `organization`, and `links`. |
117131
| `links` | No | Additional OGC API record links (e.g. `related`, `describedby`). |
118132

0 commit comments

Comments
 (0)