search

glossarist / glossarist-ruby

Concept modeller in Ruby
BSD 2-Clause "Simplified" License
1 stars 1 forks source link

Add documentation on how to create a Glossarist dataset #83

Closed ronaldtse closed 10 months ago

ronaldtse commented 10 months ago

What are the key files of a Glossarist dataset? The description YAML, concept YAML files... etc.

HassanAkbar commented 10 months ago

@ronaldtse we need 2 folders for creating a concept dataset (both folder names are singular)

  1. concept
  2. localized_concept

Currently there is no documentation for Glossarist Model V2 so I've followed what was done in isotc211-glosary and Typescript definitions concept.ts and item.ts. For Glossarist We don't need all the folders here only the 2 mentioned above and also we only need the data key and not the registers data for the concepts and localized_concepts.

I'm working on adding complete documentations for what is currently implemented in Glossarist and I'll open a PR for that once done.

ronaldtse commented 10 months ago

@HassanAkbar in the termium gem when I export from glossarist, in the Cli class “convert” method, the generated dataset only had a flat directory with concepts as YAML files. What’s wrong with it?

Do you have to update the glossarist gem to export in the new structure with 2 directories?

HassanAkbar commented 10 months ago

@ronaldtse I believe the issue has been fixed in https://github.com/glossarist/glossarist-ruby/issues/84.

I will add the documentation for this in a PR for this issue -> https://github.com/glossarist/glossarist-ruby/issues/81

HassanAkbar commented 10 months ago

Documentation was added in this PR -> https://github.com/glossarist/glossarist-ruby/pull/90