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

Add README around how to validate OSCAL #1170

Conversation

aj-stein-nist
Copy link
Contributor

@aj-stein-nist aj-stein-nist commented Mar 11, 2022

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:

  • Have you selected the correct base branch per Contributing guidance?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions]
  • Do all automated CI/CD checks pass?

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.

@aj-stein-nist aj-stein-nist added Discussion Needed This issues needs to be reviewed by the OSCAL development team. Scope: Documentation This issue relates to OSCAL documentation. Developer Experience Issues around enhancing and optimizing work for development of NIST OSCAL artifacts labels Mar 11, 2022
@aj-stein-nist aj-stein-nist added this to the OSCAL 1.0.2 milestone Mar 11, 2022
@aj-stein-nist aj-stein-nist changed the base branch from main to release-1.0 March 11, 2022 23:28
Copy link
Contributor

@david-waltermire david-waltermire left a 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.

README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
@aj-stein-nist
Copy link
Contributor Author

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. :-)

@aj-stein-nist aj-stein-nist changed the title [WIP] Add README around how to validate OSCAL Add README around how to validate OSCAL Mar 17, 2022
@aj-stein-nist aj-stein-nist force-pushed the issue-1153-docs-gh-readme-howto-validations branch from 5b6c822 to 96c59b9 Compare March 17, 2022 21:19
@aj-stein-nist aj-stein-nist marked this pull request as ready for review March 17, 2022 21:20
@aj-stein-nist
Copy link
Contributor Author

@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 v1.0.2 tomorrow.

Copy link
Contributor

@david-waltermire david-waltermire left a 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.

README_validations.md Outdated Show resolved Hide resolved
README_validations.md Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
@aj-stein-nist aj-stein-nist force-pushed the issue-1153-docs-gh-readme-howto-validations branch from 6360483 to 00c2def Compare March 17, 2022 22:21
@aj-stein-nist
Copy link
Contributor Author

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.

@wendellpiez
Copy link
Contributor

wendellpiez commented Mar 18, 2022

@aj-stein-nist Arg I actually saw a couple of tinies, is there a way I can also touch up?

@aj-stein-nist
Copy link
Contributor Author

aj-stein-nist commented Mar 18, 2022

@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.

Copy link
Contributor

@wendellpiez wendellpiez left a 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!

README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
README_validations.md Outdated Show resolved Hide resolved
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>
@aj-stein-nist aj-stein-nist force-pushed the issue-1153-docs-gh-readme-howto-validations branch from 0e2a1b9 to 9696451 Compare March 18, 2022 17:30
@aj-stein-nist
Copy link
Contributor Author

OK, @david-waltermire-nist, last typo fixes merged.

Copy link
Contributor

@david-waltermire david-waltermire left a 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!

@david-waltermire david-waltermire merged commit 9232070 into usnistgov:release-1.0 Mar 18, 2022
david-waltermire added a commit that referenced this pull request Mar 18, 2022
Co-authored-by: David Waltermire <david.waltermire@nist.gov>
Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
iMichaela pushed a commit to iMichaela/OSCAL that referenced this pull request Apr 7, 2022
Co-authored-by: David Waltermire <david.waltermire@nist.gov>
Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
Rene2mt pushed a commit to Rene2mt/OSCAL that referenced this pull request May 17, 2022
Co-authored-by: David Waltermire <david.waltermire@nist.gov>
Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer Experience Issues around enhancing and optimizing work for development of NIST OSCAL artifacts Discussion Needed This issues needs to be reviewed by the OSCAL development team. Scope: Documentation This issue relates to OSCAL documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on Validation Capabilites for Different Parts of the OSCAL Toolchain
3 participants