Pages site with CSX demos (#20)

* Adding start at oXygen resources see usnistgov/OSCAL#652
* Basic setup; some CSS
* Update to M3 models: touched XSLTs where needed to handle `uuid` where needed in place of `id`. usnistgov/OSCAL#689
* Removing early oXygen stuff for later
* Minor update to inline link handling
* CSX demonstration migration from wendellpiez/XMLjellysandwich repository
* Initial sketch of Pages site under Hugo with live demonstrations (rough cut)
* Updating demonstrations and site docs
* Initial commit of uswds Hugo git module
* Working copies of CSX demos and prototypes (maintenance versions)
* Adding Validator demo runtime
* Reorganization and archiving
* Tuning and updating Baseline Matrix
* Updating top-level README.md
* Adding more ideas for longer term projects, test and sample files
* More docs improvements
* Several enhancements to Hugo docs
* More readme touchups
* More page and site nav touchups
* Removing misplaced file sets
* Renamed demo wip
* Misc adjustments including page banner, About page
* Updating dev runtimes
* Added draft banner to head.html
* Adding web site deployment configuration

.github/workflows/website-deploy.yml

@@ -0,0 +1,81 @@
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/website-deploy.yml'
+  workflow_dispatch:
+    branches:
+      - main
+name: Publish Website
+env:
+  # the name of the repo
+  HOME_REPO: usnistgov/oscal-tools
+  HOME_BRANCH: main
+  # dependency versions
+  HUGO_VERSION: 0.83.1
+  # build-specific environment
+  OSCAL_HOME: git-content/oscal-tools
+  OSCAL_WEBSITE_PATH: git-content/oscal-tools/docs
+jobs:
+  build-and-publish-website:
+    name: Build and Publish Website
+    runs-on: ubuntu-20.04
+    steps:
+      # use this for main repo builds on branches
+      - name: Checkout main branch
+        uses: actions/checkout@v2
+        if: ${{ github.repository == env.HOME_REPO && github.ref == format('refs/heads/{0}',env.HOME_BRANCH) }}
+        with:
+          path: ${{ env.OSCAL_HOME }}
+          submodules: recursive
+          token: ${{ secrets.COMMIT_TOKEN }}
+      - name: Get latest from repo
+        if: ${{ github.repository == env.HOME_REPO && github.event_name == 'push' }}
+        # This will ensure that any files committed by the previous job, will be updated
+        run: |
+          git pull --ff-only
+        working-directory: ${{ env.OSCAL_HOME }}
+      # Setup runtime environment
+      # -------------------------
+      # Operating System packages
+      - name: Update APT package metadata
+        run: |
+          sudo rm -rf /var/lib/apt/lists/* && sudo apt-get update
+#      # Ruby and Bundler
+#      - name: Install Ruby and Bundler
+#        uses: ruby/setup-ruby@v1
+#        with:
+#          ruby-version: 2.6 # Not needed with a .ruby-version file
+#          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+#          working-directory: ${{ env.OSCAL_WEBSITE_PATH }}
+      # Install Hugo
+      - name: Install Hugo
+        run: |
+          wget https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_Linux-64bit.deb
+          sudo apt-get install ./hugo_extended_${HUGO_VERSION}_Linux-64bit.deb
+      - name: Run Hugo
+        run: |
+            cd "${OSCAL_WEBSITE_PATH}"
+            hugo -v --debug --minify
+      - name: Check internal links
+        uses: untitaker/[email protected]
+        with:
+          args: ${{ env.OSCAL_WEBSITE_PATH }}/public/ --sources ${{ env.OSCAL_WEBSITE_PATH }}/content --check-anchors
+      - uses: actions/upload-artifact@v2
+        with:
+          name: website
+          path: |
+            ${{ env.OSCAL_WEBSITE_PATH }}/public
+          retention-days: 5
+#      - name: Run HTMLProofer
+#        run: |
+#          cd "${OSCAL_WEBSITE_PATH}"
+#          bundle exec htmlproofer public/ --check-external-hash --url-swap "https\://pages.nist.gov/OSCAL/:/" --assume-extension --log-level :debug --url-ignore "\/reference\//,/pages.nist.gov\/(?:nist-header-footer|leaveNotice)\/.+/"
+      - name: Run deploy script
+        if: ${{ github.repository == env.HOME_REPO && github.ref == format('refs/heads/{0}',env.HOME_BRANCH) }}
+        run: |
+            cd "$OSCAL_WEBSITE_PATH"
+            git config user.name "Deployment Bot"
+            bash ./deploy.sh --push-only -v -m "Deploying website [ci deploy skip]"

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/themes/uswds"]
+	path = docs/themes/uswds
+	url = https://github.com/usnistgov/hugo-uswds.git

README.md

@@ -1,2 +1,7 @@
-# oscal-tools
-Tools for the OSCAL project
+# OSCAL Tools
+
+Tools supporting [OSCAL](http://pages.nist.gov/OSCAL), the Open Security Controls Assessment Language.
+
+See project subdirectories for more information per project.
+
+Also see the [OSCAL Tools site on NIST Pages](http://pages.nist.gov/oscal-tools), produced for this repository and hosting (or delivering) running demonstrations along with documentation.