Initial commit

.github/workflows/LinkChecker.yml

@@ -0,0 +1,23 @@
+on:
+  push:
+    branches:
+      - main  # Set the branch you want to trigger the workflow on
+  schedule:
+    - cron: "0 0 1 * *"
+  workflow_dispatch:
+name: Check markdown links
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v1
+        with:
+          args: ./docs/**
+      - name: Create Issue From File
+        uses: peter-evans/create-issue-from-file@v2
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue

.github/workflows/deploy.yml

@@ -0,0 +1,69 @@
+name: mkdocs_build_deploy
+
+on:
+  push:
+    branches:
+      - main  # Set the branch you want to trigger the workflow on
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8  # Choose the Python version you need
+
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: |
+          ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/*.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install mkdocs mkdocs-material pymdown-extensions
+
+    - name: Build MkDocs
+      run: mkdocs build --clean
+
+    - name: Create and force push to documentation branch
+      run: |
+        git config user.name "${{ github.actor }}"
+        git config user.email "${{ github.actor }}@users.noreply.github.com"
+        
+        # Your existing script to force push to the documentation branch
+
+        
+        git fetch --all
+    
+        # Check if there are any local changes
+        if [ -n "$(git status --porcelain)" ]; then
+        # If there are changes, commit them
+        git add .
+        git commit -m "Committing local changes before switching branches"
+        else
+        echo "No local changes to commit."
+        fi
+
+        git checkout production
+
+        # Remove files and directories from the production branch
+        git rm -r --ignore-unmatch */*
+
+        git checkout main -- site
+
+
+        # git mv site docs
+        git add -A
+        git commit -m "Content update"
+
+        git push 

.github/workflows/staticpublish.yml

@@ -0,0 +1,38 @@
+name: Deploy static content to Pages
+
+on:
+  workflow_run:
+    workflows: 
+      - mkdocs_build_deploy
+    types:
+      - completed
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: production  # Specify the branch you want to deploy
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: 'site'  # Specify the folder you want to deploy
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v3

.gitignore

@@ -0,0 +1,132 @@
+.DS_Store
+*/.DS_Store
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

CNAME

@@ -0,0 +1 @@
+wiki.mipcvs.dev

README.md

@@ -0,0 +1,54 @@
+# mipcvs-wiki
+
+[![MkDocs Build + Deploy](https://github.com/WCRP-CMIP/mipcvs-wiki/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/WCRP-CMIP/mipcvs-wiki/actions/workflows/deploy.yml) [![Deploy static content to Pages](https://github.com/WCRP-CMIP/mipcvs-wiki/actions/workflows/staticpublish.yml/badge.svg)](https://github.com/WCRP-CMIP/mipcvs-wiki/actions/workflows/staticpublish.yml)
+
+
+Contents for the MIPCVs wiki. See [wiki.mipcvs.dev](https://wiki.mipcvs.dev/)
+
+---
+
+## What? 
+This repository updates the wiki for CV updates. It contains infomration that will be used to inform the submission process and caviats in relation to this. The intuitive markdown format and open source (github repo) format allow relevant leads and users to update the documentation in real time.
+
+The files within here consist of a nested structure on markdown files, that may be downloaded and distributed with the software. These can be found within the `docs` folder. T
+
+A secondary technical wiki outlining how to change the intircasies of mkdoc and other tools will be available at developer.mipcvs.dev. 
+
+
+---
+
+## Editing the documentation.
+    Docmentation is found in the `docs` folder with the file names and hierarchy affecting the navigational menu. 
+
+### Editing materials. 
+
+- menu/page name is determined by the `#` header tag at the top of a file. 
+
+
+## Resources
+### Demo files and structure: 
+    https://github.com/selfhostedshow/wiki/tree/master
+### Permissable items
+    https://squidfunk.github.io/mkdocs-material/reference/admonitions/
+
+
+
+
+## developer notes
+The following are Notes and will be tidied away in due course. 
+
+https://squidfunk.github.io/mkdocs-material/getting-started/
+
+
+
+### install
+`docker pull squidfunk/mkdocs-material`
+
+### creating a site. Dont run.
+`docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material new .`
+
+### preview 
+`docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
+
+### build 
+`docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build`