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

updated rel descriptions, moved info to best practice #951

Merged
merged 2 commits into from
Feb 3, 2021

Conversation

cholmes
Copy link
Contributor

@cholmes cholmes commented Jan 26, 2021

Related Issue(s): #929

Proposed Changes:

  1. Refactored 'rel' information to move the common IANA stuff to best practices, and tweaked the language of the sections so they just talk about the custom stac stuff. Note the decision to leave catalog more minimal in its language was deliberate, since there I didn't see how any of the official IANA ones applied, but I'm open to tweaking it with mroe.

PR Checklist:

  • This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
  • This PR has no breaking changes.
  • a CHANGELOG entry is not required.

best-practices.md Outdated Show resolved Hide resolved
item-spec/item-spec.md Outdated Show resolved Hide resolved
@@ -133,11 +137,11 @@ The following types are commonly used as `rel` types in the Link Object of an It
| parent | URL to the parent STAC [Catalog](../catalog-spec/README.md) or [Collection](../collection-spec/README.md). |
| collection | STRONGLY RECOMMENDED. URL to a [Collection](../collection-spec/README.md). *Absolute* URLs should be used whenever possible. The referenced Collection is STRONGLY RECOMMENDED to implement the same STAC version as the Item. |
| derived_from | URL to a STAC Item that was used as input data in the creation of this Item. |
Copy link
Collaborator

@m-mohr m-mohr Jan 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we move the whole derived_from part also to best practices? I think it would make sense.

Copy link
Collaborator

@m-mohr m-mohr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Additional proposal: Move derived_from to best practices, too. It could actually make sense to also allow it for Collections and Catalogs anyway.

@cholmes
Copy link
Contributor Author

cholmes commented Jan 26, 2021

I went back and forth in my head on derived_from:

  • The best practices currently is just the official IANA rel's, and it seems weird to 'introduce' a custom rel only in the best practice.
  • Collection does list derived_from now. Catalog didn't make sense to me to have a derived_from, since it's just a structure for organization.

But I see the argument as to why it feels less mature than the others. I think in my ideal world it eventually drops away in favor of a real 'provenance' extension, that is based on some other 'real' provenance work, instead of us just making stuff up. But I do feel it's really important to emphasize in STAC, in the core specs, that marking where something has come from is essential.

So to me it's a case of not letting 'great' be the enemy of good, so I think overall I prefer it in the core spec, vs burying it in a new extension. I could potentially be convinced otherwise, but I don't think we should introduce new rels in a best practice.

@m-mohr
Copy link
Collaborator

m-mohr commented Jan 26, 2021

Good arguments, I'm convinced to leave it as it is for now. Thanks!

@cholmes
Copy link
Contributor Author

cholmes commented Jan 26, 2021

Cool, thanks for your review and bringing it up.

@cholmes cholmes added this to the 1.0.0-RC.1 milestone Jan 30, 2021
@matthewhanson matthewhanson merged commit 3dc71a6 into dev Feb 3, 2021
@matthewhanson matthewhanson deleted the rel-refactor branch February 3, 2021 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants