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.

Sign up for GitHub

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

Jump to bottom

Design approach for managing OSCAL and non-OSCAL attachments #1061

Closed
1 of 2 tasks
aj-stein-gsa opened this issue Jan 3, 2025 · 0 comments · Fixed by #1062
Closed
1 of 2 tasks

Design approach for managing OSCAL and non-OSCAL attachments #1061

aj-stein-gsa opened this issue Jan 3, 2025 · 0 comments · Fixed by #1062
Assignees
@aj-stein-gsa
Labels
model: catalog model: poam model: profile model: sap model: sar model: ssp scope: constraints scope: documentation type: backlog item For developer work that is not part of a user-facing epic or user story. type: spike

Comments

@aj-stein-gsa
Copy link
Contributor

aj-stein-gsa commented Jan 3, 2025 •
edited
Loading

This is a ...

research - something needs to be investigated

This relates to ...

  • the FedRAMP OSCAL Validations

User Story

As a FedRAMP developer, in order to properly handle a set of common use cases in FedRAMP in handling OSCAL and "pre-OSCAL" (i.e. non-OSCAL) attachments in a transitional state, I would like a documented pattern for handling such use cases documents.

Goals

  • Document a reusable pattern for multiple use cases of handling OSCAL and non-OSCAL content simultaneously

Dependencies

N/A

Acceptance Criteria

  • All FedRAMP Documents Related to OSCAL Adoption (https://github.com/GSA/fedramp-automation) affected by the changes in this issue have been updated.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.

Other information

Per standup, the need for an ADR discussing benefits, drawbacks, and best practice for such data modeling in OSCAL came up as part of #934.
@aj-stein-gsa aj-stein-gsa moved this from 🆕 New to 📋 Backlog in FedRAMP Automation Jan 3, 2025
@aj-stein-gsa aj-stein-gsa self-assigned this Jan 3, 2025
@aj-stein-gsa aj-stein-gsa moved this from 📋 Backlog to 🔖 Ready in FedRAMP Automation Jan 3, 2025
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 3, 2025
@aj-stein-gsa
[skip ci] Add WIP ADR for attachment handling for GSA#1061
ace5d6a
@aj-stein-gsa aj-stein-gsa mentioned this issue Jan 3, 2025
Merged
7 tasks
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 3, 2025
@aj-stein-gsa
[skip ci] Update ADR13 for GSA#1061, add doc links
3fb91a2
@aj-stein-gsa aj-stein-gsa moved this from 🔖 Ready to 🏗 In progress in FedRAMP Automation Jan 3, 2025
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 3, 2025
@aj-stein-gsa
[skip ci] Detail ADR13 approach 3 for GSA#1061
8edbe62
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 3, 2025
@aj-stein-gsa
[skip ci] Detail ADR13 approach 4 for GSA#1061
4d9dbcf
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 3, 2025
@aj-stein-gsa
[skip ci] Add +/- themes for GSA#1061
eb40117
@aj-stein-gsa aj-stein-gsa linked a pull request Jan 3, 2025 that will close this issue
Add ADR for attachment handling for #1061 #1062
Merged
7 tasks
@aj-stein-gsa aj-stein-gsa moved this from 🏗 In progress to 👀 In review in FedRAMP Automation Jan 3, 2025
aj-stein added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 6, 2025
@aj-stein
Approach 2 has 2 tactics in ADR 13 for GSA#1061
abafb90
aj-stein added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 6, 2025
@aj-stein
Wrap-up ADR13 content For GSA#1061
eff7c18
aj-stein added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 6, 2025
@aj-stein
[skip ci ] Approach 2 has 2 tactics in ADR 13 for GSA#1061
e17bce4
aj-stein added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 6, 2025
@aj-stein
[skip ci] Wrap-up ADR13 content For GSA#1061
2034743
aj-stein added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Jan 6, 2025
@aj-stein
[skip ci] Touch up ADR13 final para for GSA#1061
4e63281
aj-stein-gsa added a commit that referenced this issue Jan 23, 2025
@aj-stein-gsa @aj-stein
Add ADR for attachment handling for #1061 (#1062)
1ff8a47 
* [skip ci] Add WIP ADR for attachment handling for #1061

* [skip ci] Update ADR13 for #1061, add doc links

* [skip ci] Detail ADR13 approach 3 for #1061

* [skip ci] Detail ADR13 approach 4 for #1061

* [skip ci] Add +/- themes for #1061

* [skip ci ] Approach 2 has 2 tactics in ADR 13 for #1061

* [skip ci] Wrap-up ADR13 content For #1061

* [skip ci] Touch up ADR13 final para for #1061

---------

Co-authored-by: A.J. Stein <[email protected]>
@aj-stein-gsa aj-stein-gsa moved this from 👀 In review to 🚢 Ready to Ship in FedRAMP Automation Jan 23, 2025
@github-project-automation github-project-automation bot moved this from 🚢 Ready to Ship to ✅ Done in FedRAMP Automation Jan 23, 2025
@aj-stein-gsa aj-stein-gsa moved this from ✅ Done to 👀 In review in FedRAMP Automation Jan 23, 2025
@aj-stein-gsa aj-stein-gsa moved this from 👀 In review to 🚢 Ready to Ship in FedRAMP Automation Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aj-stein-gsa aj-stein-gsa

Labels
model: catalog model: poam model: profile model: sap model: sar model: ssp scope: constraints scope: documentation type: backlog item For developer work that is not part of a user-facing epic or user story. type: spike
Projects
FedRAMP Automation
Status: 🚢 Ready to Ship
Milestone
No milestone
1 participant
@aj-stein-gsa