skohub-io / skohub.io

https://skohub.io
3 stars 1 forks source link

Collect and structure documentation & publish via skohub.io #19

Open acka47 opened 2 years ago

acka47 commented 2 years ago

I think we should collect and structure the existing documentation starting with SkoHub Vocabs and publish it via this repo. We shpuld discuss also using Gatsby for this. We can discuss in this issue how to got forward.

acka47 commented 2 years ago

From https://github.com/skohub-io/skohub-vocabs/issues/56#issuecomment-918919843:

It should be documented somewhere that the order is not sorted by alphanumerical value or by notation but in the order as stated in the skos:hasTopConcept and skos:narrower-fields of the tutle-file.

acka47 commented 6 months ago

@sroertgen and me today collected some ideas in a meeting, see https://pad.lobid.org/skohub-webseite?both

Re. documentation this is:

  • Dedicated repo for HowTos/Tutorials
  • How to publish my SKOS vocabulary
  • with GitHub pages
  • on my own server
  • How to set up a reconciliation API
  • skohub.io demo
  • set up your own SKOS reconciliation service
  • How to configure validation based on shape (https://github.com/dini-ag-kim/hochschulfaechersystematik/issues/29)
  • Dedicated SkoHub workshop repo
acka47 commented 6 months ago

We should document how to use <#> as namespace in the turtle file and config the namespace by using the config option, see https://github.com/skohub-io/skohub-vocabs/issues/26.

acka47 commented 6 months ago

As discussed in https://github.com/skohub-io/skohub-docker-vocabs/issues/17, we should add a walkthrough for publishing a SKOS vocab with the "serverless" solution, using the "Usage" paragraph at https://github.com/skohub-io/skohub-docker-vocabs?tab=readme-ov-file#usage plus some screenshots.

acka47 commented 6 months ago

Another thing: We should document how to implement a lookup to a SkoHub vocab in a web form using some JavaScript.

acka47 commented 5 months ago

Another thing we discussed today while preparing for KIM WS: A short documentation how to add a lookup to the webform with JavaScript and fetching the FlexSearch index would be nice.