search

CLARIAH / clariah-plus

This is the project planning repository for the CLARIAH-PLUS project. It groups all technical documents and discussions pertaining to CLARIAH-PLUS in a central place and should facilitate findability, transparency and project planning, for the project as a whole.
9 stars 6 forks source link

Initial work on formulating software metadata requirements and instructions #95

Closed proycon closed 2 years ago

proycon commented 2 years ago

This is an initial attempt to formulate software metadata requirements and instructions (#40). There's still a lot of TODOs pointing to ongoing discussions but I hope this clarifies the direction we're heading in and allows others to comment on it and provide the opportunity to steer in another direction where needed.

Direct link to the full text for ease of access: https://github.com/CLARIAH/clariah-plus/blob/software-metadata-requirements/requirements/software-metadata-requirements.md

proycon commented 2 years ago

As a general observation, this still reads too much as a description of the status quo and its components (harvester etc.). Let’s make this document more to the point and focused on the question: how can developers publish their software metadata to the CLARIAH tool registry?

That's a good point yeah, I'll rewrite some parts to have a clearer focus and document the pipeline itself elsewhere and link to it.

proycon commented 2 years ago

I reworked this document now to hopefully be more focused and to the point, it's closer to the other requirement documents now and uses the same RFC2119 language. I also filled more details as work is progressing.

proycon commented 2 years ago

If there are no objections, I'd like to merge what we have thus-far into the main branch, we can then continue from there in further incremental issues/PRs.