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

Clarify Distinction Between OSCAL Data Types token and NCName in Website #1105

Closed
5 tasks done
aj-stein-nist opened this issue Jan 25, 2022 · 4 comments · Fixed by #1480
Closed
5 tasks done

Clarify Distinction Between OSCAL Data Types token and NCName in Website #1105

aj-stein-nist opened this issue Jan 25, 2022 · 4 comments · Fixed by #1480
Assignees
Milestone

Comments

@aj-stein-nist
Copy link
Contributor

aj-stein-nist commented Jan 25, 2022

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 and NCName 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.
    [ ] NCName should be removed as a datatype. Did not remove since old docs reference it.
    - [ ] Need to add any missing data types
  • Sync the patterns with what is implemented in JSON and YAML. Each datatype should be clear in how the type is addressed in JSON and XML.

Background

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

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@david-waltermire
Copy link
Contributor

This work requires usnistgov/metaschema#191, which won't be ready until OSCAL 1.1. Moving the milestone accordingly.

@david-waltermire
Copy link
Contributor

This is partially addressed by PR #1161.

@david-waltermire
Copy link
Contributor

The documentation still needs to be updated to differentiate the syntactical differences.

david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Sep 27, 2022
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Sep 27, 2022
@david-waltermire david-waltermire linked a pull request Sep 27, 2022 that will close this issue
9 tasks
@aj-stein-nist aj-stein-nist moved this from Todo to In Progress in NIST OSCAL Work Board Oct 4, 2022
@aj-stein-nist aj-stein-nist moved this from In Progress to Reviewer Approved in NIST OSCAL Work Board Oct 4, 2022
@aj-stein-nist aj-stein-nist moved this from Reviewer Approved to Done in NIST OSCAL Work Board Oct 4, 2022
@aj-stein-nist
Copy link
Contributor Author

This was reviewed and completed in the previous sprint, but not merged despite approval. This is a useful but low-risk documentation improvement into develop, so I am merging away and closing this issue. Thanks, Dave!

aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jan 10, 2023
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this issue Feb 6, 2023
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 29, 2023
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants