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

OSCAL model map revamp for M4 Metaschema #750

Closed
3 tasks done
wendellpiez opened this issue Sep 2, 2020 · 5 comments
Closed
3 tasks done

OSCAL model map revamp for M4 Metaschema #750

wendellpiez opened this issue Sep 2, 2020 · 5 comments

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented Sep 2, 2020

User Story:

With the Metaschema M4, models change. The model maps need to be updated.

See #725 on related documentation.

Goals:

Prototype code with updated model maps can be found in the Metaschema M4 implementation. It needs to be integrated into Hugo and tested to produce maps for the new Metaschema design.

Also, @adamb-kpmg in Gitter (OSCAL channel Aug 11 16:11) reported a bug we can repair.

Dependencies:

#721 and #724 must be complete for this work to proceed.

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.
@wendellpiez
Copy link
Contributor Author

wendellpiez commented Sep 16, 2020

Progress Sep 16

I took a look and made a couple of small changes. The outputs look good so far, but may require some adjustment when we integrate into Hugo.

In particular, we will need CSS something like this in order to support graceful collapse/expand using the HTML details element:

div.OM-map { font-family: monospace; font-weight: bold; margin-top: 1ex; margin-bottom: 0ex; margin-left: 2em }

div.OM-choice, div.OM-map { border-left: thin solid darkgrey; margin-top: 1ex; margin-bottom: 0ex; margin-left: 0ex; padding-left: 1em  }
         
.OM-entry { margin: 0.5ex }

div.OM-map p { margin: 0ex }

.OM-lit, .OM-cardinality, .OM-datatype { font-family: sans-serif; font-size: 80%; font-weight: normal }

.OM-datatype { font-style: italic; font-size: 70% }

.OM-map a { color: inherit; text-decoration: none }

.OM-map a:hover { text-decoration: underline }

details.OM-entry[open] > summary span.show-closed { display: none; }

Remaining effort on this is dependent on #721. Once we can see it fully styled in Hugo, we can touch up further as necessary.

@wendellpiez
Copy link
Contributor Author

wendellpiez commented Sep 24, 2020

Update Sep 24

This is stable; next step as noted above is to integrate into the Hugo site production, then proof and correct once more if necessary.

NB - when proofing, pay special attention to JSON grouping constructs including array, singleton-or-array, or by-key examples.

@wendellpiez
Copy link
Contributor Author

Update Nov 5 2020

Stable pending Hugo integration work. Will discuss with @david-waltermire-nist.

@wendellpiez
Copy link
Contributor Author

Update Dec 3 2020

Work continues; much progress. 90% done on revamp.

As with #725, I could use help from @david-waltermire-nist on git alignment.

@david-waltermire
Copy link
Contributor

This issue was addressed by PR #758.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants