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

Examples of by-component link relations in SSPs #1539

Open
4 tasks
aj-stein-nist opened this issue Nov 2, 2022 · 2 comments
Open
4 tasks

Examples of by-component link relations in SSPs #1539

aj-stein-nist opened this issue Nov 2, 2022 · 2 comments
Labels
Aged A label for issues older than 2023-01-01 enhancement Scope: Documentation This issue relates to OSCAL documentation. User Story

Comments

@aj-stein-nist
Copy link
Contributor

User Story

As an OSCAL tool developer, to best understand how to cross-reference components through specific link types, I would like to see examples of it to understand how to consume and generate SSPs with the correct OSCAL JSON, XML, and YAML structure.

Goals

Add examples to clearly demonstrate to downstream developers how they should consume or generate these relationships with their tooling, per feedback #1022 (comment) after the completion of #1452.

Dependencies

N/A

Acceptance Criteria

  • An example of a SSP with example of cross-component linking with the new @rel="provided-by" syntax.
  • 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 Author

Definitely looks worthwhile, I would like @david-waltermire-nist to weight in if this belongs in Sprint 60, 61, or left in backlog for now.

@aj-stein-nist aj-stein-nist added the Scope: Documentation This issue relates to OSCAL documentation. label Sep 26, 2023
@aj-stein-nist
Copy link
Contributor Author

Marking this as blocked until #1910 is completed, and then it will be ready for "Needs Refinement" and determination if we edit this issue or replace it with a different one.

@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 Scope: Documentation This issue relates to OSCAL documentation. User Story
Projects
Status: Blocked
Development

No branches or pull requests

2 participants