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 ADR for constraint-based help documentation by URL for SARIF-based results output #735

Merged

Conversation

aj-stein-gsa
Copy link
Contributor

@aj-stein-gsa aj-stein-gsa commented Sep 26, 2024

Committer Notes

Create an ADR as one of the first steps in #720.

All Submissions:

  • Have you selected the correct base branch per Contributing guidance?
  • Have you set "Allow edits and access to secrets by maintainers"?
  • 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]
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • If applicable, does this PR reference the issue it addresses and explain how it addresses the issue?
  • 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.

@aj-stein-gsa aj-stein-gsa self-assigned this Sep 26, 2024
@aj-stein-gsa aj-stein-gsa requested a review from a team as a code owner September 26, 2024 20:08
aj-stein-gsa added a commit to aj-stein-gsa/metaschema-modules that referenced this pull request Sep 30, 2024
Rene2mt
Rene2mt previously approved these changes Sep 30, 2024
Copy link
Member

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

Gabeblis
Gabeblis previously approved these changes Sep 30, 2024
Copy link
Contributor

@Gabeblis Gabeblis left a 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. 😄

Copy link

@kyhu65867 kyhu65867 left a 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

documents/adr/0009-constraint-based-help-docs.md Outdated Show resolved Hide resolved
documents/adr/0009-constraint-based-help-docs.md Outdated Show resolved Hide resolved
@kyhu65867 kyhu65867 dismissed stale reviews from Gabeblis and Rene2mt via e395c10 September 30, 2024 21:56
kyhu65867
kyhu65867 previously approved these changes Sep 30, 2024
Copy link

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

@aj-stein-gsa aj-stein-gsa force-pushed the 720-docs-adr-metapath-sarif-help-url branch from e395c10 to f79bfe6 Compare September 30, 2024 22:17
Per valid PR feedback, we should clarify that AJ and the team drafted
and reviewed the PR ahead of soliciting community review and feedback.
@aj-stein-gsa aj-stein-gsa merged commit 4cd6cec into GSA:develop Oct 1, 2024
@Gabeblis Gabeblis mentioned this pull request Oct 3, 2024
5 tasks
brian-ruf pushed a commit to brian-ruf/fedramp-automation that referenced this pull request Nov 8, 2024
…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]>
This was referenced Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants