Skip to content

Commit 6e42e1a

Browse files
committed
fix typos
1 parent 8099fed commit 6e42e1a

2 files changed

Lines changed: 17 additions & 17 deletions

File tree

docs/upgrade-metadata.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Upgrade Guide for converting Metadata from GBL 1.0 to OGM Aardvark
22

33

4-
The following options are three ways to upgrade GBL 1.0 metadata into OGM Aardvark. The figures include references to Solr, the search index that powers a GeoBlacklight instance.
4+
The following options are two ways to upgrade GBL 1.0 metadata into OGM Aardvark. The figures include references to Solr, the search index that powers a GeoBlacklight instance.
55

66
## Option 1: New pipeline
77

@@ -20,14 +20,14 @@ Fig.1 - Metadata pipeline showing a conversion from standards metadata
2020

2121
This option involves updating your local transformation workflow that extracts values from standards-based metadata files.
2222

23-
* For institutions that utilize an XSLT for the transformation, [GeoCombine repository has XSL files](https://github.com/OpenGeoMetadata/GeoCombine/tree/main/lib/xslt).
23+
* For institutions that utilize an XSLT for the transformation, the [GeoCombine repository has XSL files](https://github.com/OpenGeoMetadata/GeoCombine/tree/main/lib/xslt).
2424

25-
* For institutions that use custom tools or Python scripts, refer to the OGM Aardvark - FGDC- ISO 19139 crosswalk document to update the code. It shows crosswalks between OGM Aardvark, GBL 1.0, FGDC, and ISO.
25+
* For institutions that use custom tools or Python scripts, refer to the [OGM Aardvark - FGDC- ISO 19139 crosswalk](aardvark-fgdc-iso-crosswalk.md) to update the code.
2626

2727
### Considerations for Option #1
2828

29-
* may require extra institutional support, particularly if the transformation process is part of a larger framework or connected to a repository.
30-
* community-developed XSLs are still a work in progress
29+
* This may require extra institutional support, particularly if the transformation process is part of a larger framework or connected to a repository.
30+
* The community-developed XSLs are still a work in progress.
3131

3232

3333

@@ -41,14 +41,14 @@ Programmatically convert the JSON files
4141
Fig.2 - Programmatic transformation process using Geoblacklight 1.0 Metadata JSONs
4242

4343

44-
### Scenario
44+
### Scenarios
4545
* you only have GBL 1.0 metadata (no structured metadata files in an official standard)
4646
* you want to test your environment with the new Aardvark schema
4747

4848
### How does it work?
4949

5050
1. Gather GBL 1.0 metadata JSON files on your desktop
51-
2. Use a script or tool to convert the files batch convert GBL 1.0 JSON files to OGM Aardvark
51+
2. Use a script or tool to batch convert GBL 1.0 JSON files to OGM Aardvark
5252
3. Re-index the resulting Aardvark JSON files into your application (GeoBlacklight)
5353

5454
Currently, the OpenGeoMetadata community has two tools that can do batch conversions:
@@ -57,22 +57,22 @@ Currently, the OpenGeoMetadata community has two tools that can do batch convers
5757
* [gbl2aardvark](https://kgjenkins.github.io/gbl2aardvark/): A web-hosted interface (recommended tool).
5858

5959
* Users can upload GBL 1.0 metadata files to this tool and it will return a downloadable JSON in the OGM Aardvark schema.
60-
* In addition to direct crosswalks, this tool will also populate the `Resource Class` and `Resource Type` based upon the `Type` and `Geometry Type` fields from version 1.0. It will also generate new collection level records based upon the value in the Is Part Of fields.
60+
* In addition to direct crosswalks, this tool will populate the `Resource Class` and `Resource Type` based upon the `Type` and `Geometry Type` fields from version 1.0. It will also generate new collection level records based upon the value in the Is Part Of fields.
6161
* Any fields that do not properly convert will be flagged with the phrase "EDIT ME --"
6262
* When reindexing Solr with a single JSON file representing multiple records, use Solr's "Document Type"="File Upload" option.
6363
* [See the GitHub documentation for more information](https://github.com/kgjenkins/gbl2aardvark)
6464

6565
* a standalone Python script: [https://github.com/OpenGeoMetadata/gbl-1_to_aardvark](https://github.com/OpenGeoMetadata/gbl-1_to_aardvark).
66-
* This command line script will perform a straight conversion of field names.
67-
* It features an editable crosswalk file to customize the transformation.
68-
* The non-crosswalkable elements listed above (Type, Geometry Type, and Is Part Of) do not have direct crosswalks and will be copied as is into the new Aardvark JSONs.
66+
* This command line script will perform a straight conversion of field names.
67+
* It features an editable crosswalk file to customize the transformation.
68+
* The non-crosswalkable elements listed above (Type, Geometry Type, and Is Part Of) will be copied as-is into the new Aardvark JSONs.
6969

70-
### Manually remediate tranformated JSONs
70+
### Recommended: manually remediate transformed JSONs
7171

7272
![manual-remediation](images/transform-option3.png)
7373
Fig.3 - Transformation process that includes manual remediation
7474

75-
You may need to perform additional cleanup on the tranformed JSONs. This technique combines automatic conversions and manual edits:
75+
You may need to perform additional manual cleanup on the transformed JSONs.
7676

7777
1. Convert your metadata files to a CSV. [This Python script will convert a batch of JSONs to a CSV file](https://github.com/geobtaa/workflows/blob/main/editing/json2csv.py)
7878

@@ -83,8 +83,8 @@ You may need to perform additional cleanup on the tranformed JSONs. This techni
8383

8484
### Considerations for Option #2
8585

86-
* a workaround method if changing the metadata pipeline is not feasible. However, is not a long-term solution and may result in incomplete metadata.
86+
* This can be a workaround method if changing the metadata pipeline is not feasible. However, it may result in incomplete metadata.
8787

88-
* will not include some fields that are new in OGM Aardvark, such as Rights or License. To take advantage of those fields, use Option 1 or perform additional remediation.
88+
* It will not include some fields that are new in OGM Aardvark, such as Rights or License. To take advantage of those fields, use Option 1 or perform additional remediation.
8989

90-
* manual cleanup after transformation may be labor intensive
90+
* Manual cleanup after transformation may be labor intensive.

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ nav:
7878
- 'Aardvark to FGDC and ISO': 'aardvark-fgdc-iso-crosswalk.md'
7979
- 'GBL 1.0 to FGDC and ISO': 'gbl1-fgdc-iso-crosswalk.md'
8080

81-
- Syntax & Controlled Values:
81+
- Syntax:
8282
- 'Reference URIs': 'reference-uris.md'
8383
- 'Solr Field Suffixes': 'solr-field-suffixes.md'
8484
- 'Custom Fields': 'custom-fields.md'

0 commit comments

Comments
 (0)