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 and improve metaschema documentation of models and syntax #657

Closed
4 tasks
wendellpiez opened this issue Apr 23, 2020 · 1 comment
Closed
4 tasks
Assignees
Labels
enhancement model-refactor Used to mark issues related to model refactoring for the Metaschema v4 transition. Scope: Modeling Issues targeted at development of OSCAL formats User Story

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented Apr 23, 2020

User Story:

Documentation of OSCAL models and syntax in the metaschemas is due for maintenance.

This includes formal names, descriptions and remarks on assemblies, fields, flags and their constraints. It does not include embedded or linked samples, which will require a bit more development to support in the new Metaschema (see usnistgov/metaschema-xslt#14).

See usnistgov/metaschema#363, which encompasses this work item along with work on the web site.

Goals:

Documentation of models, syntax, constraints and semantics of the OSCAL models -- especially at the Implementation layer, but also throughout -- needs to be up to date.

To this end, for this Issue, we should revise, update and improve documentation embedded in the metaschemas.

Dependencies:

Since it happens in the metaschema files, this work needs to be coordinated with parallel work on the models.

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.
  • Issues have been created for follow-on work such as examples in the metaschema.
  • 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 this to the OSCAL 1.0 Milestone 3 milestone Apr 23, 2020
@david-waltermire david-waltermire added model-refactor Used to mark issues related to model refactoring for the Metaschema v4 transition. Scope: Modeling Issues targeted at development of OSCAL formats labels Sep 11, 2020
@david-waltermire
Copy link
Contributor

This issue was addressed by PR #758.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement model-refactor Used to mark issues related to model refactoring for the Metaschema v4 transition. Scope: Modeling Issues targeted at development of OSCAL formats User Story
Projects
None yet
Development

No branches or pull requests

3 participants