Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing in documentation #400

Open
boranin opened this issue Jan 23, 2024 · 1 comment
Open

Missing in documentation #400

boranin opened this issue Jan 23, 2024 · 1 comment

Comments

@boranin
Copy link

boranin commented Jan 23, 2024

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.

@wardi
Copy link
Contributor

wardi commented Jan 23, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants