Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Case: Allow the use of variant file names for manifest/catalog/index/readme #12

Closed
ptsefton opened this issue Apr 16, 2019 · 5 comments
Labels
use-case A (potential) use-case for ROLite creation, consumption or integration

Comments

@ptsefton
Copy link
Contributor

As a data manager, I want to be able to choose what I call the manifest JSON-LD and the root HTML page so that I can make datasets that appeal to my community and avoid name-collisions with existing files - eg use index.html for most datasets but allow for a variant where the payload is a website containing index.html files.

Implementation note: The manifest/catalog file and HTML root can be specified in a "magic" DataCrate or RO-Crate.json file.

@ptsefton ptsefton added the use-case A (potential) use-case for ROLite creation, consumption or integration label Apr 16, 2019
@eocarragain
Copy link
Contributor

Presumably this will depend on whether we decide on:

  • having manifest and other metadata directly mixed in with the payload, e.g. a "Working DataCrate" in the data crate spec, or like Frictionless data where datapackage.json is in the root folder alongside payload files, or like a simple README file in a git repo
  • having a wrapper/container folder with a designated payload folder, e.g. like "Bagged DataCrate" in the data crate spec, or just plan old Bagit
  • defining different states for RO-Lite/RO-Crate objects as you have done in data crate, i.e. "Working DataCrate" vs "Bagged DataCrate"

I think the latter makes sense, but we need to make a decision on that. I'll open a new ticket

@ptsefton
Copy link
Contributor Author

I think we should explore a variant of the last point with a view to supporting as many of the common packaging, transport or storage standards as we can.

@eocarragain
Copy link
Contributor

@ptsefton agree we should aim for this.

@eocarragain
Copy link
Contributor

Will variant/configurable names files make shared bagit-profiles less useful? Or is the idea that some normalisation of names happens during the "Bagging" process?

@ptsefton
Copy link
Contributor Author

Closing this - we decided against it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
use-case A (potential) use-case for ROLite creation, consumption or integration
Projects
None yet
Development

No branches or pull requests

2 participants