Skip to content

Commit

Permalink
Documentation updates (#62)
Browse files Browse the repository at this point in the history
* Reorganized the prototype related docs into their own subsection.

* Updated readme structure

* Wrote out recommendations
  • Loading branch information
jonmjoyce authored Jun 24, 2024
1 parent f82e9d9 commit eeaca37
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- [**Project Documentation**](https://asascience-open.github.io/nextgen-dmac/)

- **Prototypes:** [Planning and Design](https://asascience-open.github.io/nextgen-dmac/protoplan.html) | [Outcomes](https://asascience-open.github.io/nextgen-dmac/outcomes.html)
- **Prototypes:** [Planning](https://asascience-open.github.io/nextgen-dmac/prototypes/protoplan.html) | [Design](https://asascience-open.github.io/nextgen-dmac/prototypes/architecture.html) | [Outcomes](https://asascience-open.github.io/nextgen-dmac/prototypes/outcomes.html)

- **Presentations:** [DMAC Tech Webinar](https://www.youtube.com/watch?v=M8E2wQk3k8A) | [Pangeo Showcase](https://discourse.pangeo.io/t/pangeo-showcase-improving-access-to-noaa-national-ocean-service-model-data-with-kerchunk-and-xpublish/3725)

Expand Down
4 changes: 4 additions & 0 deletions docs/architecture/considerations.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,8 @@ Consider "the cloud" as an IT infrastructure, with computational resources avail

Each of the 11 Regional Associations (RAs), as part of NOAA-IOOS, operate independent infrastructure to process, store, and serve their data. The RAs mainly operate Traditional On-Premises and Infrastructure-as-a-Service (such as VMWare) configurations. Several RAs run services in the cloud, and the cloud providers used vary.

It is important to ensure that the RAs are able to operate independently and have the resources they need. The cloud is a centralized IT infrastructure that is meant to be accessed from anywhere in the world and maintains a high operational posture. IOOS as a whole can adopt cloud infrastructure to reduce the burden of maintaining on-premises systems and shift those resources toward creating services and data products for downstream customers. Much of the infrastructure and plumbing can be shared across RAs, but the key differentiator will be providing cloud-optimized data access to the important data products produced by each RA.

The following diagram shows the recommended overall system architecture.

![System Architecture recommendation](../assets/overall-architecture-rec.png)
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav_order: 1

|   |   |   |
|-|-|-|
| **Prototypes** | [Planning and Design](protoplan.md) | [Outcomes](outcomes.md) |
| **Prototypes** | [Planning and Design](prototypes/protoplan.md) | [Outcomes](prototypes/outcomes.md) |
| **Presentations** | [DMAC Tech Webinar](https://www.youtube.com/watch?v=M8E2wQk3k8A) | [Pangeo Showcase](https://discourse.pangeo.io/t/pangeo-showcase-improving-access-to-noaa-national-ocean-service-model-data-with-kerchunk-and-xpublish/3725) |
| **Demos** | [XREDS Test](https://nextgen-dev.ioos.us/xreds/) | [OceansMap Test](https://dev.oceansmap.com/maracoos/?catalog=dmac_combined) |
| **Notebooks** | [NetCDF vs Zarr](https://github.com/asascience-open/nextgen-dmac/blob/main/binder/dbofs-examples/netcdf-vs-zarr.ipynb) | [Best Forecast Retrieval](https://github.com/asascience-open/nextgen-dmac/blob/main/binder/dbofs-examples/best-forecast.ipynb) |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: default
nav_order: 2
has_children: true
title: System Architecture
parent: Prototypes
title: Design Philosophy
---

# System Architecture
Expand Down
3 changes: 2 additions & 1 deletion docs/outcomes.md → docs/prototypes/outcomes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Prototype Outcomes
title: Outcomes
parent: Prototypes
nav_order: 3
---

Expand Down
14 changes: 3 additions & 11 deletions docs/protoplan.md → docs/prototypes/protoplan.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
---
layout: default
title: Prototype Plan
nav_order: 2
parent: Prototypes
title: Plan
nav_order: 1
---

# Prototype Plan

## Technical Documentation

Completed prototypes have been documented alongside their code.

- [Kerchunk Ingest for NOS model data](https://github.com/asascience-open/nextgen-dmac/tree/main/kerchunk)
- [Argo Workflows Test of QARTOD and IOOS Compliance Checker](https://github.com/asascience-open/nextgen-dmac/tree/main/qc_and_cchecker)

## Prototype Plan

The planned prototypes seek to demonstrate a modern, interconnected system. Visit the links below to learn more about each prototype design and considerations.

**[Overall System Architecture](architecture/architecture.md)**
Expand Down

0 comments on commit eeaca37

Please sign in to comment.