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

WIP - Adding an allowed-values documentation page #70

Draft
wants to merge 14 commits into
base: develop
Choose a base branch
from

Conversation

Rene2mt
Copy link
Member

@Rene2mt Rene2mt commented Oct 3, 2024

DO NOT MERGE. THIS PR IS WORK IN PROGRESS (WIP)

This WIP PR adds a separate documentation page for allowed values (issue #11). The added markdown page was created by:

  1. Running the following OSCAL-CLI command to get a comprehensive list of all allowed-values (builtin OSCAL as well as in our developed external constraints):

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

  1. Then used yq to adjust the generated YAML

yq '.locations.[].constraints[] |= pick(["location", "target", "values", "allow-other", "source"])' results/fr-allowed-values.yaml > results/fr-allowed-values-transformed.yaml

  1. Then, using yaml-to-markdown to convert the yaml list of allowed values to a Markdown page.

Step 2 needs more work to filter / select only keys of interest for documentation. Step 3 has some formatting issues (e.g. wide tables). Also many of the allowed-values constraints do not have identifiers, so the table columns / headers are inconsistent.

GOAL 1 - By having having all the allowed-values documentation in one place (similar to registry), it should be easier for FedRAMP OSCAL content authors to find the allowed-values guidance they might be looking for. It also simplifies documentation on other pages, as we can have documentation pages (like https://automate.fedramp.gov/documentation/ssp/4-ssp-template-to-oscal-mapping/) reference (with deep links) the allowed-value page content, and do away with the current blue callout boxes that we have now.

image

GOAL 2 - A secondary goal would be to generate the allowed-values page automatically so that as we add new or modify any allowed-values constraints in Metaschema, the documentation is automatically updated as well.

devbytyler and others added 14 commits August 30, 2024 11:39
DIT and DAR  images and oscal samples was mixed. Swapped the oscal example to align with the image.

Signed-off-by: A.J. Stein <[email protected]>
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.3.3 to 4.3.6.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@6546280...834a144)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Dependabot couldn't find the original pull request head commit, b593799.
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.3.6 to 4.4.0.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@834a144...5076954)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Make country code requirement explicit for GSA#51

* Country code example should be capitals for GSA#51

We should follow constraint and the official spec for ISO-3166 Alpha-2.

https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#US
Revert once GSA#54 looks like it is no longer the case and PR putting it back on the scan list.
Below is the commit message. I noticed after the PR merge and this was
not the intention. This PR branch should go into develop then be
promoted into main after. I will reset branch before we forget.

Explain name and short name requirement for GSA#58 (GSA#59)
Bumps [actions/checkout](https://github.com/actions/checkout) from 4.1.7 to 4.2.0.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@692973e...d632683)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [peter-evans/create-issue-from-file](https://github.com/peter-evans/create-issue-from-file) from 5.0.0 to 5.0.1.
- [Release notes](https://github.com/peter-evans/create-issue-from-file/releases)
- [Commits](peter-evans/create-issue-from-file@24452a7...e8ef132)

---
updated-dependencies:
- dependency-name: peter-evans/create-issue-from-file
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.

3 participants