-
Notifications
You must be signed in to change notification settings - Fork 92
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 ADR for constraint-based help documentation by URL for SARIF-based results output #735
Add ADR for constraint-based help documentation by URL for SARIF-based results output #735
Conversation
92af1a9
to
fd63316
Compare
Co-authored-by: David Waltermire <[email protected]>
Follow on from relevant discussion that started in metaschema-framework/metaschema-java#131 (comment) as inspired by GSA/fedramp-automation#735.
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.
Reviewed the draft ADR. The ADR is clear and I'm onboard with the proposed option 4.
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.
Looks good. Context, possible solutions, and consequences are all clear. Solution 4 feels like the right balance of flexibility, scalability, and ease of implementation for all parties. 😄
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.
Just some small tweaks to make. I think comment numbers 1, 3, and 5 are blocking, and 2 and 4 are just suggestions that you can take or leave. Let me know what you think
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.
Good job AJ :) And with that, my first review is done!!
Co-authored-by: Gabeblis <[email protected]>
e395c10
to
f79bfe6
Compare
Per valid PR feedback, we should clarify that AJ and the team drafted and reviewed the PR ahead of soliciting community review and feedback.
Co-authored-by: David Waltermire <[email protected]>
…d results output (GSA#735) * [skip ci] Start up ADR 9 from template for GSA#720 * [skip ci] Add context for decision in GSA#720 * [skip ci] Add possible solutions for GSA#720 * [skip ci] Hyperlink oscal-cli for bg in GSA#720 PR * [skip ci] Fix Metachema->Metaschema typos for GSA#720 * [skip ci] Add consequences of decisions for GSA#720 * [skip ci] Spacing and style guide for S4 in GSA#720 * [skip ci] Recommend Solution 4 for GSA#720 * [skip ci] Reorg and improve decision rec for GSA#720 * [skip ci] Missed or required for decision in GSA#720 * [skip ci] Clarify backporting and new dev for GSA#720 * [skip ci] Clarify Metaschema data-types and structure per out-of-band PR review * [skip ci] Correct namespace per PR feedbacm. Co-authored-by: David Waltermire <[email protected]> * [skip ci] Correct grammar, editing-edit per review Co-authored-by: Gabeblis <[email protected]> * [skip ci] Clarify team vetted ahead of community Per valid PR feedback, we should clarify that AJ and the team drafted and reviewed the PR ahead of soliciting community review and feedback. * [skip ci] Add newlines for `help-markdown` per final feedback Co-authored-by: David Waltermire <[email protected]> --------- Co-authored-by: David Waltermire <[email protected]> Co-authored-by: Kylie Hunter <[email protected]> Co-authored-by: Gabeblis <[email protected]>
Committer Notes
Create an ADR as one of the first steps in #720.
All Submissions:
If applicable, have all FedRAMP Documents Related to OSCAL Adoption affected by the changes in this issue have been updated?N/A, because significant documentation improves will follow in follow-on issues and their respective PRs.By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.