-
Notifications
You must be signed in to change notification settings - Fork 183
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
Clarify Distinction Between OSCAL Data Types token
and NCName
in Website
#1105
Comments
This work requires usnistgov/metaschema#191, which won't be ready until OSCAL 1.1. Moving the milestone accordingly. |
This is partially addressed by PR #1161. |
The documentation still needs to be updated to differentiate the syntactical differences. |
This was reviewed and completed in the previous sprint, but not merged despite approval. This is a useful but low-risk documentation improvement into |
User Story:
As an OSCAL tool developer, in order to best understand the requirements and constraints for given data types in OSCAL, I would like more clarification in docs around the difference between the
token
andNCName
data types in the OSCAL website documentation.Goals:
It should be more clear how the datatypes work, specifically how they are different, as both data types have the exact same.
The OSCAL datatypes page is a bit outdated and needs some maintenance. The following additional work needs to be done.
empty
should be removed as a datatype.[ ]Did not remove since old docs reference it.NCName
should be removed as a datatype.- [ ] Need to add any missing data typesBackground
This came up during the review of #941, particularly in #941 (comment), as it references part of the data types page and the two data types have identical information, without much clarity. This was rolled out as part of #911, but the docs are still not clear around the whitespace enforcement.
Dependencies:
N/A
Acceptance Criteria
The text was updated successfully, but these errors were encountered: