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

Relative -> absolute links for stac-spec references #115

Closed
wants to merge 2 commits into from

Conversation

duckontheweb
Copy link
Contributor

Related Issue(s): #
#114

Proposed Changes:

  1. Use absolute instead of relative links for all references to pages in the radiantearth/stac-spec repo.
    All URLs are pinned to v1.0.0-rc.1.

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.
  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

Pins these links to v1.0.0-rc.1 of the core spec
@matthewhanson
Copy link
Collaborator

@duckontheweb we've been linking to the master branch of the stac-spec from the extensions, rather than to the v1.0.0-rc.1 tag. It saves us from having to update the links (which once we get to 1.0.0 should be an uncommon occurrence), but there's also a risk that links could become broken.

For now, I think linking to master branch is probably best. thoughts @cholmes ?

@cholmes
Copy link
Collaborator

cholmes commented Mar 26, 2021

I'm definitely of two minds on this. I do think the rc.1 link is less good, because it's going to be rc.2 soon and then 1.0.0.

But I don't love going straight to master, since if stac spec were to go to 2.0 and then someone was looking at STAC API release 1.0.0 they'd follow a link there, which isn't really what STAC API is based on.

I think best may be to do 'master' for right now, but once STAC 1.0.0 is at then we could change it to link there...

@duckontheweb
Copy link
Contributor Author

Yeah, I'm a little back-and-forth on this, too. It's not hard to update the stac-spec version in these links, so pinning to a specific version seemed like an easy way to make sure they don't break. On the other hand, this version of the API spec doesn't really "depend" on the content of v1.0.0-rc.1 of stac-spec in any specific way that I can see, it only depends on the fact that files stay in the same place within that repo, so maybe pointing to master is fine and we just know that if we change the structure of that repo then we need to update these links as well.

@duckontheweb
Copy link
Contributor Author

@matthewhanson @cholmes I updated the links to point to master instead of 1.0.0-rc.1

@m-mohr
Copy link
Collaborator

m-mohr commented Apr 14, 2021

Why not just update the submodule?

@duckontheweb
Copy link
Contributor Author

@m-mohr See #114 for the reasoning behind this. Relative links to a submodule do not work correctly on GitHub since the directory doesn't actually exist in that location.

@cholmes
Copy link
Collaborator

cholmes commented May 4, 2021

@duckontheweb - are you able to update this PR so it uses a sub-tree? Or would that need to be a new PR? Or some other way to get that working?

@duckontheweb
Copy link
Contributor Author

I opened #119 and marked it as WIP until we confirmed that's the way we wanted to go.

@duckontheweb
Copy link
Contributor Author

Closed via #119

@philvarner philvarner deleted the fix-core-links branch September 27, 2023 15:23
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