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

Docs redesign (#16) #3

Closed
wants to merge 1 commit into from

Conversation

wendellpiez
Copy link
Owner

  • Clean up and prep for fresh run of schema documentation into new site configuration
  • Fresh run of catalog schema docs
  • Configuration changes towards site preview, with cleanup
  • Pulling autogenerated docs from .gitignore (for testing)
  • Adding placeholder files back for navigation
  • Adding new layout file
  • Fixed small bug in subnav production
  • WIP towards splitting XML- and JSON-oriented documentation
  • Rearranging docs results
  • Now adding JSON docs in a separate collection (subdirectory) - still WIP
  • Moving generated documentation for handling by Jekyll
  • Latest efforts at site navigation reconfiguration
  • Navigation is functional again
  • Further along towards presentable schema docs - crosslinks and working nav
  • Updated element-map XSLT producing an element map from a metaschema (towards a navigation widget) - also adding missing markdown home pages for JSON schema docs
  • Now added links from properties (elements/attributes) to the objects (elements) that may contain them.
  • More improvements; also exposing a bug in XML formatting (in schema docs examples)
  • Adding new page for OSCAL prose
  • Improvements to content
  • Small changes to header and contents
  • More small edits to content
  • Renamed resource
  • More adjustments to contents; code presentation adjustment in XML schema docs
  • More touchups on docs (prose)
  • Preventing Jekyll from double-escaping code blocks
  • Many changes to copy, and some to organization, responding to internal review.

Committer Notes

This PR shows changes to navigation and content of Preview site.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

* Clean up and prep for fresh run of schema documentation into new site configuration

* Fresh run of catalog schema docs

* Configuration changes towards site preview, with cleanup

* Pulling autogenerated docs from .gitignore (for testing)

* Adding placeholder files back for navigation

* Adding new layout file

* Fixed small bug in subnav production

* WIP towards splitting XML- and JSON-oriented documentation

* Rearranging docs results

* Now adding JSON docs in a separate collection (subdirectory) - still WIP

* Moving generated documentation for handling by Jekyll

* Latest efforts at site navigation reconfiguration

* Navigation is functional again

* Further along towards presentable schema docs - crosslinks and working nav

* Updated element-map XSLT producing an element map from a metaschema (towards a navigation widget) - also adding missing markdown home pages for JSON schema docs

* Now added links from properties (elements/attributes) to the objects (elements) that may contain them.

* More improvements; also exposing a bug in XML formatting (in schema docs examples)

* Adding new page for OSCAL prose

* Improvements to content

* Small changes to header and contents

* More small edits to content

* Renamed resource

* More adjustments to contents; code presentation adjustment in XML schema docs

* More touchups on docs (prose)

* Preventing Jekyll from double-escaping code blocks

* Many changes to copy, and some to organization, responding to internal review.
@wendellpiez wendellpiez closed this Apr 2, 2019
wendellpiez added a commit that referenced this pull request Jun 4, 2019
wendellpiez pushed a commit that referenced this pull request Jun 6, 2019
Remove some JSON testing custom code and pip installs for Python in favor of AJV-CLI.  Added XPath to the XML comparison code. Testing for XMLDIFF.

Remove Unnecessary Python Libraries

No longer using several external libraries

Minor Updates

FIxed git ignores
Changed from -v check to something more compatible

Updates to Testing

Remove some JSON testing custom code and pip installs for Python in favor of AJV-CLI.  Added XPath to the XML comparison code. Testing for XMLDIFF.

Minor Updates

FIxed git ignores
Changed from -v check to something more compatible

Bash Generalization

Fixed the -v statements to use a more portable -z statement.

Added Exit Code Logic to XML Round Trip Comparison

Refactor XML Comparison

Removes XMLDiff

Adds exit code to the Python code, does error count tracking

Test Content Converer Fix

XML RoundTrip in Run All Tests

Round Trip XML->JSON->XML

Working for all NIST 800-53 checks (FedRAMP currently bombing)

Color Output

Printf messages are now color coded for improved readability in large log files

Temp Directory

Round trip files now written to the Temp directory, this directory added to build artifacts in CI/CD

Rename Temporal Files

Build files for roundtrip now carry their base naming conventions for troubleshooting

Add Roundtrip Check to CI/CD

Initial Attempt

Fix CI/CD Bug

Typo on base image

Local JAR

Trying to get it working end to end with local file

Dynamic Paths

Fix CI/CD bug finding Python/Saxon scripts

PIP Installs

Python Import Error Fix

UTF Encoding

Refactor Python

Get etree.parse to work in CI/CD

Shorten FileNames

Build Artifacts

Use the supplied build directory

Troubleshoot Artifacts

Dynamic JAR

Dynamic JAR 2

Maven Install

Adds Maven to the Circle CI image

Maven Attempt #2

Class Path Refactor

Refactor CI/CD

Faster build time

CI/CD Bug Fix

Fix Path Error

Copy Build Artifacts

Copy Artifacts Attempt #2

Artifact Try #3

Artifact Attempt #4

Copy Step

Artifacts #5

Fix Tab

Artifact #6

Artifact #7

Artifact #8

Artifact #9

Initial JSON Roundtrip

Remove Diff

Updates to Testing

Remove some JSON testing custom code and pip installs for Python in favor of AJV-CLI.  Added XPath to the XML comparison code. Testing for XMLDIFF.

Minor Updates

FIxed git ignores
Changed from -v check to something more compatible

Updates to Testing

Remove some JSON testing custom code and pip installs for Python in favor of AJV-CLI.  Added XPath to the XML comparison code. Testing for XMLDIFF.

Bash Generalization

Fixed the -v statements to use a more portable -z statement.

Added Exit Code Logic to XML Round Trip Comparison

Refactor XML Comparison

Removes XMLDiff

Adds exit code to the Python code, does error count tracking

Test Content Converer Fix

XML RoundTrip in Run All Tests

Round Trip XML->JSON->XML

Working for all NIST 800-53 checks (FedRAMP currently bombing)

Color Output

Printf messages are now color coded for improved readability in large log files

Temp Directory

Round trip files now written to the Temp directory, this directory added to build artifacts in CI/CD

Rename Temporal Files

Build files for roundtrip now carry their base naming conventions for troubleshooting

Add Roundtrip Check to CI/CD

Initial Attempt

Fix CI/CD Bug

Typo on base image

Local JAR

Trying to get it working end to end with local file

Dynamic Paths

Fix CI/CD bug finding Python/Saxon scripts

PIP Installs

Python Import Error Fix

UTF Encoding

Refactor Python

Get etree.parse to work in CI/CD

Shorten FileNames

Build Artifacts

Use the supplied build directory

Troubleshoot Artifacts

Dynamic JAR

Dynamic JAR 2

Maven Install

Adds Maven to the Circle CI image

Maven Attempt #2

Class Path Refactor

CI/CD Bug Fix

Fix Path Error

Copy Build Artifacts

Copy Artifacts Attempt #2

Artifact Try #3

Artifact Attempt #4

Copy Step

Artifact #7

Artifact #8

Artifact #9

Initial JSON Roundtrip

Remove Diff

Merge with Master

CI/CD Fix #2

CI/CD Fix #4

CI/CD Fix #5

CI/CD Fix #6
wendellpiez pushed a commit that referenced this pull request Jul 19, 2022
* added links for videos ofr workshop #3
* updated info for the July 2022 OSCAL mini worksop
* Update docs/content/learn/presentations/mini-workshop/_index.md

Co-authored-by: Alexander Stein <alexander.stein@nist.gov>
wendellpiez pushed a commit that referenced this pull request Aug 26, 2022
* Updating OSCAL mini workshop #3
* updated Nov 30 presentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant