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

Update data types specifications in Pages site #230

Closed
3 tasks
wendellpiez opened this issue Aug 24, 2022 · 0 comments · Fixed by #245 or usnistgov/OSCAL#1531
Closed
3 tasks

Update data types specifications in Pages site #230

wendellpiez opened this issue Aug 24, 2022 · 0 comments · Fixed by #245 or usnistgov/OSCAL#1531
Assignees
Labels
enhancement New feature or request

Comments

@wendellpiez
Copy link
Collaborator

wendellpiez commented Aug 24, 2022

User Story:

Atomic data types (for field and flag values) must be documented for Metaschema.

These can be back ported and updated from the OSCAL Pages site.

This helps address Issue #224.

Data type descriptions should be normative and should address how datatypes can (and cannot) be validated lexically to ensure values can be processed without (parsing) errors.

Goals:

Update the normative specs for Metaschema datatypes. The place to start (and maybe finish) is at https://github.com/usnistgov/metaschema/blob/main/website/content/specification/syntax/_index.md

Further refactoring of the site is not a goal, but these specs must be as accurate and complete as possible.

Dependencies:

Stability wrt #224.

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated. Changes to the 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.
@wendellpiez wendellpiez added the enhancement New feature or request label Aug 24, 2022
@david-waltermire david-waltermire self-assigned this Aug 25, 2022
@david-waltermire david-waltermire added this to the Metaschema 0.9.0 milestone Aug 25, 2022
david-waltermire added a commit to david-waltermire/metaschema that referenced this issue Oct 28, 2022
david-waltermire added a commit to david-waltermire/metaschema that referenced this issue Nov 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
2 participants