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

Implement new allowed value design #1396

Open
5 tasks
david-waltermire opened this issue Aug 1, 2022 · 1 comment
Open
5 tasks

Implement new allowed value design #1396

david-waltermire opened this issue Aug 1, 2022 · 1 comment
Labels
Aged A label for issues older than 2023-01-01 enhancement User Story

Comments

@david-waltermire
Copy link
Contributor

david-waltermire commented Aug 1, 2022

User Story

As an OSCAL developer or content creator, I need an easy way to understand which values are allowed to be used for a given data element within the OSCAL models.

The current OSCAL reference documentation lists the constraints that define the allowed values, but these constraints are often documented in a different location than where the value is used. This makes it very difficult to identify all of the allowed values for a given data element within the OSCAL models.

In issue #1337 a mockup of a new reference design was presented. As a follow-on, code needs to be written to produce allowed values using this representation.

Completing this issue will address the implementation in #1368.

Goals

  • Write a documentation generator in Java that produces allowed values lists for each data element within the OSCAL models using the new representation.

Dependencies

This issue must be completed with the following issues.

Acceptance Criteria

  • Consult with team and community to determine if the implementation is acceptable.
  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@aj-stein-nist
Copy link
Contributor

Not completed last sprint and not in scope for Sprint 63, moving to the backlog.

@aj-stein-nist aj-stein-nist removed their assignment Apr 6, 2023
@aj-stein-nist aj-stein-nist removed this from the v1.1.0 milestone Jul 27, 2023
@Compton-US Compton-US added the Aged A label for issues older than 2023-01-01 label Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Aged A label for issues older than 2023-01-01 enhancement User Story
Projects
Status: Further Analysis Needed
Development

No branches or pull requests

3 participants