Skip to content

Commit b2fdf2d

Browse files
committed
Update OceanDataStore docs structure and links on Getting Started page.
1 parent 74e435b commit b2fdf2d

2 files changed

Lines changed: 21 additions & 12 deletions

File tree

docs/docs/index.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ To access ocean model and observational data stored in cloud object storage, Oce
2222
* Search catalogs by collection, variable names or platform (grid type).
2323
* Subset & open Analysis-Ready Cloud Optimised ([**ARCO**](https://doi.org/10.1109/MCSE.2021.3059437)) datasets as lazy [**xarray**](https://docs.xarray.dev/en/stable/user-guide/data-structures.html) Datasets.
2424

25+
To get started exploring our publicly available ocean data, visit our interactive **[Catalog Browser]**.
26+
2527
---
2628

2729
## Quick Start :rocket:
@@ -55,10 +57,15 @@ pip install git+https://github.com/NOC-MSM/OceanDataStore.git
5557

5658
### Learning More...
5759

58-
To learn more about writing ocean data to cloud object storage using the **OceanDataStore CLI**, see the [CLI] section of the User Guide. Alternatively, explore some typical workflows by visiting the [Examples] page.
60+
* To browse the publicly available ocean model outputs generated by the National Oceanography Centre, visit our **[Catalog Browser]**.
61+
62+
* To get started accessing ocean model outputs using our Python API, visit our **[OceanDataCatalog]** page.
63+
64+
* To learn more about writing ocean data to cloud object storage using the OceanDataStore CLI, visit our **[CLI User Guide]**.
5965

60-
To get started exploring the available ocean model outputs generated by the National Oceanography Centre, see the OceanDataCatalog section of the [User Guide].
66+
* To explore some typical OceanDataStore CLI workflows, visit our **[CLI Examples]** page.
6167

62-
[CLI]: cli_guide.md
68+
[Catalog Browser]: catalog.md
69+
[CLI User Guide]: cli_guide.md
6370
[OceanDataCatalog]: catalog_guide.md
64-
[Examples]: examples.md
71+
[CLI Examples]: examples.md

docs/mkdocs.yml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,17 @@ markdown_extensions:
7373
- pymdownx.blocks.caption
7474

7575
nav:
76-
- Getting started: index.md
77-
- User Guide:
78-
- catalog_guide.md
79-
- cli_guide.md
80-
- Examples:
81-
- OceanDataCatalog_example.ipynb
76+
- Getting Started: index.md
77+
- CLI:
78+
- User Guide: cli_guide.md
79+
- OceanDataCatalog:
80+
- User Guide: catalog_guide.md
81+
- Examples:
82+
- OceanDataCatalog_example.ipynb
83+
- Catalog Browser: catalog.md
8284
- Reference:
83-
- catalog_reference.md
84-
- cli_reference.md
85+
- OceanDataCatalog: catalog_reference.md
86+
- CLI: cli_reference.md
8587

8688
plugins:
8789
- search

0 commit comments

Comments
 (0)