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

Update OSCAL Catalog and Profile schema documentation #212

Closed
akarmel opened this issue Jun 26, 2018 · 17 comments
Closed

Update OSCAL Catalog and Profile schema documentation #212

akarmel opened this issue Jun 26, 2018 · 17 comments
Assignees
Labels
LoE: Medium Scope: Modeling Issues targeted at development of OSCAL formats Scope: Website Issues targeted at the OSCAL project website. User Story

Comments

@akarmel
Copy link
Contributor

akarmel commented Jun 26, 2018

User Story:

As an OSCAL content consumer, I have clear, concise and descriptive documentation describing the Catalog and Profile layers of OSCAL.

Goals:

  1. Develop clear, concise and descriptive documentation describing the OSCAL Catalog with input from the OSCAL Team (@PCrayton with review from @david-waltermire-nist @wendellpiez )
  2. Develop clear, concise and descriptive documentation describing the OSCAL Profile with input from the OSCAL Team (@PCrayton with review from @david-waltermire-nist @wendellpiez )
  3. Develop XML (e.g., element, attribute) and JSON (e.g, arrays, maps, objects, names/labels, members/values) specific terminology (@david-waltermire-nist @wendellpiez)
  4. Technical Edit OSCAL Catalog and Profile documentation (@bbattaglini)
  5. Develop more comprehensive descriptions of the OSCAL model and each data structure, the semantics, content requirements and valid values (@bbattaglini)

Dependencies:

None

Acceptance Criteria

  1. OSCAL Catalog and Profile documentation exists, has been technically edited and reviewed by the OSCAL Team
  2. OSCAL Catalog and Profile documentation has been published in the OSCAL GitHub repository
@kscarf1
Copy link
Contributor

kscarf1 commented Jun 27, 2018

June 27, 2018 status: Standing by to help when needed.

@iMichaela
Copy link
Contributor

iMichaela commented Jun 28, 2018

6/28/2018 Status

Reviewed the user story to reflect the scenario discussed during the meeting.

@wendellpiez
Copy link
Contributor

Many edits and improvements have been made in documentation in PR #201, but much remains to be done. In particular, while a better production framework is now in place for schema documentation, our editorial workflow is not; until it is, further work on this Issue is hindered.

Since schema documents start with their metaschemas, editorial workflow for the documentation is tied to metaschema maintenance. However, an early goal could be to stabilize the catalog and profile metaschemas as soon as possible ("finishing" their inline documentation), permitting us to move the focus of effort to other useful kinds of docs (guides, tutorials etc). At time of writing, only the embedded docs are in place (started) but not finished.

@iMichaela
Copy link
Contributor

July 18 Status Update (Sprint 12 Acceptance Meeting)

The issue was not assigned to any member of the team in Sprint 12 and we will push the issue to Sprint 13

@PCrayton
Copy link

PCrayton commented Aug 9, 2018

8/9/18 Status

  1. Created a rough draft of the catalog documentation. 40% Complete
  2. Created outline of the profile documentation. 20% Complete
    Issues: None at this time.

@PCrayton
Copy link

8/23/18 Status
Worked today with @wendellpiez on the documentation of catalog elements. Will incorporate Wendell's input into the catalog draft and forward it to @david-waltermire-nist for his review
Issues: None at this time.

@PCrayton
Copy link

8/30/18 Status
Working on incorporating input from @wendellpiez and properly documenting the usage of parameters as per Issue #190
Issues: None at this time

@PCrayton
Copy link

PCrayton commented Sep 6, 2018

9/6/18 Status

Shared documentation efforts with @david-waltermire-nist and received his input. Will incorporate it and work with @wendellpiez to set up a proper Github pipeline for production.

@PCrayton
Copy link

9/13/18 Status

Worked with @wendellpiez to set up a Github pipeline for production of documentation. Working on incorporating input from @david-waltermire-nist and @wendellpiez on the catalog and profile schemas.

@iMichaela
Copy link
Contributor

iMichaela commented Sep 27, 2018

9/26/2018

@PCrayton received feedback from @wendellpiez and need just a little more time (low effort) in Sprint 14.

@iMichaela
Copy link
Contributor

10/4/2018

This issue is related to #190 . @PCrayton Peter can wrap it by the end of next week. @david-waltermire-nist will review tomorrow the drafts.

@david-waltermire
Copy link
Contributor

10/11/18 Status


@PCrayton Will open a PR with the completed catalog and profile documentation in their respective metamodels. @wendellpiez and @david-waltermire-nist will review this.

@david-waltermire david-waltermire self-assigned this Nov 1, 2018
@iMichaela
Copy link
Contributor

11/08/2018

@david-waltermire-nist is reviewing the PR

@david-waltermire
Copy link
Contributor

11/15/2018

@david-waltermire-nist will accept PR #255 and we will plan new documentation activities to further improve the documentation in sprint 16.

@akarmel akarmel changed the title Create OSCAL Catalog and Profile documentation Create OSCAL Catalog and Profile documentation for OSCAL Content Creator and Tool Developers Dec 10, 2018
@david-waltermire david-waltermire added Scope: Modeling Issues targeted at development of OSCAL formats Scope: Website Issues targeted at the OSCAL project website. labels May 9, 2019
@david-waltermire
Copy link
Contributor

Need to review schema docs and make sure they are clear enough. Might be able to use some docs from PR #255. Make updates as needed.

@david-waltermire david-waltermire changed the title Create OSCAL Catalog and Profile documentation for OSCAL Content Creator and Tool Developers Update OSCAL Catalog and Profile schema documentation May 16, 2019
@iMichaela
Copy link
Contributor

5/23/2019

Needs update from @david-waltermire-nist . The issue will require coordination.

@david-waltermire
Copy link
Contributor

This work is happening in #387.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
LoE: Medium Scope: Modeling Issues targeted at development of OSCAL formats Scope: Website Issues targeted at the OSCAL project website. User Story
Projects
None yet
Development

No branches or pull requests

6 participants