-
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
Add possible Schematron documentation checks #1501
Add possible Schematron documentation checks #1501
Conversation
fa5250c
to
e4f710c
Compare
@aj-stein-nist This needs to be rebased. |
767605b
to
450b8c8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am good with adding these checks, but they need to be integrated into the CI. Please add this to the CI.
Will do, sir! |
450b8c8
to
1704e71
Compare
Dave, I am going to push up just a few changes to the SSP metaschema def and imported common modules metaschema def(s) for the SSP. This shows the CI/CD checker in action with the amended script to run the checks in CI/CD. https://github.com/usnistgov/OSCAL/actions/runs/3364015177/jobs/5577876131 The commit after this ought to resolve them. The other build failures are blocked until we merge the URI and link check PRs currently out for review. EDIT: As promised, this now passing with the passing Metaschema validation check. https://github.com/usnistgov/OSCAL/actions/runs/3364123554/jobs/5578110944 |
f8be060
to
3bc3954
Compare
e5a3198
to
a37c965
Compare
This is the product of the meeting and spike where we pair-programmed and came up with example Schematron rules for tentative editorial standards that can be used for reviews of models and embedded docs as part of usnistgov#801. Co-authored-by: Chris Compton <[email protected]> Co-authored-by: Rene Rene Tshiteya <[email protected]> Co-authored-by: Wendell Piez <[email protected]> Add CI/CD checking of Schematron doc standards checking. Always zip and upload Schematron validation results for potential debug.
3bc3954
to
00507bd
Compare
Rebased and ready to review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should merge the documentation check into the composition check schematron, since all inherited schematrons will be checked as well.
Sounds good, I can make those changes accordingly! |
Oh on second thought, I guess this means I need a Metaschema repo PR first, as that is where the Metaschema composition check is housed. I will refactor this and move the Schematron accordingly into the existing one, and just call it in CI/CD scripting. I will revert the |
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
Changes made and usnistgov/metaschema#246 opened. |
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
* Add possible Schematron documentation checks This is the product of the meeting and spike where we pair-programmed and came up with example Schematron rules for tentative editorial standards that can be used for reviews of models and embedded docs as part of usnistgov#801. Co-authored-by: Chris Compton <[email protected]> Co-authored-by: Rene Rene Tshiteya <[email protected]> Co-authored-by: Wendell Piez <[email protected]> Add CI/CD checking of Schematron doc standards checking. Always zip and upload Schematron validation results for potential debug. * After, show the Schematron checks passing after Metaschema def fixes. * Revert validate-metaschema.sh changes. * Revert refactored Schematron and remove from PR. * Update metaschema module to include updated Schematron in usnistgov/metaschema#246. Co-authored-by: David Waltermire <[email protected]>
* Add possible Schematron documentation checks This is the product of the meeting and spike where we pair-programmed and came up with example Schematron rules for tentative editorial standards that can be used for reviews of models and embedded docs as part of usnistgov#801. Co-authored-by: Chris Compton <[email protected]> Co-authored-by: Rene Rene Tshiteya <[email protected]> Co-authored-by: Wendell Piez <[email protected]> Add CI/CD checking of Schematron doc standards checking. Always zip and upload Schematron validation results for potential debug. * After, show the Schematron checks passing after Metaschema def fixes. * Revert validate-metaschema.sh changes. * Revert refactored Schematron and remove from PR. * Update metaschema module to include updated Schematron in usnistgov/metaschema#246. Co-authored-by: David Waltermire <[email protected]>
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
* Add possible Schematron documentation checks This is the product of the meeting and spike where we pair-programmed and came up with example Schematron rules for tentative editorial standards that can be used for reviews of models and embedded docs as part of usnistgov#801. Co-authored-by: Chris Compton <[email protected]> Co-authored-by: Rene Rene Tshiteya <[email protected]> Co-authored-by: Wendell Piez <[email protected]> Add CI/CD checking of Schematron doc standards checking. Always zip and upload Schematron validation results for potential debug. * After, show the Schematron checks passing after Metaschema def fixes. * Revert validate-metaschema.sh changes. * Revert refactored Schematron and remove from PR. * Update metaschema module to include updated Schematron in usnistgov/metaschema#246. Co-authored-by: David Waltermire <[email protected]>
* Add possible Schematron documentation checks This is the product of the meeting and spike where we pair-programmed and came up with example Schematron rules for tentative editorial standards that can be used for reviews of models and embedded docs as part of usnistgov#801. Co-authored-by: Chris Compton <[email protected]> Co-authored-by: Rene Rene Tshiteya <[email protected]> Co-authored-by: Wendell Piez <[email protected]> Add CI/CD checking of Schematron doc standards checking. Always zip and upload Schematron validation results for potential debug. * After, show the Schematron checks passing after Metaschema def fixes. * Revert validate-metaschema.sh changes. * Revert refactored Schematron and remove from PR. * Update metaschema module to include updated Schematron in usnistgov/metaschema#246. Co-authored-by: David Waltermire <[email protected]>
Relocated from usnistgov/OSCAL@ef8fa01 as previously coded in usnistgov/OSCAL#1501 for usnistgov/OSCAL#801. Relocated per feedback from Dave in that PR.
* Add possible Schematron documentation checks This is the product of the meeting and spike where we pair-programmed and came up with example Schematron rules for tentative editorial standards that can be used for reviews of models and embedded docs as part of usnistgov#801. Co-authored-by: Chris Compton <[email protected]> Co-authored-by: Rene Rene Tshiteya <[email protected]> Co-authored-by: Wendell Piez <[email protected]> Add CI/CD checking of Schematron doc standards checking. Always zip and upload Schematron validation results for potential debug. * After, show the Schematron checks passing after Metaschema def fixes. * Revert validate-metaschema.sh changes. * Revert refactored Schematron and remove from PR. * Update metaschema module to include updated Schematron in usnistgov/metaschema#246. Co-authored-by: David Waltermire <[email protected]>
Committer Notes
This is the product of the meeting and spike where we pair-programmed and came up with example Schematron rules for tentative editorial standards that can be used for reviews of models and embedded docs as part of #801.
All Submissions:
"?
By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.
Changes to Core Features:
Have you added an explanation of what your changes do and why you'd like us to include them?Have you written new tests for your core changes, as applicable?Have you included examples of how to use your new feature(s)?Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.