data-catalog/catalog

The Catalog

This is a browsable data catalog generated from metadata using datalad-catalog. It is a self-contained and static VueJS-based site that can be viewed in any modern internet browser.

Content

The content of this root directory includes everything necessary to serve the static site:

.
├── artwork
├── assets
├── config.json
├── index.html
├── metadata
└── README.md

The artwork and assets directories contain images and web assets (such as JavaScript and CSS files) respectively that support the rendering of the HTML components in index.html. The config.json file contains customizable configuration options supplied to datalad-catalog.

Serving the content

Since this site is self-contained and static, no further build processes or access to content delivery networks (CDNs) are necessary in order to serve the content. All that is needed is a simple HTTP server with one specific addition - a custom redirect. This is required because the application makes use of Vue Router's history mode, which requires a server-side redirect configuration to deal with the fact that a VueJS application is actually a single-page app.

For serving the content locally, this is already taken care of in datalad-catalog, and you can simply run the following:

cd path/to/catalog/directory
datalad catalog-serve -c .

The content can also be hosted and served online. A straightforward way to achieve this, and one which has a free tier, is via Netlify (the common alternative, GitHub Pages, does not currently support server-side redirects). After publishing this content, e.g. as a GitHub repository, you can link that repository to a site on Netlify. See here how to set up redirects with Netlify. Of course, the site can also be served from your preferred server setup, as long as page redirects can be supported.

Maintaining content

Metadata entries can be updated, added to, and removed from the catalog in a decentralized and collaborative manner. Please refer to the datalad-catalog documentation for detailed instructions.

Feedback, issues and contributions

Please log any feedback or problems you encounter with regards to the functioning of the catalog as an issue on the datalad-catalog repository. For missing or unexpected metadata content, please contact the maintainer of this catalog.

Contributions to this open source project are welcome! Please refer to the contributor guidelines for more information.