search

datalad-handbook / book

Sources for the DataLad handbook
http://handbook.datalad.org
Other
139 stars 56 forks source link

DataCat Tutorial does not work as expected #1210

Closed tmheunis closed 5 months ago

tmheunis commented 6 months ago

This could be related to the upgrade to datalad-catalog 1.1.0.

I detailed my steps here: https://github.com/datalad/datalad-catalog/issues/410

welcome[bot] commented 6 months ago

Welcome Banner (Image: CC-BY license, The Turing Way Community, & Scriberia. Zenodo. https://doi.org/10.5281/zenodo.3332808) Hi there, and welcome to the DataLad Handbook! :orange_book: :wave: Thank you for filing an issue. We're excited to have your input and welcome your idea! :blush: If you haven't done so already, please make sure you check out our Code of Conduct.

adswa commented 6 months ago

Thanks for the issue! The last time this tutorial was updated was in autumn in #1023, which adjusted the tutorial to work with "1.0.1 or later". If I read your issue right, its not commands breaking per se, but output being not identical to what is expected/demonstrated, and in some cases looking like unintended errors. I scanned the Changelog of the catalog, and at least with a cursory read did not find an indication that command line usage has changed. So my gut instinct says that those may not be things that can be corrected in the walk-through. @jsheunis, could you help assess whether the reported problems are catalog-issues, or whether there are documented usage patterns in the walk-through that need to be corrected for 1.1?

adswa commented 6 months ago

hey @all-contributors please add @tmheunis for bug, userTesting

allcontributors[bot] commented 6 months ago

@adswa

I've put up a pull request to add @tmheunis! :tada:

jsheunis commented 6 months ago

Thanks for the tag! will look into the issue.

jsheunis commented 6 months ago

Some remarks: https://github.com/datalad/datalad-catalog/issues/410#issuecomment-1894016378

Looks like there are bugs in 1.1.0, although I'm not sure yet whether they were introduced then or were in 1.0.1 all along. I will work on fixes.

W.r.t. the handbook chapter:

Lastly, I think it would be a good idea to rerun the tutorial once the fixes are applied and capture screenshots of the output and update the handbook chapter with those. There have been catalog UI changes since that are not reflected in the current handbook chapter version.

jsheunis commented 6 months ago

This PR fixes the main bug and a few related things: https://github.com/datalad/datalad-catalog/pull/413

Next step will be to create a patch release for datalad-catalog and then redo and update the handbook chapter.