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

Schema documentation should link to the schema location #438

Closed
2 tasks
david-waltermire opened this issue Jun 18, 2019 · 3 comments
Closed
2 tasks

Schema documentation should link to the schema location #438

david-waltermire opened this issue Jun 18, 2019 · 3 comments
Assignees
@wendellpiez @david-waltermire
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

@david-waltermire
Copy link
Contributor

User Story:

As an OSCAL schema user, I need to be able to find the XML or JSON schema that corresponds to the schema documentation I am reading.

Goals:

The Metaschema-based schema documentation generation pipeline needs to allow for a link to the actual schema to be provided in the format-specific schema docs. Ideally, this link can be passed in as a parameter to the documentation generator. This will allow for the CI/CD pipeline to choose a suitable location.

Dependencies:

None.

Acceptance Criteria

  • All generated XML and JSON schema documentation created by the CI/CD pipeline include a link to their respective schema.
  • A single PR is approved that contains the above changes.
@david-waltermire david-waltermire added enhancement User Story Scope: Metaschema Issues targeted at the metaschema pipeline Scope: Website Issues targeted at the OSCAL project website. labels Jun 18, 2019
@wendellpiez
Copy link
Contributor

This is presently hard wired to work for catalog and profile schemas (only), both XML and JSON.

To complete this feature request, the dynamic assignment of $schema-path in the XSLT produce-and-run-either-documentor.xsl should be removed, and the values passed in at runtime instead (in the script build/ci-cd/generate-model-documentation.sh).

wendellpiez added a commit to wendellpiez/OSCAL that referenced this issue Jul 23, 2019
@wendellpiez
Now addressing feature request usnistgov#438
a845876
@david-waltermire
Copy link
Contributor Author

This will be closed once PR #464 is pulled.

david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
Now addressing feature request usnistgov#438
ecb26ec
david-waltermire pushed a commit to david-waltermire/OSCAL that referenced this issue Aug 16, 2019
@wendellpiez @david-waltermire
Now addressing feature request usnistgov#438
f1bc4e4
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 Author

This has been addressed 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

@david-waltermire david-waltermire

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