Replace Information Model section with Best Practices section - closes #10 #267
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benfrancis
requested review from
chachamimm,
mlagally,
mmccool,
mryuichi and
sebastiankb
benfrancis
force-pushed
the
best-practices
branch
from
98aae42 to
84fd2ac
Compare
mlagally
requested changes
Aug 31, 2022
There was a problem hiding this comment.
I like the proposal of having a section under the "Common Constraints" section, which provides additional normative requirements.
However the current assertions are only recommended, which leaves it up to implementors what to do. This contradicts the OOTBI goals of the profile.
I suggest to make them mandatory and refine them to rule out these ambiguities.
Additionally, the current proposal reverts more precise language and requirements, that were introduced after long discussions in the WG. We should ensure that these agreements are preserved.
Examples include:
- Additional clarifications on date-time formats
- Additional clarifications on units
- Additional clarifications on
supportfield
benfrancis
force-pushed
the
best-practices
branch
from
84fd2ac to
df94505
Compare
Merged
|
This PR is no longer needed since #272 landed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a follow-up to #260 which attempts to resolve the long-running issue #10 regarding the extent to which profiles constrain the Thing Description Information model, and is a replacement for PR #125.
The work so far in #260 includes many of the constraints from the original Core Data Model section in six sub-sections of a new Common Constraints section:
My proposal in this PR is to replace the content of the remaining Information Model section (what's left from the original "Core Data Model" section) with a Best Practices section which includes some of the key remaining constraints as recommendations.
The content of the current Information Model section is still very contentious and we are running out of time to agree on which constraints to keep. This proposal is a compromise which retains some of the key constraints from that section as recommendations which I think we can get quick consensus on.
I have explained the rationale behind the removal of other more rigid constraints in great detail in other issues and PRs, but I'm happy to answer any questions about constraints that others feel should be kept.
Preview | Diff