updates related to bug fix and UI changes in datalad-catalog v1.1.1

datalad-handbook · Jan 17, 2024 · 8de15ab · 8de15ab
1 parent 3c94689
commit 8de15ab
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 41 deletions.
diff --git a/docs/artwork b/docs/artwork
diff --git a/docs/beyond_basics/101-182-catalog.rst b/docs/beyond_basics/101-182-catalog.rst
@@ -5,7 +5,7 @@ DataCat - a shiny front-end for your dataset
 
 .. importantnote:: Dependency note
 
-   This section depends on ``datalad-catalog`` version ``1.0.1`` or later.
+   This section depends on ``datalad-catalog`` version ``1.1.1`` or later.
 
 If you're looking for ways to showcase your datasets, look no further than the `datalad-catalog extension <https://docs.datalad.org/projects/catalog>`_.
 This extension takes your favorite datasets and metadata, and generates a static website from it.
@@ -456,14 +456,14 @@ to the end of the URL, and hit ENTER/RETURN. You should see something like this:
 
 .. figure:: ../artwork/src/catalog/catalog_step_dataset.png
 
-This is the dataset view, with the subdatasets tab (auto-)selected.
+This is the dataset view, with the content tab (auto-)selected.
 This view displays all the main content related to the dataset that was provided by the metadata,
 and allows the user further functionality like downloading the dataset with DataLad,
 downloading the metadata, filtering subdatasets by keyword, browsing files, and viewing extended
 attributes such as funding information related to the dataset. Below are two more views,
-the first with the files tab selected, and the second with the funding tab selected.
+the first with the subdatasets tab selected, and the second with the funding tab selected.
 
-.. figure:: ../artwork/src/catalog/catalog_step_files.png
+.. figure:: ../artwork/src/catalog/catalog_step_subdatasets.png
 
 .. figure:: ../artwork/src/catalog/catalog_step_funding.png
 

diff --git a/docs/beyond_basics/_examples/DL-101-182-103 b/docs/beyond_basics/_examples/DL-101-182-103
@@ -1,11 +1,11 @@
 $ tree -L 1 data-cat
 data-cat
+├── README.md
 ├── artwork
 ├── assets
 ├── config.json
 ├── index.html
 ├── metadata
-├── README.md
 ├── schema
 └── templates
 

diff --git a/docs/beyond_basics/_examples/DL-101-182-105 b/docs/beyond_basics/_examples/DL-101-182-105
@@ -1,4 +1,4 @@
 $ datalad catalog-validate --metadata toy_metadata.jsonl
-catalog_validate(ok): /home/me/catalog
-catalog_validate(ok): /home/me/catalog
-catalog_validate(ok): /home/me/catalog
+catalog_validate(ok): /private/tmp/me/catalog
+catalog_validate(ok): /private/tmp/me/catalog
+catalog_validate(ok): /private/tmp/me/catalog
diff --git a/docs/beyond_basics/_examples/DL-101-182-108 b/docs/beyond_basics/_examples/DL-101-182-108
@@ -36,9 +36,15 @@ $ cat data-cat/metadata/5df8eb3a-95c5-11ea-b4b9-a0369f287950/dae38cf901995aace0d
   ],
   "metadata_sources": {
     "key_source_map": {
+      "name": [
+        "stephan_manual"
+      ],
       "short_name": [
         "stephan_manual"
       ],
+      "description": [
+        "stephan_manual"
+      ],
       "url": [
         "stephan_manual"
       ],
@@ -66,9 +72,9 @@ $ cat data-cat/metadata/5df8eb3a-95c5-11ea-b4b9-a0369f287950/dae38cf901995aace0d
       }
     ]
   },
-  "name": null,
+  "name": "My toy dataset",
   "short_name": "My toy dataset",
-  "description": null,
+  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus nec justo tellus. Nunc sagittis eleifend magna, eu blandit arcu tincidunt eu. Mauris pharetra justo nec volutpat euismod. Curabitur bibendum vitae nunc a pharetra. Donec non rhoncus risus, ac consequat purus. Pellentesque ultricies ut enim non luctus. Sed viverra dolor enim, sed blandit lorem interdum sit amet. Aenean tincidunt et dolor sit amet tincidunt. Vivamus in sollicitudin ligula. Curabitur volutpat sapien erat, eget consectetur mauris dapibus a. Phasellus fringilla justo ligula, et fringilla tortor ullamcorper id. Praesent tristique lacus purus, eu convallis quam vestibulum eget. Donec ullamcorper mi neque, vel tincidunt augue porttitor vel.",
   "url": "https://github.com/jsheunis/multi-echo-super",
   "license": {
     "name": "CC BY 4.0",

diff --git a/docs/beyond_basics/_examples/DL-101-182-111 b/docs/beyond_basics/_examples/DL-101-182-111
@@ -8,43 +8,24 @@ $ cat data-cat/config.json | jq .
     "about": null,
     "documentation": "https://docs.datalad.org/projects/catalog/en/latest/",
     "github": "https://github.com/datalad/datalad-catalog",
-    "twitter": "https://twitter.com/datalad"
+    "mastodon": "https://fosstodon.org/@datalad",
+    "x": "https://x.com/datalad"
   },
   "dataset_options": {
     "include_metadata_export": true
   },
   "property_sources": {
     "dataset": {
-      "dataset_id": {
-        "rule": "single",
-        "source": "metalad_core"
-      },
-      "dataset_version": {
-        "rule": "single",
-        "source": "metalad_core"
-      },
-      "type": {
-        "rule": "single",
-        "source": "metalad_core"
-      },
+      "dataset_id": {},
+      "dataset_version": {},
+      "type": {},
       "children": {
         "rule": "merge",
         "source": "any"
       },
-      "name": {
-        "rule": "single",
-        "source": "metalad_studyminimeta"
-      },
+      "name": {},
       "short_name": {},
-      "description": {
-        "rule": "priority",
-        "source": [
-          "catalog_readme",
-          "metalad_studyminimeta",
-          "datacite_gin",
-          "bids_dataset"
-        ]
-      },
+      "description": {},
       "doi": {},
       "url": {
         "rule": "merge",

diff --git a/docs/beyond_basics/_examples/DL-101-182-114 b/docs/beyond_basics/_examples/DL-101-182-114
@@ -4,7 +4,4 @@ catalog_create(ok): custom-cat [Catalog successfully created at: custom-cat]
 catalog_add(ok): custom-cat [Metadata record successfully added to catalog (dataset: dataset_id=5df8eb3a-95c5-11ea-b4b9-a0369f287950, dataset_version=dae38cf9✂SHA1)]
 catalog_add(ok): custom-cat [Metadata record successfully updated in catalog (filetree of dataset: dataset_id=5df8eb3a-95c5-11ea-b4b9-a0369f287950, dataset_version=dae38cf9✂SHA1)]
 catalog_add(ok): custom-cat [Metadata record successfully updated in catalog (filetree of dataset: dataset_id=5df8eb3a-95c5-11ea-b4b9-a0369f287950, dataset_version=dae38cf9✂SHA1)]
-catalog_add(ok): custom-cat [Metadata record successfully added to catalog (dataset: dataset_id=5df8eb3a-95c5-11ea-b4b9-a0369f287950, dataset_version=dae38cf9✂SHA1)]
-catalog_add(ok): custom-cat [Metadata record successfully updated in catalog (filetree of dataset: dataset_id=5df8eb3a-95c5-11ea-b4b9-a0369f287950, dataset_version=dae38cf9✂SHA1)]
-catalog_add(ok): custom-cat [Metadata record successfully updated in catalog (filetree of dataset: dataset_id=5df8eb3a-95c5-11ea-b4b9-a0369f287950, dataset_version=dae38cf9✂SHA1)]
 catalog_set(ok): custom-cat [Home page successfully set to: dataset_id=5df8eb3a-95c5-11ea-b4b9-a0369f287950, dataset_version=dae38cf9✂SHA1.]
diff --git a/requirements-devel.txt b/requirements-devel.txt
@@ -8,4 +8,4 @@ scikit-image
 # https://github.com/mwaskom/seaborn/issues/3192
 numpy < 1.24
 dvc >= 3.0
-datalad-catalog >= 1.0.1
+datalad-catalog >= 1.1.1
+ −		src/catalog/catalog_step_404.png
+ −		src/catalog/catalog_step_config.png
+ −		src/catalog/catalog_step_dataset.png
+ −		src/catalog/catalog_step_files.png
+ −		src/catalog/catalog_step_funding.png
+ −		src/catalog/catalog_step_subdatasets.png