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

Validation Overview: Revise Current Validation Summary Content #1109

Open
Tracked by #1105
brian-ruf opened this issue Jan 20, 2025 · 0 comments
Open
Tracked by #1105

Validation Overview: Revise Current Validation Summary Content #1109

brian-ruf opened this issue Jan 20, 2025 · 0 comments

Comments

@brian-ruf
Copy link
Contributor

brian-ruf commented Jan 20, 2025

User Story

As an implementer of tools for authoring of a FedRAMP content, I need to understand the various levels and forms of validation available to me as well as those used by FedRAMP PMO tools for validating content I submit.

This includes:

  • enumeration of:
    • well-formed XML/JSON/YAML
    • syntax validation via XML or JSON schemas
    • core OSCAL metaschema validation; and
    • FedRAMP metaschema validation
  • expanded information on metaschema validation and FedRAMP's use of it
  • use of the OSCAL CLI for validation, including:
    • link to the repo
    • link directly to the repo's installation instructions
    • specific syntax for using the OSCAL CLI with FedRAMP metaschema files
    • References and/or details regarding SARIF output

Content Location

This content must reside in the Developer Hub as follows:

Repo Location:

/content/documentation/validation/_index.md

URL Location:

https://automate.fedramp.gov/documentation/validation/

Revision Work Alignment

No specific issue

@brian-ruf brian-ruf changed the title Validation Overview: Revise current validation summary content to include the OSCAL-CLI and the use of metaschema Validation Overview: Revise Current Validation Summary Content Jan 21, 2025
@aj-stein-gsa aj-stein-gsa moved this from 🆕 New to 🔖 Ready in FedRAMP Automation Jan 22, 2025
@Rene2mt Rene2mt moved this from 🔖 Ready to 🏗 In progress in FedRAMP Automation Jan 22, 2025
@Rene2mt Rene2mt moved this from 🏗 In progress 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
Projects
Status: 🚢 Ready to Ship
Development

No branches or pull requests

3 participants