Skip to content

Commit 52e4d0e

Browse files
authored
fix: v1.0.1 refactor
- SUMMARY.md - instructions.md - README.md
1 parent f5fd3fb commit 52e4d0e

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ESS-DIVE Reporting Format for location metadata v 1.0.0
1+
# ESS-DIVE Reporting Format for location metadata v1.0.1
22

33
## About the reporting format
44
ESS-DIVE's location reporting format is intended to guide users in providing a minimal set of metadata about locations.
@@ -8,11 +8,14 @@ This reporting format was developed by synthesizing the requirements for reporti
88
## Quickstart Guide
99
1. **Read** reporting format [instructions](instructions.md) to understand how to fill out templates.
1010
2. **Review** our [terminology guide](term_list/guide.md) to understand definitions of each term used in the templates.
11-
3. **Download** blank copy of [reporting format template](https://github.com/ess-dive-community/essdive-location-metadata/tree/main/templates)
11+
3. **Download** blank copy of [reporting format template](templates)
1212
4. **Save** your completed locations metadata template as a CSV file and upload to ESS-DIVE as part of your dataset.
1313

14+
## Updates in v1.0.1
15+
In March 2025, a patch version of the Location Metadata reporting format was made to improve the overall experience with the associated reporting format documentation. Additionally, the standard reporting format keyword and standard term were added to the instructions.md file.
16+
1417
## How to contribute
15-
We encourage users to contribute to this reporting format. Please submit any comments or suggestions via a [GitHub issue](https://github.com/ess-dive-community/essdive-location-metadata/issues/new/choose) or by emailing ESS-DIVE support at ess-dive-support *at* lbl.gov
18+
We encourage users to contribute to this reporting format. Please submit any comments or suggestions via a [GitHub issue](https://github.com/ess-dive-workspace/essdive-location-metadata/issues/new/choose) or by emailing ESS-DIVE support at ess-dive-support *at* lbl.gov
1619

1720
## Licensing information
1821
This repository content is licensed for use under the [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/)

SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
* [Instructions](instructions.md)
55
* [Term guide](term_list/guide.md)
66
* Blank templates
7-
* [CSV version](https://github.com/ess-dive-community/essdive-location-metadata/blob/main/templates/Location_metadata_template.csv)
8-
* [Excel version](https://github.com/ess-dive-community/essdive-location-metadata/blob/main/templates/Location_metadata_template.xlsx)
7+
* [CSV version](/templates/Location_metadata_template.csv)
8+
* [Excel version](templates/Location_metadata_template.xlsx)
99
* [License](LICENSE.md)

instructions.md

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

33
The locations metadata reporting format is intended to help researchers compile a minimal set of metadata about point locations.
44

5-
To begin using the format, we recommend that users first read through the reporting format’s [terminology guide](https://github.com/ess-dive-community/essdive-location-metadata/blob/main/term_list/guide.md). The guide provides names, definitions, applicable units, and examples for each reporting format element that you will find in the reporting format templates.
5+
To begin using the format, we recommend that users first read through the reporting format’s [terminology guide](term_list/guide.md). The guide provides names, definitions, applicable units, and examples for each reporting format element that you will find in the reporting format templates.
66

77
After reviewing the guide, download a blank copy of the reporting format template. While you can choose to either download a CSV or Excel compatible version of the template, when uploading to ESS-DIVE, **we require that completed location metadata are uploaded in the non-proprietary CSV format**.
88

9+
Within the FLMD file, the standard for each location metadata reporting format related file should be **ESS-DIVE Location v1**. If submitting your dataset to ESS-DIVE, include the keyword **ESS-DIVE Location Metadata Reporting Format** in the package-level metadata.
10+
911
The template includes both required (e.g., `Submission_Contact_Name`) and optional (e.g., `Location_Alias`) fields for you to complete. You are only required to fill out the first 6 elements pictured below. These are also listed as required fields in our guide.
1012

1113
![Example of spreadsheet with only required fields listed](.gitbook/assets/required.png)
@@ -14,5 +16,5 @@ Once you have filled out the location reporting format template, please delete t
1416

1517
![Example of spreadsheet with instructions and examples removed](.gitbook/assets/examples_removed.png)
1618

17-
As you begin to use the reporting format, we encourage you to submit any suggestions you have for improving the template, instructions, or any other repository content via a [GitHub issue](https://github.com/ess-dive-community/essdive-location-metadata/issues/new/choose).
19+
As you begin to use the reporting format, we encourage you to submit any suggestions you have for improving the template, instructions, or any other repository content via a [GitHub issue](https://github.com/ess-dive-workspace/essdive-location-metadata/issues/new/choose).
1820

0 commit comments

Comments
 (0)