search

GeoscienceAustralia / dea-notebooks

Repository for Digital Earth Australia Jupyter Notebooks: tools and workflows for geospatial analysis with Open Data Cube and Xarray
https://docs.dea.ga.gov.au/notebooks/
Apache License 2.0
433 stars 127 forks source link

Fixing broken images on Knowledge Hub Noteboks Readme #1197

Closed benji-glitsos-ga closed 4 months ago

benji-glitsos-ga commented 4 months ago

Proposed changes

Affected page: https://docs.dea.ga.gov.au/notebooks/README/

Using absolute github links for readme images to fix broken images on KH.

robbibt commented 4 months ago

Hey @benji-glitsos-ga, happy with this if you think absolute links are necessary - do you know though why other pages like this work fine with relative links in Knowledge Hub? https://github.com/GeoscienceAustralia/dea-notebooks/blob/f79e18063d8937dae4a76232cd659baa18251c77/Beginners_guide/02_DEA.ipynb#L169 https://docs.dea.ga.gov.au/notebooks/Beginners_guide/02_DEA.html#Surface-reflectance

robbibt commented 4 months ago

And should we point to stable, not develop?

benji-glitsos-ga commented 4 months ago

@robbibt The reason this is necessary is a finicky difference with how the Knowledge Hub handles the Readme's URL meaning that a relative path points to a slightly different location on the Readme than it does on the Sandbox. This is what caused the relative paths on the Knowledge Hub's Readme to break.

Absolute links are not ideal, but it is only temporary until I eventually replace this Knowledge Hub Notebooks page with a proper cover page.

This PR will need to be merged into stable. Im not sure -- it may be better to merge into develop first then merge into stable?

robbibt commented 4 months ago

@robbibt The reason this is necessary is a finicky difference with how the Knowledge Hub handles the Readme's URL meaning that a relative path points to a slightly different location on the Readme than it does on the Sandbox. This is what caused the relative paths on the Knowledge Hub's Readme to break.

Absolute links are not ideal, but it is only temporary until I eventually replace this Knowledge Hub Notebooks page with a proper cover page.

This PR will need to be merged into stable. Im not sure -- it may be better to merge into develop first then merge into stable?

Ah, makes sense!

And re my comment above, I just meant use an absolute URL pointing to the stable branch, not develop like it currently is: https://github.com/GeoscienceAustralia/dea-notebooks/pull/1197/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R1