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

Schema documentation enhancements #387

Closed
wendellpiez opened this issue May 29, 2019 · 2 comments
Closed

Schema documentation enhancements #387

wendellpiez opened this issue May 29, 2019 · 2 comments
Assignees
Labels
Discussion Needed This issues needs to be reviewed by the OSCAL development team. Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Modeling Issues targeted at development of OSCAL formats Scope: Website Issues targeted at the OSCAL project website. User Story

Comments

@wendellpiez
Copy link
Contributor

User Story:

Current schema docs are not yet perfect. There are some useful bits of information missing.

For example, they do not clearly indicate where and when text is permitted (for example, in fields).

Examples will also help.

Goals:

Improve the schema docs with features such as the above, along with any other significant features.

Dependencies:

If we decide to include it, #337 (element maps for navigation) could be folded in.

Alternatively, the scope could be kept narrow to expedite the work.

Acceptance Criteria

  • The next set of enhancements to auto-generated schema documentation has been defined
  • A design has been implemented and tested, and a PR is ready
@david-waltermire david-waltermire added this to the OSCAL 1.0 M1 milestone May 29, 2019
@david-waltermire david-waltermire self-assigned this May 30, 2019
@david-waltermire david-waltermire added Scope: Modeling Issues targeted at development of OSCAL formats Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Website Issues targeted at the OSCAL project website. User Story labels May 30, 2019
@wendellpiez
Copy link
Contributor Author

We need links from "prose" or for that matter any field permitting mixed content, to say what this means and to link to documentation on the prose model (block or inline). See #357.

@wendellpiez wendellpiez added the Discussion Needed This issues needs to be reviewed by the OSCAL development team. label May 31, 2019
@david-waltermire
Copy link
Contributor

This is covered by the suite of Metaschema enhancements/refactoring issues recently created. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Needed This issues needs to be reviewed by the OSCAL development team. Scope: Metaschema Issues targeted at the metaschema pipeline 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

2 participants