OpenGeoMetadata / metadata-issues

Working space for metadata issues, development, and discussions
Apache License 2.0
2 stars 0 forks source link

Update documentation for Replaces and isReplacedBy #54

Open karenmajewicz opened 1 year ago

karenmajewicz commented 1 year ago

The metadata fields Replaces and isReplacedBy can indicate a relationship between two records A and B where:

For the purposes of GeoBlacklight, users only need to enter a value (ID of corresponding record) in the field Replaces in record B. This is because GeoBlacklight is set up to create widgets that display a two-way relationship that has only been declared on one record. (see the Data Relations documentation for more details)

For the purposes of OpenGeoMetadata, users should enter a value (ID of corresponding record) in both records. This is to ensure that the relationship is declared in the metadata regardless of how a discovery application functions.


Furthermore, we should note that is would be a Best Practice to also include a warning in the displayNote field to alert users to deprecated datasets.

rmseifried commented 1 year ago

We'll probably want to update the documentation on the new Relations Fields page as well.