Skip to content

Commit

Permalink
Feature improve documentation (#329)
Browse files Browse the repository at this point in the history
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
david-waltermire authored Jun 2, 2023
1 parent 7008554 commit 8f3d51e
Show file tree
Hide file tree
Showing 62 changed files with 4,572 additions and 981 deletions.
2 changes: 1 addition & 1 deletion .github/CONTENTS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OSCAL GitHub Supporting Files
# GitHub Files

This directory contains supporting files for Metaschema GitHub repository use. The structure and contents of the directory are as follows:

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OSCAL GitHub Issue Template Files
# GitHub Issue Template Files

This directory contains templates for creating new project issues in GitHub. The structure and contents of the directory are as follows:

Expand Down
1 change: 0 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ updates:
target-branch: "develop"

- package-ecosystem: "npm"
directory: "/build"
schedule:
interval: "daily"
target-branch: "develop"
26 changes: 23 additions & 3 deletions .github/workflows/workflow-generate-website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,31 @@ jobs:
go-version-file: '${{ env.BUILD_PATH }}/go.mod'
cache: true
cache-dependency-path: '${{ env.BUILD_PATH }}/go.sum'
- name: Set up NodeJS
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
with:
node-version-file: 'build/.nvmrc'
cache: 'npm'
cache-dependency-path: 'package-lock.json'
- name: Setup Dependencies
run: |
# NodeJS
# If you are a developer and need to modify the workflow, be sure to review
# the package.json and package-lock.json to ensure the following deps are
# at least installed (they will be updated by dependabot):
# - ajv-cli
# - ajv-formats
# - markdown-link-check
# - yaml-convert
npm install --loglevel verbose
echo "$PWD/node_modules/.bin/" >> $GITHUB_PATH
- name: Install Hugo
if: steps.cache-hugo.outputs.cache-hit != 'true'
run: |
cd "${{ env.BUILD_PATH }}"
go install -tags "extended" github.com/gohugoio/hugo
- name: Install Dart Sass Embedded
run: sudo snap install dart-sass-embedded
- name: Run Hugo
run: |
hugo --config "config.yaml,development-config.yaml" -v --debug --minify
Expand Down Expand Up @@ -169,7 +189,7 @@ jobs:
enable_jekyll: false
publish_dir: ./website/public
publish_branch: nist-pages
commit_user_name: OSCAL GitHub Actions Bot
commit_user_email: oscal@nist.gov
commit_author: OSCAL GitHub Actions Bot <oscal@nist.gov>
commit_user_name: GitHub Actions Bot
commit_user_email: metaschema@nist.gov
commit_author: GitHub Actions Bot <metaschema@nist.gov>
commit_message: Deploying website [ci deploy skip]
3 changes: 1 addition & 2 deletions .github/workflows/workflow-validate-repo-markdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,10 @@ jobs:
with:
node-version-file: 'build/.nvmrc'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
cache-dependency-path: 'package-lock.json'
- name: Setup Dependencies
run: |
# NodeJS
cd "${{ github.workspace }}/build"
# If you are a developer and need to modify the workflow, be sure to review
# the package.json and package-lock.json to ensure the following deps are
# at least installed (they will be updated by dependabot):
Expand Down
11 changes: 5 additions & 6 deletions .gitignore
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/
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at oscal@nist.gov. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at metaschema@nist.gov. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Expand Down
2 changes: 1 addition & 1 deletion build/go.mod
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

Expand Down
Loading

0 comments on commit 8f3d51e

Please sign in to comment.