-
Notifications
You must be signed in to change notification settings - Fork 1
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
Update diagrams, top-level schema description and schema reference #212
Conversation
|
Remove empty objects and arrays, make background transparent, add sentence to explain how arrays are represented
Based on @matamadio's feedback in yesterday's call, I've removed empty objects and arrays from the diagrams and added an explanatory sentence to describe how arrays are represented. Here's how the changes look to the hazard diagram (since it is the most complex): Before After I considered adding an extra object to each array, but I think it makes the diagram too complicated: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, they read better now.
Just one perplexity on the word "subset". While formally correct, it can induce to think this is a small part of the whole hazard schema; rather, hazard attributes are a subset of the whole schema. But to be aligned with the rest of the docs, I would use "component" instead. Then for each diagram paragraph I would rephrase as:
The following diagram shows the key attributes of the [hazard] component, with required fields highlighted in blue.
Since @matamadio has approved, I'm going to bypass branch protections and merge this PR so that these changes are available on |
Related issues
Description
In addition to updating the diagrams per #178, this PR also:
docs/rdl/what.md
docs/reference/schema.md
You can preview the changes here: https://rdl-standard.readthedocs.io/en/178-diagrams/reference/schema/
Merge checklist
./manage.py
pre-commitIf you added or removed a field:
collapse
option of the jsonschema directives for dataset, resource, hazard, exposure, vulnerability and loss onreference/schema.md
Having trouble?
See how to resolve check failures.