zazuko / build-your-vocabularies

A template which lets you build a custom package like @zazuko/rdf-vocabularies
MIT License
1 stars 0 forks source link

Documentation: omissions and dead link #2

Open Zack-83 opened 2 years ago

Zack-83 commented 2 years ago

Dear Sirs & Madams,

thank you for offering this service, which we would like to use to make our own ontology https://github.com/zazuko/rdf-vocabularies/issues/126 visible.

Some minor doubts about your documentation:

Regards, Giacomo Lanza and the group "Metadata4Ing"

tpluscode commented 2 years ago

Hello @Zack-83. Thank you for you message. It typically is one or the other. Either we'd add your requested vocabulary to @zazukoo/rdf-vocabularies, or you can create your own package by using this template repo to bootstrap.

At this point, I think we focus on more mainstream vocabularies for the main package. Thus, I encourage you to use this repo template and publish a package yourself.

I updated the readme mention of src/vocabulary. The link is dead because it was meant to point to a folder which does not exist in master branch. It was more of a suggestion. Do see the example branch or our auxiliary package for a complete setup. The latter also includes versioning/deployment automation

Sources can be in any Common RDF format. If a namespace dereferences to RDF, then it should work out of the box without tweaks. Otherwise, do referer to the build/overrides.ts file to see what can be done if a vocab is not published correctly.

Finally, I added a mention in readme that updates need to be handled by package authors.