-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature improve documentation (#329)
Data type improvements: - Relocated data types into their own file for easier maintenance. - Updated data types to ensure consistency between specification and implementation. - Identify locations of data type schemas in data type specifications. Documentation Improvements: - Discuss use of regular expression dialects used in XML and JSON schema. #235 - Improved documentation around the regex dialects used in the data types. - Added documentation around whitespace restrictions to make clear how the data type implementations restrict leading and trailing whitespace. - Cleaned up and simplified the terminology. - Refactored and made terminology more internally consistent. - Aligned tutorial with updated terminology. - Moved some content out of the overview page into use case page. - Fixed inconsistencies in the tutorial. - Added a complete computer build example. - Removed many OSCAL references. - Added discussion of collapse groups. - Wrapped most terminology in italics. - Improved introduction section and terminology consistency. - Added the following sections: - Conventions Used in this Document: Discusses use of capitalized requirement words. - Graph Theoretical Basis of Metaschema: Discusses how a Metaschema module represents a graph. - Object-Oriented Basis of Metaschema: Discusses how a Metaschema module describes OO classes. - Reorganized specification pages into smaller sections. - Added a syntax outline that better supports reference navigation into the specification. - Some TODO markers remain for work that needs to be completed in a future PR. Publishing an incomplete specification to encourage more review of current materials. Other Improvements: - Integrated new work towards a USWDS 3.x Hugo theme. - Adding NPM files. Added NodeJS setup to website build. - Configured dart-sass to be installed on Hugo build. Had to relocate the package.json, etc to project root to make Hugo postcss work. - Cleaned up some extra unneeded files and corrected some content that was left in error. --------- Co-authored-by: Wendell Piez <[email protected]> Co-authored-by: A.J. Stein <[email protected]>
- Loading branch information
1 parent
7008554
commit 8f3d51e
Showing
62 changed files
with
4,572 additions
and
981 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,17 @@ | ||
# IDE configuration files | ||
*.xpr | ||
|
||
# Files generated by Hugo | ||
# Files generated by Hugo and related tools | ||
/website/resources | ||
/website/public | ||
|
||
# files generated by bundler | ||
/website/.bundle | ||
/website/vendor | ||
/website/.hugo_build.lock | ||
# htmltest | ||
/website/tmp | ||
|
||
|
||
# other generated files | ||
nohup.out | ||
/toolchains/xslt-M4/validate/xspec/metaschema-composition-schematron-result.html | ||
|
||
# Ignore NodeJS modules | ||
node_modules/ | ||
node_modules/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
module github.com/usnistgov/OSCAL/build | ||
module github.com/usnistgov/metaschema/build | ||
|
||
go 1.18 | ||
|
||
|
Oops, something went wrong.