-
Notifications
You must be signed in to change notification settings - Fork 181
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 README around how to validate OSCAL #1170
Add README around how to validate OSCAL #1170
Conversation
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.
Provided some feedback. This looks like a work in progress, so I did not approve or disapprove. Lots of links need to be added, but you have placeholders for most of these.
Nice, thanks for the feedback Dave, will be sure to work with Wendell more on it, but already wrapped in your suggestions (this this time using the batch feature of course!). It took me a minute, but the batch feature requires you look at the PR from the files changed perspective or it breaks. That, or the add suggestion to batch button never works and you lose a few minutes of your sanity and life. :-) |
5b6c822
to
96c59b9
Compare
@david-waltermire-nist, sorry for the delays. This is ready for review. If you are happy with it, also read for inclusion to be released as part of |
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 requested some changes be made in the comments.
6360483
to
00c2def
Compare
As discussed yesterday afternoon, @david-waltermire-nist, gave one last past this morning before final ship. Caught some minor typos and touchups from shifting things on the call. I left the last commit so you can quickly see what I changed. |
@aj-stein-nist Arg I actually saw a couple of tinies, is there a way I can also touch up? |
You can add suggestions like I do, explained in this tutorial video of I can walk you through it via Gitter, just message if this is hard to use and we can work through it. |
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.
Offering a few touchups to wording here and there -- it looks nice!
Apply Dave's suggestions from code review Final edits after review. Final revisions. Last pass for typo, grammar, and style touchups. Co-authored-by: David Waltermire <david.waltermire@nist.gov> Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
0e2a1b9
to
9696451
Compare
OK, @david-waltermire-nist, last typo fixes merged. |
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 for squashing and for this work!
Co-authored-by: David Waltermire <david.waltermire@nist.gov> Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
Co-authored-by: David Waltermire <david.waltermire@nist.gov> Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
Committer Notes
Follow on PR per discussion in #1153 to split high-level what is validation from how to validate. This is the latter. Per recs from @david-waltermire-nist, drop this in a README in the top-level dir of the project, and keep it separate from the core README.md. Together with #1169, this will closes #1153.
All Submissions:
Changes to Core Features:
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.