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

Improve Developer Using Schematron and Understanding Results #33

Open
11 tasks
aj-stein-nist opened this issue Dec 6, 2022 · 1 comment
Open
11 tasks
Labels
enhancement New feature or request

Comments

@aj-stein-nist
Copy link
Contributor

aj-stein-nist commented Dec 6, 2022

User Story

As a Metaschema developer, in order to better understand how can I modify Measchema-based model definitions and predict mistakes sooner and faster, I want clear documentation on how to use existing Schematrons to check my modified Metaschemas definitions and understand the results to make corrections.

Goals

  • Add docs with inventory of existing Schematrons for Metaschema definition validations
  • Document how to run them
  • Document how to interpret results
  • Document how to find results with errors in CI/CD (once implemented)

Dependencies

Acceptance Criteria

  • All Metaschema website and readme documentation affected by the changes in this issue have been updated. Changes to the Metaschema 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.
@aj-stein-nist aj-stein-nist added the enhancement New feature or request label Dec 6, 2022
@aj-stein-nist aj-stein-nist transferred this issue from usnistgov/OSCAL Dec 6, 2022
@GaryGapinski
Copy link

If editing constrained by XML Schema is employed for Metaschema document maintenance, consider using embedded Schematron within the related XML Schema to obtain timely identification of deficiencies.

Alternately, multiple xml-model PIs can be used to associate multiple schemas with an instance document.

@david-waltermire david-waltermire transferred this issue from usnistgov/metaschema Jun 30, 2023
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
None yet
Development

No branches or pull requests

2 participants