Add preview container

.github/workflows/new-preview-container.yml

@@ -0,0 +1,35 @@
+name: Build and Push Docker Image
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    if: startsWith(github.repository, 'osg-htc/')
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+        ref: master                              # Needed or it will checkout the wrong commit
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Log in to OSG Harbor
+      uses: docker/login-action@v1
+      with:
+        registry: hub.opensciencegrid.org
+        username: ${{ secrets.OSG_HARBOR_ROBOT_USER }}
+        password: ${{ secrets.OSG_HARBOR_ROBOT_PASSWORD }}
+
+    - name: Build and push Docker images
+      uses: docker/[email protected]
+      with:
+        context: .
+        push: true
+        tags: "hub.opensciencegrid.org/osg-portal-documentation:latest"

.github/workflows/update-documentation.yml

@@ -0,0 +1,83 @@
+name: Update the documentation website
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+
+jobs:
+
+  Update-Submodules:
+    runs-on: ubuntu-latest
+    if: startsWith(github.repository, 'osg-htc/')
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+        fetch-depth: 0
+
+    - name: Pull, Merge, Push submodules
+      run: |
+        git config --global user.name "GitHub Actions"
+        git config --global user.email "[email protected]"
+
+        git submodule update --remote --merge
+
+        if [ -n "$(git status --porcelain)" ]; then 
+          git add .
+          git commit -m "Update Documentation"
+          git push
+        else
+          echo "no changes";
+        fi
+
+  Build-Static-Site:
+    runs-on: ubuntu-latest
+    if: startsWith(github.repository, 'osg-htc/')
+    needs: Update-Submodules
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: 'recursive'
+
+      - name: Initialize GH User
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "[email protected]"
+
+      - name: Update the Submodule pulled
+        run: |
+          git submodule update --recursive --remote
+
+      - name: Build MkDocs pages
+        if: startsWith(github.repository, 'osg-htc/')
+        uses: docker://squidfunk/mkdocs-material:8.2.8
+        with:
+          args: >-
+            build
+            --verbose
+
+      - name: Deploy to 'static' branch
+        run: |
+          # Commit the build then use 'git subtree' to create a branch with just the site contents
+          git add site -f
+          git commit -m "Build Static HTML"
+          git checkout -b static `git subtree split --prefix site master`
+
+          # Push to Production
+          git push --set-upstream origin static --force
+
+  Trigger-New-Documentation-Release:
+    runs-on: ubuntu-latest
+    if: startsWith(github.repository, 'osg-htc/')
+    needs: [Build-Static-Site, Update-Submodules]
+    env:
+      OWNER: "osg-htc"
+      REPO: "osg-portal"
+      WORKFLOW_ID: "release-documentation-update.yml"
+    steps:
+      - name: Trigger Documentation Release
+        run: |
+          curl -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer ${{ secrets.REPO_ACCESS_TOKEN }}" https://api.github.com/repos/${{env.OWNER}}/${{env.REPO}}/actions/workflows/${{env.WORKFLOW_ID}}/dispatches -d '{"ref":"master"}'

.github/workflows/validate-mkdocs.yml

@@ -0,0 +1,40 @@
+name: Validate static MkDocs pages
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  validate-mkdocs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: 'recursive'
+      - name: Build MkDocs pages
+        uses: docker://squidfunk/mkdocs-material:8.2.8
+        timeout-minutes: 1
+        with:
+          args: >-
+            build
+            --verbose
+            --strict
+
+      - id: format-github-repo
+        run: echo "::set-output name=repo-name::${GITHUB_REPOSITORY#*\/}"
+
+      - name: Test links
+        timeout-minutes: 10
+        uses: docker://klakegg/html-proofer:3.16.0
+        env:
+          GITHUB_REPOSITORY: ${{ github.repository }}
+        with:
+          args: >-
+            --allow-hash-href
+            --check-html
+            --http-status-ignore 302
+            ./documentation

.gitmodules

@@ -1,96 +1,99 @@
 [submodule "tutorials/tutorial-AutoDockVina"]
-	path = tutorials/tutorial-AutoDockVina
+	path = docs/software_examples_for_osg/drug_discovery/tutorial-AutoDockVina
 	url = https://github.com/OSGConnect/tutorial-AutoDockVina
 [submodule "tutorials/tutorial-R"]
-	path = tutorials/tutorial-R
+	path = docs/software_examples_for_osg/r/tutorial-R
 	url = https://github.com/OSGConnect/tutorial-R
 [submodule "tutorials/tutorial-R-addlibSNA"]
-	path = tutorials/tutorial-R-addlibSNA
+	path = docs/software_examples_for_osg/r/tutorial-R-addlibSNA
 	url = https://github.com/OSGConnect/tutorial-R-addlibSNA
 [submodule "tutorials/tutorial-ScalingUp-R"]
-	path = tutorials/tutorial-ScalingUp-R
+	path = docs/software_examples_for_osg/r/tutorial-ScalingUp-R
 	url = https://github.com/OSGConnect/tutorial-ScalingUp-R
 [submodule "tutorials/tutorial-blast"]
-	path = tutorials/tutorial-blast
+	path = docs/tutorials/tutorial-blast
 	url = https://github.com/OSGConnect/tutorial-blast
 [submodule "tutorials/tutorial-error101"]
-	path = tutorials/tutorial-error101
+	path = docs/managing_htc_workloads_on_osg_connect/submitting_htc_workloads_with_htcondor/tutorial-error101
 	url = https://github.com/OSGConnect/tutorial-error101
 [submodule "tutorials/tutorial-exitcode"]
-	path = tutorials/tutorial-exitcode
+	path = docs/tutorials/tutorial-exitcode
 	url = https://github.com/OSGConnect/tutorial-exitcode
 [submodule "tutorials/tutorial-gromacs"]
-	path = tutorials/tutorial-gromacs
+	path = docs/tutorials/tutorial-gromacs
 	url = https://github.com/OSGConnect/tutorial-gromacs
 [submodule "tutorials/tutorial-htcondor-transfer"]
-	path = tutorials/tutorial-htcondor-transfer
+	path = docs/tutorials/tutorial-htcondor-transfer
 	url = https://github.com/OSGConnect/tutorial-htcondor-transfer
 [submodule "tutorials/tutorial-makeflow-quickstart"]
-	path = tutorials/tutorial-makeflow-quickstart
+	path = docs/tutorials/tutorial-makeflow-quickstart
 	url = https://github.com/OSGConnect/tutorial-makeflow-quickstart
 [submodule "tutorials/tutorial-matlab-HelloWorld"]
-	path = tutorials/tutorial-matlab-HelloWorld
+	path = docs/software_examples_for_osg/matlab_runtime/tutorial-matlab-HelloWorld
 	url = https://github.com/OSGConnect/tutorial-matlab-HelloWorld
 [submodule "tutorials/tutorial-namd"]
-	path = tutorials/tutorial-namd
+	path = docs/tutorials/tutorial-namd
 	url = https://github.com/OSGConnect/tutorial-namd
 [submodule "tutorials/tutorial-nelle-nemo"]
-	path = tutorials/tutorial-nelle-nemo
+	path = docs/tutorials/tutorial-nelle-nemo
 	url = https://github.com/OSGConnect/tutorial-nelle-nemo
 [submodule "tutorials/tutorial-octave"]
-	path = tutorials/tutorial-octave
+	path = docs/tutorials/tutorial-octave
 	url = https://github.com/OSGConnect/tutorial-octave
 [submodule "tutorials/tutorial-pegasus"]
-	path = tutorials/tutorial-pegasus
+	path = docs/managing_htc_workloads_on_osg_connect/automated_workflows/tutorial-pegasus
 	url = https://github.com/OSGConnect/tutorial-pegasus
 [submodule "tutorials/tutorial-photodemo"]
-	path = tutorials/tutorial-photodemo
+	path = docs/tutorials/tutorial-photodemo
 	url = https://github.com/OSGConnect/tutorial-photodemo
 [submodule "tutorials/tutorial-python-virtualenv"]
-	path = tutorials/tutorial-python-virtualenv
+	path = docs/tutorials/tutorial-python-virtualenv
 	url = https://github.com/OSGConnect/tutorial-python-virtualenv
 [submodule "tutorials/tutorial-quickstart"]
-	path = tutorials/tutorial-quickstart
+	path = docs/managing_htc_workloads_on_osg_connect/submitting_htc_workloads_with_htcondor/tutorial-quickstart
 	url = https://github.com/OSGConnect/tutorial-quickstart
 [submodule "tutorials/tutorial-root"]
-	path = tutorials/tutorial-root
+	path = docs/tutorials/tutorial-root
 	url = https://github.com/OSGConnect/tutorial-root
 [submodule "tutorials/tutorial-scaling"]
-	path = tutorials/tutorial-scaling
+	path = docs/tutorials/tutorial-scaling
 	url = https://github.com/OSGConnect/tutorial-scaling
 [submodule "tutorials/tutorial-scaling-up-resources"]
-	path = tutorials/tutorial-scaling-up-resources
+	path = docs/tutorials/tutorial-scaling-up-resources
 	url = https://github.com/OSGConnect/tutorial-scaling-up-resources
 [submodule "tutorials/tutorial-software"]
-	path = tutorials/tutorial-software
+	path = docs/tutorials/tutorial-software
 	url = https://github.com/OSGConnect/tutorial-software
 [submodule "tutorials/tutorial-stash-http"]
-	path = tutorials/tutorial-stash-http
+	path = docs/tutorials/tutorial-stash-http
 	url = https://github.com/OSGConnect/tutorial-stash-http
 [submodule "tutorials/tutorial-stashcache-blast"]
-	path = tutorials/tutorial-stashcache-blast
+	path = docs/tutorials/tutorial-stashcache-blast
 	url = https://github.com/OSGConnect/tutorial-stashcache-blast
 [submodule "tutorials/tutorial-swift"]
-	path = tutorials/tutorial-swift
+	path = docs/tutorials/tutorial-swift
 	url = https://github.com/OSGConnect/tutorial-swift
 [submodule "tutorials/tutorial-osg-locations"]
-	path = tutorials/tutorial-osg-locations
+	path = docs/managing_htc_workloads_on_osg_connect/submitting_htc_workloads_with_htcondor/tutorial-osg-locations
 	url = https://github.com/OSGConnect/tutorial-osg-locations
 [submodule "tutorials/tutorial-ScalingUp-Python"]
-	path = tutorials/tutorial-ScalingUp-Python
+	path = docs/software_examples_for_osg/python/tutorial-ScalingUp-Python
 	url = https://github.com/OSGConnect/tutorial-ScalingUp-Python
 [submodule "tutorials/tutorial-blast-split"]
-	path = tutorials/tutorial-blast-split
+	path = docs/software_examples_for_osg/bioinformatics/tutorial-blast-split
 	url = https://github.com/OSGConnect/tutorial-blast-split
 [submodule "tutorials/tutorial-tensorflow-containers"]
-	path = tutorials/tutorial-tensorflow-containers
+	path = docs/software_examples_for_osg/machine_learning/tutorial-tensorflow-containers
 	url = https://github.com/OSGConnect/tutorial-tensorflow-containers.git
 [submodule "tutorials/tutorial-wordfreq"]
-	path = tutorials/tutorial-wordfreq
+	path = docs/software_examples_for_osg/python/tutorial-wordfreq
 	url = https://github.com/OSGConnect/tutorial-wordfreq
 [submodule "tutorials/tutorial-bwa"]
-	path = tutorials/tutorial-bwa
+	path = docs/software_examples_for_osg/bioinformatics/tutorial-bwa
 	url = https://github.com/OSGConnect/tutorial-bwa
 [submodule "tutorials/tutorial-organizing"]
-	path = tutorials/tutorial-organizing
+	path = docs/managing_htc_workloads_on_osg_connect/submitting_htc_workloads_with_htcondor/tutorial-organizing
 	url = https://github.com/OSGConnect/tutorial-organizing
+[submodule "user-documentation"]
+	path = user-documentation
+	url = https://github.com/osg-htc/user-documentation.git

Dockerfile

@@ -0,0 +1,14 @@
+FROM squidfunk/mkdocs-material:latest
+
+COPY user-documentation/scripts/requirements.txt /tmp/requirements.txt
+RUN pip3 install -r /tmp/requirements.txt
+
+ADD images/ /docs/images
+ADD overrides/ /docs/overrides
+COPY mkdocs.yml /docs/
+
+COPY scripts/entrypoint.sh /entrypoint.sh
+RUN chmod 755 /entrypoint.sh
+
+ENTRYPOINT ["sh", "/entrypoint.sh"]
+CMD ["serve", "--dev-addr=0.0.0.0:8000"]

README.md

@@ -1,12 +1,49 @@
-![](https://github.com/osgconnect/connectbook/workflows/Publish%20to%20Freshdesk/badge.svg)
+[![Validate static MkDocs pages](https://github.com/osg-htc/osg-portal-documentation/actions/workflows/validate-mkdocs.yml/badge.svg)](https://github.com/osg-htc/osg-portal-documentation/actions/workflows/validate-mkdocs.yml)
 
-The OSG ConnectBook
+# Mkdocs Static Website 
 
-Be sure to clone recursively!
+If you are here to edit something you are likely in the wrong place. 
 
-git clone --recursive https://github.com/OSGConnect/connectbook.git
+To edit the OSG Portal look here -> https://github.com/osg-htc/osg-portal
 
+To edit User Documentation look here -> https://github.com/osg-htc/user-documentation
 
-To update the submodules run
+## For the Minority
 
-git submodule foreach git pull origin master
+This repository hosts the code for building the static Mkdocs website that is hosted at portal.osg-htc.org/documentation. 
+
+All new commits to master are built into a static site found on the ```static``` branch, which is then pulled into the osg-portal.
+
+Changes you should be making here include:
+- HTML Templates
+
+**There is 0 reason to touch the ```./user-documentation``` folder from this repo** 
+
+If you are looking to change the following look in [here](https://github.com/osg-htc/user-documentation):
+- CSS
+- Documentation
+- Website Layout
+
+### Development
+
+```shell
+docker run --rm -it -p 8001:8001 -v ${PWD}:/docs squidfunk/mkdocs-material
+```
+
+ARM
+```shell
+docker run --rm -it -p 8000:8000 -v  ${PWD}:/docs ghcr.io/afritzler/mkdocs-material
+```
+
+### Test Links Locally
+
+```shell
+# Build the site into /site directory
+docker run --rm -v  ${PWD}:/docs ghcr.io/afritzler/mkdocs-material build
+
+# Test the links
+docker run --rm -it \
+  -v $(pwd)/documentation:/src \
+  klakegg/html-proofer:3.19.2 \
+  --allow-hash-href --check-html --empty-alt-ignore --disable-external
+```