Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
hrodmn
left a comment
There was a problem hiding this comment.
@abarciauskas-bgse thanks so much for the docs reorganization effort. I like the new structure! The main issue I see now is just that the notebooks that use the datacube_benchmark python package are not able to render properly because the package could not be imported when mkdocs rendered the site. I haven't dug in to see what is going on there - hopefully there is a simple fix!
There was a problem hiding this comment.
I think we should remove this file and make sure all of these dependencies are present in the docs group in the project-level pyproject.toml. That way everything would be ready to run when we run uv run --group docs mkdocs ...
There was a problem hiding this comment.
I think it makes sense to leave it in as datacube_benchmark can then be installed as a standalone package, but let me know if you see it differently
| - api/sel_parameter_example.ipynb | ||
| - Benchmarking: | ||
| - benchmarking/tiles.ipynb | ||
| - benchmarking/hls_tiling.ipynb |
There was a problem hiding this comment.
I don't think the HLS notebook really belongs under the 'benchmarking' header. Maybe we could just rename Benchmarking to Advanced so interested readers can open it to find more without declaring an overall theme.
| - api/time_series_example.ipynb | ||
| - api/time_series_api_limits.ipynb |
There was a problem hiding this comment.
Not blocking but we could just add the time series api limits notebook contents to the the main time series notebook. I'm not sure it needs to be a separate page.
There was a problem hiding this comment.
I think they make sense as separate notebooks, since the limits notebook has explicit limits described
There was a problem hiding this comment.
the notebooks that use the datacube_benchmark python package are failing to render because it can't import the package :/
|
@hrodmn thanks for your review! I think I have addressed your comments, let me know what you think 🙏🏽 |
|
@abarciauskas-bgse I think the changes all look good but the rendered docs site is exposing some problems in the new production deployment so I think we should switch the notebooks back to using the staging endpoint for now. |
This PR restructures the documentation both to group notebooks under similar headings and to incorporate some of the notebooks that were previously in the Datacube Guide, but were about TiTiler-CMR.
The new structure (and some revised content) can be reviewed here: https://developmentseed.org/titiler-cmr/feat-reorg-documentation/
For future work (I can make these tickets if you agree @hrodmn )
Todo: