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

Feature improve documentation #329

Merged
merged 43 commits into from
Jun 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
c736559
- Relocated data types into their own file for easier maintenance.
david-waltermire Mar 9, 2023
75beaaa
added documentation around whitespace restrictions to make clear how …
david-waltermire Mar 10, 2023
a7ad9fa
Cleaned up and simplified the terminology.
david-waltermire Mar 10, 2023
c38f07d
Refactored and made terminology more internally consistent.
david-waltermire Mar 29, 2023
430b963
Aligned tutorial with updated terminology.
david-waltermire Mar 29, 2023
94f2947
Moved content out of the overview page into use.
david-waltermire Mar 29, 2023
efb6c81
WIP syntax specification updates.
david-waltermire Mar 31, 2023
5816cdb
Initial commit of a complete computer build example.
david-waltermire Apr 4, 2023
2843e9a
Improve documentation around the regex dialects used in the data types.
david-waltermire Apr 5, 2023
389454e
Continued work on the specification.
david-waltermire Apr 5, 2023
726dd62
Removed many OSCAL references.
david-waltermire Apr 5, 2023
380a0b6
Added discussion of collapse groups.
david-waltermire Apr 6, 2023
7b2bce3
Continued work on the specification. Mostly through the define-assemb…
david-waltermire Apr 7, 2023
1e992cc
Further development of the Metaschema specification. Foxus on instances.
david-waltermire Apr 17, 2023
9b090a6
Apply suggestions from code review
david-waltermire Apr 18, 2023
7a03127
More progress on the instance section of the specification.
david-waltermire Apr 21, 2023
e065354
Apply suggestions from code review
david-waltermire Apr 21, 2023
7b4033a
Wrapped most terminology in italics.
david-waltermire May 5, 2023
733cc99
Fixed an invalid data type.
david-waltermire May 5, 2023
82d4a73
Reorganized specification pages into smaller sections.
david-waltermire May 8, 2023
db8cb17
Further work on the instance and inline definition sections.
david-waltermire May 9, 2023
83494f4
Integrate new work towards a USWDS 3.x Hugo theme.
david-waltermire May 10, 2023
8707ece
Completed a first pass through all reorganized specification content.…
david-waltermire May 12, 2023
981bd62
More refinements and additions to the spec.
david-waltermire May 12, 2023
df9c329
Adding missing files.
david-waltermire May 12, 2023
06fd72b
Adjusted and weighted TODOs for prioritization of work going forward.
david-waltermire May 12, 2023
7e3bae7
More work on the syntax index.
david-waltermire May 16, 2023
91d15fe
Apply suggestions from code review
david-waltermire May 16, 2023
7b198a9
Addressing review feedback.
david-waltermire May 16, 2023
6d76d3c
Made minor adjustments to code review edits.
david-waltermire May 16, 2023
ec15c84
Adding NPM files.
david-waltermire May 16, 2023
e310f20
Configured dart-sass to be installed on Hugo build.
david-waltermire May 16, 2023
791c2e9
Had to relocate the package.json, etc to project root to make Hugo po…
david-waltermire May 16, 2023
b0269f6
Adjusting package-lock.json path.
david-waltermire May 16, 2023
d8d57a4
Adjustments for new USWDS theme revision.
david-waltermire May 18, 2023
2cee2d6
Adjusted site to use latest USWDS theme.
david-waltermire Jun 1, 2023
f39b262
Apply suggestions from code review
david-waltermire Jun 1, 2023
de7674e
Cleaned up some extra unneeded files and corrected some content that …
david-waltermire Jun 1, 2023
e6c461a
Apply suggestions from code review
david-waltermire Jun 1, 2023
f9e0534
Fixed missing type in script tags.
david-waltermire Jun 1, 2023
6872726
Adding back element map CSS for the specification index.
david-waltermire Jun 2, 2023
4ef217f
Apply suggestions from code review
david-waltermire Jun 2, 2023
ceb86e9
Apply suggestions from code review
david-waltermire Jun 2, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
david-waltermire marked this conversation as resolved.
Show resolved Hide resolved
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
david-waltermire marked this conversation as resolved.
Show resolved Hide resolved

go 1.18

Expand Down
Loading