search

SlideRuleEarth / sliderule

Server and client framework for on-demand science data processing in the cloud
https://slideruleearth.io
Other
26 stars 11 forks source link

Broken links to `polygons` and `geojson`, and `toregion` #342

Open rhugonnet opened 9 months ago

rhugonnet commented 9 months ago

For polygons and geojson, on this page: https://slideruleearth.io/web/rtd/user_guide/ICESat-2.html#photon-input-parameters I'm not sure what was the intention? I could not find any other specific info on polygons/geojson elsewhere, but it'd indeed be a great resource to have a single place describing this! :slightly_smiling_face: A lot of function mention "formats supported by SlideRule", having the same link in each would help a lot point the user to that list of formats.

For toregion: the link here: https://slideruleearth.io/web/rtd/getting_started/Getting-Started.html?highlight=geojson#common-api-calls is pointing to the ICESat-2 API instead of SlideRule API, so doesn't bring to the actual function. Need to be updated!

jpswinski commented 9 months ago

@rhugonnet Thanks for catching these broken links. I made the fixes in the commit referenced above, and I've rebuilt and redeployed the website. The links to polygons and geojson now point to the correct page (they are sections embedded in the SlideRule user guide page, which makes it hard to find if you don't know where it is). The link to toregion is now also fixed along with a few others in that same table that had not been updated when the old functions were deprecated.

As for places where the documentation says "formats supported by SlideRule", can you specify where you are seeing that? I wasn't able to find that phrase in our documentation, though there are a couple of places that we reference datasets supported by SlideRule. Is that what you are referring to?

rhugonnet commented 9 months ago

Thanks @jpswinski! I'll strive to open PRs to make it quicker for you in the future, here I wasn't sure where those links were supposed to go! (I hadn't found the section Core/Parameters"!) :sweat_smile:

For the wording "formats supported by SlideRule", it was actually only a couple occurences (not sure anything needs to be changed):

I'll keep taking notes if I catch anything as I navigate through the documentation. And then maybe the most efficient way would be to go through all of those together at once, to streamline some sections of the Docs if need be!

jpswinski commented 9 months ago

I made a first cut at updating the documentation to make the region format discussion clearer. It isn't deployed to the website yet, but the changes are captured in this commit: 93035cc2

Hopefully this helps, but I can see how it is confusing, and welcome any suggestions.