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

Review identifier scoping and uniqueness documentation #860

Closed
6 tasks
david-waltermire opened this issue Mar 15, 2021 · 5 comments · Fixed by #941
Closed
6 tasks

Review identifier scoping and uniqueness documentation #860

david-waltermire opened this issue Mar 15, 2021 · 5 comments · Fixed by #941
Assignees
Labels
enhancement Scope: Documentation This issue relates to OSCAL documentation. Scope: Modeling Issues targeted at development of OSCAL formats User Story
Milestone

Comments

@david-waltermire
Copy link
Contributor

david-waltermire commented Mar 15, 2021

User Story:

As an OSCAL content creator and consumer, I need clear guidance on the scope and uniqueness of identifiers used within the OSCAL models.

Goals:

  • Generate a list of identifiers used in the OSCAL models
  • Review model documentation related to these identifiers to ensure their scoping and uniqueness is clearly stated.
  • Add constraints to enforce uniqueness where possible.

Dependencies:

{Describe any previous issues or related work that must be completed to start or complete this issue.}

Acceptance Criteria

  • 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.
@david-waltermire david-waltermire added enhancement User Story Scope: Modeling Issues targeted at development of OSCAL formats Scope: Documentation This issue relates to OSCAL documentation. labels Mar 15, 2021
@david-waltermire david-waltermire added this to the OSCAL 1.0.0 RC 2 milestone Mar 23, 2021
@david-waltermire david-waltermire self-assigned this Mar 23, 2021
@Rene2mt

This comment has been minimized.

@Rene2mt
Copy link
Contributor

Rene2mt commented May 21, 2021

Please see changes on my fork (Rene2mt@92c7a95). If all looks okay, I'll do a PR.

@david-waltermire
Copy link
Contributor Author

This is addressed by PR #860, which still needs some work to get the text right.

@david-waltermire david-waltermire linked a pull request Jun 7, 2021 that will close this issue
8 tasks
@Rene2mt
Copy link
Contributor

Rene2mt commented Oct 28, 2021

Changes completed (see PR#941), however, seeing conflict on the PR that needs to be resolved.

@Rene2mt
Copy link
Contributor

Rene2mt commented Jan 6, 2022

  • Created a new documentation page under "Concepts" that provides a summary narrative on identifier use, including the most common identifier types in OSCAL, their uniqueness, and scope. This documentation also attempts to describe which identifiers may be referenced when an OSCAL document imports another (e.g., AP imports SSP).
  • All Metaschemas have ben updated (pending review - see Identifier Scoping and Uniqueness Documentation Review #1066 ).
  • WIP: html anchor links from Metaschemas documentation to identifier use page. This has been added one a few of the control layer Metaschemas . To review, run the build tools (generates OSCAL XML and JSON) and then generate model documentation (creates all the reference docs).

david-waltermire added a commit that referenced this issue Jan 25, 2022
- Revised the identifier use documentation to provide better descriptions of the different types of human- and machine-oriented identifiers used in OSCAL to include information about their uniqueness and scope.
- Updated OSCAL src/metaschema documentation to provide more information for each identifier declaration about its scope, uniqueness, and how it may be cross-referenced.

Co-authored-by: David Waltermire <[email protected]>
Co-authored-by: Brad Hards <[email protected]>
Co-authored-by: Alexander Stein <[email protected]>
david-waltermire added a commit that referenced this issue Jan 26, 2022
- Revised the identifier use documentation to provide better descriptions of the different types of human- and machine-oriented identifiers used in OSCAL to include information about their uniqueness and scope.
- Updated OSCAL src/metaschema documentation to provide more information for each identifier declaration about its scope, uniqueness, and how it may be cross-referenced.

Co-authored-by: David Waltermire <[email protected]>
Co-authored-by: Brad Hards <[email protected]>
Co-authored-by: Alexander Stein <[email protected]>
@Rene2mt Rene2mt closed this as completed Jan 27, 2022
iMichaela pushed a commit to iMichaela/OSCAL that referenced this issue Apr 7, 2022
- Revised the identifier use documentation to provide better descriptions of the different types of human- and machine-oriented identifiers used in OSCAL to include information about their uniqueness and scope.
- Updated OSCAL src/metaschema documentation to provide more information for each identifier declaration about its scope, uniqueness, and how it may be cross-referenced.

Co-authored-by: David Waltermire <[email protected]>
Co-authored-by: Brad Hards <[email protected]>
Co-authored-by: Alexander Stein <[email protected]>
Rene2mt added a commit to Rene2mt/OSCAL that referenced this issue May 17, 2022
- Revised the identifier use documentation to provide better descriptions of the different types of human- and machine-oriented identifiers used in OSCAL to include information about their uniqueness and scope.
- Updated OSCAL src/metaschema documentation to provide more information for each identifier declaration about its scope, uniqueness, and how it may be cross-referenced.

Co-authored-by: David Waltermire <[email protected]>
Co-authored-by: Brad Hards <[email protected]>
Co-authored-by: Alexander Stein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Scope: Documentation This issue relates to OSCAL documentation. Scope: Modeling Issues targeted at development of OSCAL formats User Story
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants