Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for Replaces and isReplacedBy #54

Open
karenmajewicz opened this issue Jun 7, 2023 · 2 comments
Open

Update documentation for Replaces and isReplacedBy #54

karenmajewicz opened this issue Jun 7, 2023 · 2 comments

Comments

@karenmajewicz
Copy link
Collaborator

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

  • A= old data, deprecated but still available
  • B= new data, to be used instead of A

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
Copy link
Member

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

@karenmajewicz karenmajewicz moved this to To Do in OGM issues Jul 21, 2023
@karenmajewicz
Copy link
Collaborator Author

should GBL be updated to not show duplicated relationships?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To Do
Development

No branches or pull requests

2 participants