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

Update Documentation -> FedRAMP Extensions and Values Content #11

Open
1 of 3 tasks
Rene2mt opened this issue May 21, 2024 · 1 comment
Open
1 of 3 tasks

Update Documentation -> FedRAMP Extensions and Values Content #11

Rene2mt opened this issue May 21, 2024 · 1 comment

Comments

@Rene2mt
Copy link
Member

Rene2mt commented May 21, 2024

As a developer, I want to update and rename the "Documentation->FedRAMP Extensions and Values" section content with proper reference to up-to-date FedRAMP registry.

Todo:

  • Update registry to be "metaschema-based"
  • Update registry to ensure it is comprehensive, listing all allowed values, and all extensions
  • Update any links / references to the FedRAMP registry

#128 could replace the "Update registry ..." items above.

@Rene2mt
Copy link
Member Author

Rene2mt commented Sep 24, 2024

@aj-stein-gsa and @brian-ruf, OSCAL-CLI now supports generating allowed values information in YAML format, directly from the model Metaschemas and our external constraints.

oscal-cli list-allowed-values results/fedramp-allowed-values-list.yaml -c constraints/fedramp-external-allowed-values.xml

This feature can be used in place of the experimental fedramp_values.xml (https://github.com/GSA/fedramp-automation/blob/master/dist/content/rev5/resources/xml/fedramp_values.xml).

Are there planned enhancements to the OSCAL-CLI that would allow us to list out all the FedRAMP extensions in a similar way?

Finally, how can we use these YAML outputs on the documentation site? I was thinking we could:

  1. As part of CI, auto-generate an "Allowed-Values" page listing all (or just the FedRAMP-specific) allowed values - for example, there would be a markdown page at https://automate.fedramp.gov/documentation/allowed-values/ with formatted details of all the allowed values.
  2. As part of CI, auto-generate a "FedRAMP Extensions" page listing all the FedRAMP extensions - for example, there would be a markdown page at https://automate.fedramp.gov/documentation/fedramp-extensions/ with formatted details of al the FedRAMP extensions
  3. The other documentation pages, such as https://automate.fedramp.gov/documentation/ssp/4-ssp-template-to-oscal-mapping/#system-status, would provide deep links to the appropriate item in the pages above. This would hopefully make it easier for users to find because the information is consolidated in one page, and eliminate the need to have callouts throughout all the pages (like in the figure below).

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant