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

Docs redesign #9

Merged
merged 185 commits into from
Mar 5, 2019
Merged

Docs redesign #9

merged 185 commits into from
Mar 5, 2019

Conversation

howieavp76
Copy link

Committer Notes

Refreshing my version to Wendall's to allow us to start the XSL transformation workflow.

All Submissions:

  • [ x] Have you followed the guidelines in our Contributing document?
  • [ x] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • [x ] Have you squashed any non-relevant commits and commit messages? [instructions]

Changes to Core Features:

  • [ x] Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?

@bbattaglini
Create Readme.md
2362a9a
@bbattaglini
Create readme.md
992369d
@bbattaglini
Add files via upload
d8f93a8
@bbattaglini
Add files via upload
704c390
@bbattaglini
Add files via upload
1c0793a
@bbattaglini
Add files via upload
965a0d2
@bbattaglini
Add files via upload
fdd5956
@bbattaglini
Add files via upload
3807a09
@bbattaglini
Add files via upload
144759a
@bbattaglini
Delete DesignElements.md
31a3c3a
@bbattaglini
Add files via upload
90497f5
@bbattaglini
Update Design Elements.md
2f07073
@bbattaglini
Add files via upload
f2f9ea7
@bbattaglini
Update Design Elements.md
7dcc439
@bbattaglini
Update Landing Page.md
02e2827
@bbattaglini
Update Landing Page.md
9022d4b
@bbattaglini
Update Landing Page.md
9492fbd
@bbattaglini
Update Roadmap.md
4eda979
@bbattaglini
Update Roadmap.md
80c917f
@bbattaglini
Update Roadmap.md
c5300ea
@bbattaglini
Update Roadmap.md
63e5d66
@bbattaglini
Add files via upload
bf2c0ed
@bbattaglini
Update Design Elements.md
dcedecf
@bbattaglini
Update Design Elements.md
b94c817
@bbattaglini
Update Case Studies.md
a0058fb
@bbattaglini
Update Case Studies.md
78de10d
@bbattaglini
Update Case Studies.md
aaf921a
@bbattaglini
Update Case Studies.md
4f715eb
@bbattaglini
Update Case Studies.md
d67d122
@bbattaglini
Update Overview.md
119d92c
wendellpiez and others added 25 commits February 20, 2019 14:36
@wendellpiez
On XML and JSON examples, now emulating mockup with hooks for Jekyll/…
51589ec 
…uswds CSS and scripting
@wendellpiez
More enhancements to schema docs
cbc8f3b
@wendellpiez
Adding catalog schema docs as HTML fragments
a3fca33
@wendellpiez
Testing documentation handling
7acf608
@wendellpiez
Testing documentation; metaschema Schematron adjustment
66c50f2
@wendellpiez
Adding YAML header to top level file
3952ed6
@wendellpiez
Reverting back to safer version
2119c7d
@wendellpiez
Now including docs for elements included in metaschemas via import fr…
ca654c2 
…om other metaschemas (35 new files) usnistgov#286 usnistgov#314
@wendellpiez
Provided descriptive YAML headers to HTML outputs from metaschema doc…
58b9958 
…s production for Jekyll integration.
@wendellpiez
New file set in correct subdirectory for Jekyll
7d03cc6
Merge branch 'docs-wip' of https://github.com/wendellpiez/OSCAL into …
5871b04 
…wendellpiez-docs-wip
@wendellpiez
Removing extraneous file left from debugging
79a51b2
@wendellpiez
Removing diagnostic output from metaschema docs generation
fff3915
@wendellpiez
Corrected production of header id for navigation
f10ad36
@wendellpiez
Providing some simple tagging for syntax coloring over XML literals
3c0c30e
@wendellpiez
Improvements to representation of samples in schema docs, now to use …
c595c44 
…Jekyll syntax highlighting.
Merge branch 'docs-wip' of https://github.com/wendellpiez/OSCAL into …
5f98c98 
…wendellpiez-docs-wip
@wendellpiez
Moving the documentation outputs to a path for Jekyll
8e50e14
@wendellpiez
More corrections to samples serializations
cf3e73e
Merge branch 'docs-wip' of https://github.com/wendellpiez/OSCAL into …
67d9243 
…wendellpiez-docs-wip
merge split html from metaschema
85d3c85
JSON prettify block
52ef065
Initial Schema Formatting
1cdb031
css changes
4401bed
css changes
9f3c809
@anweiss anweiss merged commit ef1e5a9 into anweiss:master Mar 5, 2019
anweiss added a commit that referenced this pull request Mar 5, 2019
@anweiss
Revert "Docs redesign (#9)"
9598ed8 
This reverts commit ef1e5a9.
anweiss added a commit that referenced this pull request Mar 5, 2019
@anweiss
Revert 9 docs redesign (#11)
93f202e 
* Feature metaschema d2 next (usnistgov#277)

* Patched with changes from feature-metaschema-d2
* Moving testing schema into schema/demo dir for more robust testing of (portable, replicable) metaschema infrastructure
* Cleanup and refactoring metaschema production for demo
* Patched with changes from feature-metaschema-d2
* Cleanup and refactoring metaschema production for demo
* More adjustments and documentation of metaschema
* Adjustments to metaschema notes doc
* Now supporting namespace assignment per metaschema
* Better support for modular metaschemas
* Metaschema support for namespaces, acquired (imported) models
* Scrubbing old prose modules
* Metaschema XML documentation now respecting namespaces in XML artifacts
* Minor tweaks to comments
* More improvements in view of namespaces. JSON examples not yet working.
* Better handling of examples now
* Removing unneeded test files
* Correcting syntax error
* Adjustments in demo metaschema
* Added draft metadata to SP800-53 profiles; also new SP800-53 catalog with (draft) metadata.
* Adding Markdown-conversion and JSON-handling code
* 'Hardening' markdown conversion
* Adding placeholder files for new catalog and profile metaschemas with namespace support - nb namespaces assigned have not been changed. But namespace support in the metaschema infrastructure can be tested.
* Cleaning up catalog and profile schemas (with namespaces) and examples
* Updated demo schema readme
* Tighter co-occurrence testing

* Docs redesign (#9)

* Create Readme.md

* Create readme.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Delete DesignElements.md

* Add files via upload

* Update Design Elements.md

* Add files via upload

* Update Design Elements.md

* Update Landing Page.md

* Update Landing Page.md

* Update Landing Page.md

* Update Roadmap.md

* Update Roadmap.md

* Update Roadmap.md

* Update Roadmap.md

* Add files via upload

* Update Design Elements.md

* Update Design Elements.md

* Update Case Studies.md

* Update Case Studies.md

* Update Case Studies.md

* Update Case Studies.md

* Update Case Studies.md

* Update Overview.md

* Update Overview.md

* Update Landing Page.md

* Update Roadmap.md

* Update Roadmap.md

* Add files via upload

* Update Design Elements.md

* Update Design Elements.md

* Update Design Elements.md

* Update Design Elements.md

* Update Overview.md

* Update Roadmap.md

* Update Overview.md

* Update Overview.md

* Update Overview.md

* Add files via upload

* Add files via upload

* Add files via upload

* Delete OSCAL_ContentPage_Sample.png

* Update Landing Page.md

* Update Landing Page.md

* Update Content Page.md

* Update Content Page.md

* Update Content Page.md

* Update Products.md

* Update Products.md

* Update Products.md

* Add files via upload

* Update Design Elements.md

* Update Case Studies.md

* Add files via upload

* Delete Products.md

* Delete Roadmap.md

* Update Design Elements.md

* Add files via upload

* Add files via upload

* Update Landing Page.md

* Update Overview.md

* Add files via upload

* Update Get Involved.md

* Update Get Involved.md

* Update Get Involved.md

* Update Get Involved.md

* Update Design Elements.md

* Add files via upload

* Update Design Elements.md

* Update Design Elements.md

* Update Design Elements.md

* Update Design Elements.md

* Delete OSCAL_Logo1.png

* Delete OSCAL_Logo2.png

* Delete OSCAL_Logo3.png

* Delete OSCAL_Logo4.png

* Add files via upload

* Update Design Elements.md

* Delete OSCAL_Logo1.png

* Delete OSCAL_Logo2.png

* Add files via upload

* Delete OSCAL_Logo1.png

* Add files via upload

* Update Readme.md

* Update Get Involved.md

* Rename Case Studies.md to Case Study.md

* Update Case Study.md

* Update Scenario.md

* Update Producer.md

* Update Producer.md

* Update Consumer.md

* Update Consumer.md

* Update Get Involved.md

* Update Producer.md

* Update Consumer.md

* Update Producer.md

* Delete Design Elements.md

* Update Get Involved.md

* Update Consumer.md

* Update Producer.md

* Add files via upload

* Add files via upload

* Update Contact.md

* Update Contact.md

* Update Consumer.md

* Update Producer.md

* Update and rename Overview.md to LearnMore.md

* Rename LearnMore.md to Learn More.md

* Update Contact.md

* Update Contact.md

* Update Learn More.md

* Create Schemas.md

* Update Schemas.md

* Update Schemas.md

* Update Schemas.md

* Create Producer Examples.md

* Update Schemas.md

* Delete Content Page.md

* Update and rename Producer Examples.md to Consumer Examples.md

* Update Scenario.md

* Update Scenario.md

* Delete Landing Page.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Feature metaschema d2 next (usnistgov#277)

* Patched with changes from feature-metaschema-d2
* Moving testing schema into schema/demo dir for more robust testing of (portable, replicable) metaschema infrastructure
* Cleanup and refactoring metaschema production for demo
* Patched with changes from feature-metaschema-d2
* Cleanup and refactoring metaschema production for demo
* More adjustments and documentation of metaschema
* Adjustments to metaschema notes doc
* Now supporting namespace assignment per metaschema
* Better support for modular metaschemas
* Metaschema support for namespaces, acquired (imported) models
* Scrubbing old prose modules
* Metaschema XML documentation now respecting namespaces in XML artifacts
* Minor tweaks to comments
* More improvements in view of namespaces. JSON examples not yet working.
* Better handling of examples now
* Removing unneeded test files
* Correcting syntax error
* Adjustments in demo metaschema
* Added draft metadata to SP800-53 profiles; also new SP800-53 catalog with (draft) metadata.
* Adding Markdown-conversion and JSON-handling code
* 'Hardening' markdown conversion
* Adding placeholder files for new catalog and profile metaschemas with namespace support - nb namespaces assigned have not been changed. But namespace support in the metaschema infrastructure can be tested.
* Cleaning up catalog and profile schemas (with namespaces) and examples
* Updated demo schema readme
* Tighter co-occurrence testing

* docs redesign prototype

* add Docker artifacts for dev

* volume mount quotes

* walkthrough prototype

* add walkthrough page

* use official nist header and foot

* initial refactor based on new site map

* site nav prototyping

* oscalkit addition

* Test

* fix sidenav and schema ref

* Early version JSON-docs production from metaschema

* Removed unwanted namespace declarations from XML samples

* Removed unwanted namespace declaration from XML samples

* Experiments with serialization of XML literals in JSON from XSLT pipeline

* Travis website updates (#3)

* Website Updates - Splash Page

* fix sidenav and schema ref

* Updates based on initial NIST feedback (#4)

* relationship page per Wendell (#5)

* Setting up metaschema documentation -- HTML feed for Jekyll

* Improved serialization on working example

* Improved serialization

* Now added uswds tables

* Now including JSON examples

* On XML and JSON examples, now emulating mockup with hooks for Jekyll/uswds CSS and scripting

* More enhancements to schema docs

* Adding catalog schema docs as HTML fragments

* Testing documentation handling

* Testing documentation; metaschema Schematron adjustment

* Adding YAML header to top level file

* Reverting back to safer version

* Now including docs for elements included in metaschemas via import from other metaschemas (35 new files) usnistgov#286 usnistgov#314

* Provided descriptive YAML headers to HTML outputs from metaschema docs production for Jekyll integration.

* New file set in correct subdirectory for Jekyll

* Removing extraneous file left from debugging

* Removing diagnostic output from metaschema docs generation

* Corrected production of header id for navigation

* Providing some simple tagging for syntax coloring over XML literals

* Improvements to representation of samples in schema docs, now to use Jekyll syntax highlighting.

* Moving the documentation outputs to a path for Jekyll

* More corrections to samples serializations

* merge split html from metaschema

* JSON prettify block

* Initial Schema Formatting

* css changes

* Revert "Docs redesign (#9)"

This reverts commit ef1e5a9.
anweiss added a commit that referenced this pull request Apr 9, 2019
@anweiss
Revert 9 docs redesign (#11)
afe1f54 
* Feature metaschema d2 next (usnistgov#277)

* Patched with changes from feature-metaschema-d2
* Moving testing schema into schema/demo dir for more robust testing of (portable, replicable) metaschema infrastructure
* Cleanup and refactoring metaschema production for demo
* Patched with changes from feature-metaschema-d2
* Cleanup and refactoring metaschema production for demo
* More adjustments and documentation of metaschema
* Adjustments to metaschema notes doc
* Now supporting namespace assignment per metaschema
* Better support for modular metaschemas
* Metaschema support for namespaces, acquired (imported) models
* Scrubbing old prose modules
* Metaschema XML documentation now respecting namespaces in XML artifacts
* Minor tweaks to comments
* More improvements in view of namespaces. JSON examples not yet working.
* Better handling of examples now
* Removing unneeded test files
* Correcting syntax error
* Adjustments in demo metaschema
* Added draft metadata to SP800-53 profiles; also new SP800-53 catalog with (draft) metadata.
* Adding Markdown-conversion and JSON-handling code
* 'Hardening' markdown conversion
* Adding placeholder files for new catalog and profile metaschemas with namespace support - nb namespaces assigned have not been changed. But namespace support in the metaschema infrastructure can be tested.
* Cleaning up catalog and profile schemas (with namespaces) and examples
* Updated demo schema readme
* Tighter co-occurrence testing

* Docs redesign (#9)

* Create Readme.md

* Create readme.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Delete DesignElements.md

* Add files via upload

* Update Design Elements.md

* Add files via upload

* Update Design Elements.md

* Update Landing Page.md

* Update Landing Page.md

* Update Landing Page.md

* Update Roadmap.md

* Update Roadmap.md

* Update Roadmap.md

* Update Roadmap.md

* Add files via upload

* Update Design Elements.md

* Update Design Elements.md

* Update Case Studies.md

* Update Case Studies.md

* Update Case Studies.md

* Update Case Studies.md

* Update Case Studies.md

* Update Overview.md

* Update Overview.md

* Update Landing Page.md

* Update Roadmap.md

* Update Roadmap.md

* Add files via upload

* Update Design Elements.md

* Update Design Elements.md

* Update Design Elements.md

* Update Design Elements.md

* Update Overview.md

* Update Roadmap.md

* Update Overview.md

* Update Overview.md

* Update Overview.md

* Add files via upload

* Add files via upload

* Add files via upload

* Delete OSCAL_ContentPage_Sample.png

* Update Landing Page.md

* Update Landing Page.md

* Update Content Page.md

* Update Content Page.md

* Update Content Page.md

* Update Products.md

* Update Products.md

* Update Products.md

* Add files via upload

* Update Design Elements.md

* Update Case Studies.md

* Add files via upload

* Delete Products.md

* Delete Roadmap.md

* Update Design Elements.md

* Add files via upload

* Add files via upload

* Update Landing Page.md

* Update Overview.md

* Add files via upload

* Update Get Involved.md

* Update Get Involved.md

* Update Get Involved.md

* Update Get Involved.md

* Update Design Elements.md

* Add files via upload

* Update Design Elements.md

* Update Design Elements.md

* Update Design Elements.md

* Update Design Elements.md

* Delete OSCAL_Logo1.png

* Delete OSCAL_Logo2.png

* Delete OSCAL_Logo3.png

* Delete OSCAL_Logo4.png

* Add files via upload

* Update Design Elements.md

* Delete OSCAL_Logo1.png

* Delete OSCAL_Logo2.png

* Add files via upload

* Delete OSCAL_Logo1.png

* Add files via upload

* Update Readme.md

* Update Get Involved.md

* Rename Case Studies.md to Case Study.md

* Update Case Study.md

* Update Scenario.md

* Update Producer.md

* Update Producer.md

* Update Consumer.md

* Update Consumer.md

* Update Get Involved.md

* Update Producer.md

* Update Consumer.md

* Update Producer.md

* Delete Design Elements.md

* Update Get Involved.md

* Update Consumer.md

* Update Producer.md

* Add files via upload

* Add files via upload

* Update Contact.md

* Update Contact.md

* Update Consumer.md

* Update Producer.md

* Update and rename Overview.md to LearnMore.md

* Rename LearnMore.md to Learn More.md

* Update Contact.md

* Update Contact.md

* Update Learn More.md

* Create Schemas.md

* Update Schemas.md

* Update Schemas.md

* Update Schemas.md

* Create Producer Examples.md

* Update Schemas.md

* Delete Content Page.md

* Update and rename Producer Examples.md to Consumer Examples.md

* Update Scenario.md

* Update Scenario.md

* Delete Landing Page.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Update Learn More.md

* Feature metaschema d2 next (usnistgov#277)

* Patched with changes from feature-metaschema-d2
* Moving testing schema into schema/demo dir for more robust testing of (portable, replicable) metaschema infrastructure
* Cleanup and refactoring metaschema production for demo
* Patched with changes from feature-metaschema-d2
* Cleanup and refactoring metaschema production for demo
* More adjustments and documentation of metaschema
* Adjustments to metaschema notes doc
* Now supporting namespace assignment per metaschema
* Better support for modular metaschemas
* Metaschema support for namespaces, acquired (imported) models
* Scrubbing old prose modules
* Metaschema XML documentation now respecting namespaces in XML artifacts
* Minor tweaks to comments
* More improvements in view of namespaces. JSON examples not yet working.
* Better handling of examples now
* Removing unneeded test files
* Correcting syntax error
* Adjustments in demo metaschema
* Added draft metadata to SP800-53 profiles; also new SP800-53 catalog with (draft) metadata.
* Adding Markdown-conversion and JSON-handling code
* 'Hardening' markdown conversion
* Adding placeholder files for new catalog and profile metaschemas with namespace support - nb namespaces assigned have not been changed. But namespace support in the metaschema infrastructure can be tested.
* Cleaning up catalog and profile schemas (with namespaces) and examples
* Updated demo schema readme
* Tighter co-occurrence testing

* docs redesign prototype

* add Docker artifacts for dev

* volume mount quotes

* walkthrough prototype

* add walkthrough page

* use official nist header and foot

* initial refactor based on new site map

* site nav prototyping

* oscalkit addition

* Test

* fix sidenav and schema ref

* Early version JSON-docs production from metaschema

* Removed unwanted namespace declarations from XML samples

* Removed unwanted namespace declaration from XML samples

* Experiments with serialization of XML literals in JSON from XSLT pipeline

* Travis website updates (#3)

* Website Updates - Splash Page

* fix sidenav and schema ref

* Updates based on initial NIST feedback (#4)

* relationship page per Wendell (#5)

* Setting up metaschema documentation -- HTML feed for Jekyll

* Improved serialization on working example

* Improved serialization

* Now added uswds tables

* Now including JSON examples

* On XML and JSON examples, now emulating mockup with hooks for Jekyll/uswds CSS and scripting

* More enhancements to schema docs

* Adding catalog schema docs as HTML fragments

* Testing documentation handling

* Testing documentation; metaschema Schematron adjustment

* Adding YAML header to top level file

* Reverting back to safer version

* Now including docs for elements included in metaschemas via import from other metaschemas (35 new files) usnistgov#286 usnistgov#314

* Provided descriptive YAML headers to HTML outputs from metaschema docs production for Jekyll integration.

* New file set in correct subdirectory for Jekyll

* Removing extraneous file left from debugging

* Removing diagnostic output from metaschema docs generation

* Corrected production of header id for navigation

* Providing some simple tagging for syntax coloring over XML literals

* Improvements to representation of samples in schema docs, now to use Jekyll syntax highlighting.

* Moving the documentation outputs to a path for Jekyll

* More corrections to samples serializations

* merge split html from metaschema

* JSON prettify block

* Initial Schema Formatting

* css changes

* Revert "Docs redesign (#9)"

This reverts commit ef1e5a9.
anweiss pushed a commit that referenced this pull request Sep 4, 2019
@wendellpiez @david-waltermire
Cleanup of models and data (usnistgov#476)
0153500 
* Schematron now reports duplicate definitions in a Metaschema as an error: see usnistgov#465, usnistgov#475

* Catalog metaschema and SP800-53 catalog adjustments renaming 'subcontrol' to 'control' per Issue usnistgov#473

* Refactored metaschemas to avoid definition clashes; more/better Schematron to detect such clashes

* Adding new module now required by catalog and profile metaschemas

* Revising profiles to be valid to newly revised schema (no more references to subcontrol elements only controls)

* Bug fix in Metaschema Schematron

* Delete FedRAMP_HIGH-baseline_profile.xml

* Delete FedRAMP_LOW-baseline_profile.xml

* Delete FedRAMP_MODERATE-baseline_profile.xml

* Create temp.txt

* Revised FedRAMP Profiles

These files include revisions to the FedRAMP baselines, plus a small FedRAMP catalog that provides three subcontrols added by FedRAMP.

* Delete temp.txt

* moved updated fedramp content to correct location

* New and improved FedRAMP profiles

* Repaired broken markdown conversion; added missing title content to FedRAMP catalog

* add note about b -> strong and i -> em (#9)

* Changed inline markup in FedRAMP profiles for lossless conversion

* One more adjustment in Markdown->XML conversion (images)

* One more time (cleaning up cleanup)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@howieavp76 @anweiss @bbattaglini @wendellpiez