ckanext-scheming icon indicating copy to clipboard operation
ckanext-scheming copied to clipboard

Missing in documentation

Open boranin opened this issue 1 year ago • 1 comments

In my view, answers to the following would enhance the documentation:

-Why is the dataset schema given in .yaml and the group and organisation schemas as JSONs? Can they all be either? -What is the create_validators attribute used for? Examples of usage would be of help too. -field_name - "Existing dataset field names include [...]" - Are these fields defined in the ckan_dataset.yaml file? There are more fields defined in that file than on the [...] list, should they be on the list in the Readme file? -Can the presets be used for all, datasets, groups and organisation fields or are they specific to datasets only? -Is the attribute "label" in the "repeating_subfields" key the same as Key label "label" (can have international translations)? -Is repeating_label in the in the "repeating_subfields" key the same as Key label "label" (can have international translations)?

It might be that all this has been answered somewhere, but I didn't see that even after re-reading the Readme several times.

boranin avatar Jan 23 '24 00:01 boranin

@boranin thanks! these are good suggestions for improvements to the docs.

wardi avatar Jan 23 '24 15:01 wardi