Skip to content

Commit bc65802

Browse files
authored
update data protocol links to be version agnostic in docs (#29)
1 parent 9a8b983 commit bc65802

4 files changed

Lines changed: 12 additions & 11 deletions

File tree

src/docs/files/getting-started/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
## The OAE Data Protocol
44

5-
The [OAE Data Management Protocol](https://www.carbontosea.org/oae-data-protocol/1-0-0/) is a set of guidelines for collecting, documenting, and sharing data from ocean alkalinity enhancement research. It covers:
5+
The [OAE Data Management Protocol](https://www.carbontosea.org/oae-data-protocol) is a set of guidelines for
6+
collecting, documenting, and sharing data from ocean alkalinity enhancement research. It covers:
67

78
- What metadata to include with your data submissions
89
- Recommended column header names for data files
910
- Controlled vocabularies for consistent terminology
1011
- Guidelines for quality control documentation
1112

1213
!!! info "New to the OAE Data Protocol?"
13-
If you're new to the protocol and want to learn about its guidelines and recommendations before diving into the technical schema, start with the [protocol website](https://www.carbontosea.org/oae-data-protocol/1-0-0/) on Carbon To Sea. It includes the full guidelines, [controlled vocabularies](https://www.carbontosea.org/oae-data-protocol/1-0-0/#controlled-vocabularies), and [recommended column header names](https://www.carbontosea.org/oae-data-protocol/1-0-0/#column-header-name).
14+
If you're new to the protocol and want to learn about its guidelines and recommendations before diving into the technical schema, start with the [protocol website](https://www.carbontosea.org/oae-data-protocol) on Carbon To Sea. It includes the full guidelines, [controlled vocabularies](https://www.carbontosea.org/oae-data-protocol#controlled-vocabularies), and [recommended column header names](https://www.carbontosea.org/oae-data-protocol#column-header-names).
1415

1516
## The OAE Data Schema
1617

src/docs/files/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Schema Documentation
22

3-
The [OAE Data Management Protocol](https://www.carbontosea.org/oae-data-protocol/1-0-0/) outlines recommendations for
4-
producing consistent data and metadata across Ocean Alkalinity Enhancement research projects, developed by [Carbon To Sea](https://carbontosea.org) and [Submarine Scientific](https://submarine.earth) in collaboration with NOAA and the broader OAE community.
3+
The [OAE Data Management Protocol](https://www.carbontosea.org/oae-data-protocol) outlines recommendations for
4+
producing consistent data and metadata across Ocean Alkalinity Enhancement projects, developed by [Carbon To Sea](https://carbontosea.org) and [Submarine Scientific](https://submarine.earth) in collaboration with NOAA and the broader OAE community.
55

66
This site serves as the technical documentation for the machine-readable schemas that turn those recommendations into something software systems can validate and exchange.
77

@@ -20,11 +20,11 @@ The OAE Data Protocol is a structured approach to collecting, documenting, and s
2020
- **Variables** — Measured, calculated, and contextual variables with instrument and calibration metadata
2121

2222
For protocol requirements pertaining to general metadata management, excel metadata templates, dataset formatting, and
23-
column header names, see the [published protocol](https://www.carbontosea.org/oae-data-protocol/1-0-0/).
23+
column header names, see the [published protocol](https://www.carbontosea.org/oae-data-protocol).
2424

2525

2626
### Published Artifacts & Resources
27-
- [OAE Metadata Builder](https://github.com/submarine-mrv/oae-metadata-builder) — Web app for creating and managing JSON metadata files
27+
- [OAE Metadata Builder](https://metadata.oaedata.org) — Web app for creating and managing JSON metadata files
2828
- [JSON Schema](https://github.com/submarine-mrv/oae-data-protocol/blob/main/project/jsonschema/oae_data_protocol.schema.json) — Machine readable schemas used for validation
2929
- [LinkML Source Schema](https://github.com/submarine-mrv/oae-data-protocol/tree/main/src/oae_data_protocol/schema) — The source of truth for generating all schema artifacts and documentation (contributors should only edit these files)
3030
- [Python Dataclasses](https://github.com/submarine-mrv/oae-data-protocol/blob/main/src/oae_data_protocol/datamodel/oae_data_protocol.py) — For managing metadata directly in Python workflows (WIP)

src/docs/files/metadata-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The OAE Data Protocol uses **JSON** as its preferred metadata file format.
44

55
Each metadata file is a self-contained document called a **Container** that holds all the metadata for a project, its experiments, and its datasets.
66

7-
The recommended way to create metadata is with the **[OAE Metadata Builder](https://metadata.oaedata.org)**, which validates inputs against the schema in real time and exports well-formed JSON files. While [Excel templates](https://www.carbontosea.org/oae-data-protocol/1-0-0/#metadata-and-templates) are still available on the protocol website, they do not validate against the schema and require manual attention to ensure controlled vocabularies and field formats are correct. We encourage all researchers to use the Metadata Builder as the primary tool for creating and managing project metadata.
7+
The recommended way to create metadata is with the **[OAE Metadata Builder](https://metadata.oaedata.org)**, which validates inputs against the schema in real time and exports well-formed JSON files. While [Excel templates](https://www.carbontosea.org/oae-data-protocol#metadata-and-templates) are still available on the protocol website, they do not validate against the schema and require manual attention to ensure controlled vocabularies and field formats are correct. We encourage all researchers to use the Metadata Builder as the primary tool for creating and managing project metadata.
88

99
## The Container
1010

src/docs/files/vocabularies.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The OAE Data Protocol uses controlled vocabularies to standardize categorical values across metadata submissions. Some are defined as part of the protocol, while others reference established community standards.
44

5-
For detailed definitions of each vocabulary, see the [Controlled Vocabularies](https://www.carbontosea.org/oae-data-protocol/1-0-0/#controlled-vocabularies) section of the OAE Data Protocol website.
5+
For detailed definitions of each vocabulary, see the [Controlled Vocabularies](https://www.carbontosea.org/oae-data-protocol#controlled-vocabularies) section of the OAE Data Protocol website.
66

77
## Community Standard Vocabularies
88

@@ -11,13 +11,13 @@ The following vocabularies are sourced from established oceanographic & scientif
1111
| Vocabulary | Source | Used For |
1212
|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
1313
| **Sea Names** | NERC [SDN:C16](https://vocab.nerc.ac.uk/collection/C16/current/) | Project geographic classification |
14-
| **[Platform Type](https://www.carbontosea.org/oae-data-protocol/1-0-0/#platform-type)** | NERC [SDN:L06](https://vocab.nerc.ac.uk/collection/L06/current/) | Dataset platform classification |
15-
| **[Instrument Type](https://www.carbontosea.org/oae-data-protocol/1-0-0/#instrument-type)** | NERC [SDN:L05](https://vocab.nerc.ac.uk/collection/L05/current/), [SDN:L22](https://vocab.nerc.ac.uk/collection/L22/current/), [SDN:B75](https://vocab.nerc.ac.uk/collection/B75/current/) | Sampling and analyzing instruments |
14+
| **[Platform Type](https://www.carbontosea.org/oae-data-protocol#platform-type)** | NERC [SDN:L06](https://vocab.nerc.ac.uk/collection/L06/current/) | Dataset platform classification |
15+
| **[Instrument Type](https://www.carbontosea.org/oae-data-protocol#instrument-type)** | NERC [SDN:L05](https://vocab.nerc.ac.uk/collection/L05/current/), [SDN:L22](https://vocab.nerc.ac.uk/collection/L22/current/), [SDN:B75](https://vocab.nerc.ac.uk/collection/B75/current/) | Sampling and analyzing instruments |
1616
| **Units** | [QUDT](https://qudt.org/vocab/unit/) | Dosing concentration units |
1717

1818
## OAE Data Protocol Vocabularies
1919

20-
These vocabularies are defined as part of the [OAE Data Protocol](https://www.carbontosea.org/oae-data-protocol/1-0-0/#controlled-vocabularies) and maintained in this schema.
20+
These vocabularies are defined as part of the [OAE Data Protocol](https://www.carbontosea.org/oae-data-protocol#controlled-vocabularies) and maintained in this schema.
2121

2222
### Classification
2323

0 commit comments

Comments
 (0)