-
Notifications
You must be signed in to change notification settings - Fork 13
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
Rene2mt
wants to merge
14
commits into
GSA:develop
Choose a base branch
from
Rene2mt:feature-issue-11
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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>
aj-stein-gsa
force-pushed
the
develop
branch
from
November 19, 2024 20:46
37af293
to
cfe19bb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.
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.