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.

Sign up for GitHub

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

Jump to bottom

Building out new metaschema features in docs production #423

Closed
wendellpiez opened this issue Jun 13, 2019 · 1 comment
Closed

Building out new metaschema features in docs production #423

wendellpiez opened this issue Jun 13, 2019 · 1 comment
Assignees
@wendellpiez
Labels
enhancement Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Website Issues targeted at the OSCAL project website. User Story
Milestone
OSCAL 1.0 Milesto...

Comments

@wendellpiez
Copy link
Contributor

User Story:

With other issues (especially #388) we are enhancing the metaschema to support more condensed JSON production.

These features are not yet reflected in the documentation. Especially the JSON-oriented documentation will be impacted.

Goals:

Align the schema documentation production with the latest metaschema design.

The elements key (inside define-field and define-assembly, replacing the old @address attribute) and value-key (inside define-field) are new.

Any reference in docs to older @address functionality (no longer supported) will need rewiring.

Dependencies:

The Metaschema design must be stable again for this to proceed. Impacted metaschemas (catalog and profile) must be up to date with this design along with their produced artifacts (including XSD and JSON Schema).

Acceptance Criteria

  1. New Metaschema semantics bearing on JSON expression are reflected in schema docs
  2. A PR is posted with this work including a fresh run of schema documentation from current best sources.
@wendellpiez wendellpiez added this to the OSCAL 1.0 Milestone 2 milestone Jun 13, 2019
@david-waltermire david-waltermire added Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Website Issues targeted at the OSCAL project website. labels Jun 20, 2019
wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Jul 22, 2019
@wendellpiez
Schema documentation improvements usnistgov#423 usnistgov#424 usnistg…
5ca108a 
…ov#428
wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Jul 23, 2019
@wendellpiez
More enhancements to generated docs: usnistgov#423, usnistgov#424
7c35228
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
Schema documentation improvements usnistgov#423 usnistgov#424 usnistg…
2c93e9d 
…ov#428
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
More enhancements to generated docs: usnistgov#423, usnistgov#424
1ad5bdc
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
Schema documentation improvements usnistgov#423 usnistgov#424 usnistg…
7de7a54 
…ov#428
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
More enhancements to generated docs: usnistgov#423, usnistgov#424
c7def86
david-waltermire added a commit that referenced this issue Aug 22, 2019
@david-waltermire
Implementation refactor plus sprint22 metaschema (#464)
62a28fe 
* Supporting enumerated value lists on flags in XSD and JSON Schema #437
* Metaschema improvements and remodeling flags support (local definitions; moving w/in the model; valid values)
* More Metaschema syntax remodeling: now using max-occurs and min-occurs for cardinality indicators #441
* Updating schemas to current model (transitional); updated docs in resulting XSD per #448; some updates to markdown documentation
* Small updates to authoring CSS.
* Added design notes on JSON schema bindings.
* Including an initial set of unit tests for group-by, some data types, etc.
* Updated to new design (#436): Metaschema schema, Schematron, metaschema update XSLT - will break the build for now
* Work on datatyping #436 including support in XML and JSON Schema
* Addressed #451: parameter insertion syntax in Markdown
* Schema documentation improvements #423 #424 #428
* Addressed feature request #438
* Improving handling of JSON 'key' and 'value-key' settings in docs #428
* Now producing XML and JSON model maps from metaschemas.
* Now escaping {{ for Jekyll
* Updated component metaschema based on design notes
* Fixed schematron assertions to properly work with @ref.
* Refactoring of component and SSP metachema.
* Fixed website side navigation. Added component and SSP metaschema to site generation process.
* Addressed comments in issue #445
* Added site content generation to runall.sh
* Started documenting model changes in release notes. More work is still needed to complete this.
david-waltermire added a commit to david-waltermire/OSCAL that referenced this issue Aug 26, 2019
@david-waltermire
Implementation refactor plus sprint22 metaschema (usnistgov#464)
2d8c2ba 
* Supporting enumerated value lists on flags in XSD and JSON Schema usnistgov#437
* Metaschema improvements and remodeling flags support (local definitions; moving w/in the model; valid values)
* More Metaschema syntax remodeling: now using max-occurs and min-occurs for cardinality indicators usnistgov#441
* Updating schemas to current model (transitional); updated docs in resulting XSD per usnistgov#448; some updates to markdown documentation
* Small updates to authoring CSS.
* Added design notes on JSON schema bindings.
* Including an initial set of unit tests for group-by, some data types, etc.
* Updated to new design (usnistgov#436): Metaschema schema, Schematron, metaschema update XSLT - will break the build for now
* Work on datatyping usnistgov#436 including support in XML and JSON Schema
* Addressed usnistgov#451: parameter insertion syntax in Markdown
* Schema documentation improvements usnistgov#423 usnistgov#424 usnistgov#428
* Addressed feature request usnistgov#438
* Improving handling of JSON 'key' and 'value-key' settings in docs usnistgov#428
* Now producing XML and JSON model maps from metaschemas.
* Now escaping {{ for Jekyll
* Updated component metaschema based on design notes
* Fixed schematron assertions to properly work with @ref.
* Refactoring of component and SSP metachema.
* Fixed website side navigation. Added component and SSP metaschema to site generation process.
* Addressed comments in issue usnistgov#445
* Added site content generation to runall.sh
* Started documenting model changes in release notes. More work is still needed to complete this.
@david-waltermire
Copy link
Contributor

This has been completed in PR #464.

bradh pushed a commit to bradh/OSCAL that referenced this issue Dec 4, 2019
@david-waltermire @bradh
Implementation refactor plus sprint22 metaschema (usnistgov#464)
3d5bd57 
* Supporting enumerated value lists on flags in XSD and JSON Schema usnistgov#437
* Metaschema improvements and remodeling flags support (local definitions; moving w/in the model; valid values)
* More Metaschema syntax remodeling: now using max-occurs and min-occurs for cardinality indicators usnistgov#441
* Updating schemas to current model (transitional); updated docs in resulting XSD per usnistgov#448; some updates to markdown documentation
* Small updates to authoring CSS.
* Added design notes on JSON schema bindings.
* Including an initial set of unit tests for group-by, some data types, etc.
* Updated to new design (usnistgov#436): Metaschema schema, Schematron, metaschema update XSLT - will break the build for now
* Work on datatyping usnistgov#436 including support in XML and JSON Schema
* Addressed usnistgov#451: parameter insertion syntax in Markdown
* Schema documentation improvements usnistgov#423 usnistgov#424 usnistgov#428
* Addressed feature request usnistgov#438
* Improving handling of JSON 'key' and 'value-key' settings in docs usnistgov#428
* Now producing XML and JSON model maps from metaschemas.
* Now escaping {{ for Jekyll
* Updated component metaschema based on design notes
* Fixed schematron assertions to properly work with @ref.
* Refactoring of component and SSP metachema.
* Fixed website side navigation. Added component and SSP metaschema to site generation process.
* Addressed comments in issue usnistgov#445
* Added site content generation to runall.sh
* Started documenting model changes in release notes. More work is still needed to complete this.
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jan 25, 2023
@david-waltermire
Implementation refactor plus sprint22 metaschema (usnistgov#464)
662c7bc 
* Supporting enumerated value lists on flags in XSD and JSON Schema usnistgov#437
* Metaschema improvements and remodeling flags support (local definitions; moving w/in the model; valid values)
* More Metaschema syntax remodeling: now using max-occurs and min-occurs for cardinality indicators usnistgov#441
* Updating schemas to current model (transitional); updated docs in resulting XSD per usnistgov#448; some updates to markdown documentation
* Small updates to authoring CSS.
* Added design notes on JSON schema bindings.
* Including an initial set of unit tests for group-by, some data types, etc.
* Updated to new design (usnistgov#436): Metaschema schema, Schematron, metaschema update XSLT - will break the build for now
* Work on datatyping usnistgov#436 including support in XML and JSON Schema
* Addressed usnistgov#451: parameter insertion syntax in Markdown
* Schema documentation improvements usnistgov#423 usnistgov#424 usnistgov#428
* Addressed feature request usnistgov#438
* Improving handling of JSON 'key' and 'value-key' settings in docs usnistgov#428
* Now producing XML and JSON model maps from metaschemas.
* Now escaping {{ for Jekyll
* Updated component metaschema based on design notes
* Fixed schematron assertions to properly work with @ref.
* Refactoring of component and SSP metachema.
* Fixed website side navigation. Added component and SSP metaschema to site generation process.
* Addressed comments in issue usnistgov#445
* Added site content generation to runall.sh
* Started documenting model changes in release notes. More work is still needed to complete this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wendellpiez wendellpiez

Labels
enhancement Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Website Issues targeted at the OSCAL project website. User Story
Projects
None yet
Milestone
OSCAL 1.0 Milestone 2
Development

No branches or pull requests
2 participants
@wendellpiez @david-waltermire