Initial Version

FEoCMIP folder Caching of mkdocs in github action. Adding mermaids to mkdocs.yml
WCRP-CMIP · Feb 13, 2024 · 006e195 · 006e195
1 parent 53d92f0
commit 006e195
Show file tree

Hide file tree

Showing 84 changed files with 11,825 additions and 1 deletion.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.github/workflows/LinkChecker.yml b/.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
diff --git a/.github/workflows/deploy.yml b/.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 
diff --git a/.github/workflows/staticpublish.yml b/.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
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+wiki.mipcvs.dev
diff --git a/README.md b/README.md
@@ -1,2 +1,54 @@
 # mipcvs-wiki
-Contents for the MIPCVs wiki. See wiki.mipcvs.com
+
+[![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`
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/99_Acknowlegements.md b/docs/99_Acknowlegements.md
@@ -0,0 +1,86 @@
+# Acknowledgement
+
+The work within most repositories can be attributed to a large number of contributers. A collection of those involved can be found here. 
+
+
+## MIP CMOR Tables
+
+The repository content has been developed by climate and computer scientists representing the Coupled Model Intercomparison Project phase 6 (CMIP6) and earlier phases, including those from climate modeling groups and model intercomparison projects (MIPs) worldwide. A special mention to Dr. Martin Juckes from the UK Centre for Environmental Data Analysis ([CEDA](https://www.ceda.ac.uk/)) for leading efforts in the [CMIP6 Data Request](https://cmip6dr.github.io/Data_Request_Home/). The structure of repository content and tools required to maintain it was developed by climate and computer scientists from the Program for Climate Model Diagnosis and Intercomparison ([PCMDI](https://pcmdi.llnl.gov/)) at Lawrence Livermore National Laboratory ([LLNL](https://www.llnl.gov/)) and the [UK MetOffice](https://www.metoffice.gov.uk/), with assistance from colleagues at the Coupled Model Intercomparison Project International Project Office ([CMIP-IPO](https://wcrp-cmip.org/cmip-governance/project-office/)), the Deutsches Klimarechenzentrum ([DKRZ](https://www.dkrz.de/en/)) in Germany and the members of the Infrastructure for the European Network for Earth System Modelling ([IS-ENES](https://is.enes.org/)) consortium.
+
+This work is sponsored by the Regional and Global Model Analysis ([RGMA](https://climatemodeling.science.energy.gov/program/regional-global-model-analysis)) program of the Earth and Environmental Systems Sciences Division ([EESSD](https://science.osti.gov/ber/Research/eessd)) in the Office of Biological and Environmental Research ([BER](https://science.osti.gov/ber)) within the Department of Energy's ([DOE](https://www.energy.gov/)) Office of Science ([OS](https://science.osti.gov/)). The work at PCMDI is performed under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344.
+
+<p>
+    <img src="https://pcmdi.github.io/assets/PCMDI/100px-PCMDI-Logo-NoText-square-png8.png"
+         width="65"
+         style="margin-right: 30px"
+         title="Program for Climate Model Diagnosis and Intercomparison"
+         alt="Program for Climate Model Diagnosis and Intercomparison"
+    >&nbsp;
+    <img src="https://pcmdi.github.io/assets/DOE/480px-DOE_Seal_Color.png"
+         width="65"
+         style="margin-right: 30px"
+         title="United States Department of Energy"
+         alt="United States Department of Energy"
+    >&nbsp;
+    <img src="https://pcmdi.github.io/assets/LLNL/212px-LLNLiconPMS286-WHITEBACKGROUND.png"
+         width="65"
+         style="margin-right: 30px"
+         title="Lawrence Livermore National Laboratory"
+         alt="Lawrence Livermore National Laboratory"
+    >&nbsp;
+    <img src="https://pcmdi.github.io/assets/MetOffice/100px-Met_Office_LogoBLACK.png"
+         width="65"
+         style="margin-right: 30px"
+         title="UK Met Office"
+         alt="UK Met Office"
+    >&nbsp;
+    <img src="https://pcmdi.github.io/assets/CMIP/100px-CMIP_Logo_RGB_Positive-square-96dpi.png"
+         width="65"
+         style="margin-right: 30px"
+         title="Couple Model Intercomparison Project International Project Office"
+         alt="Couple Model Intercomparison Project International Project Office"
+    >
+</p>
+
+
+## CMIP6Plus CVS
+
+The repository content has been collected from many contributors representing the Coupled Model Intercomparison Project phase 6+ (CMIP6Plus), including those from climate modeling groups and model intercomparison projects (MIPs) worldwide. The structure of content and tools required to maintain it was developed by climate and computer scientists from the Coupled Model Intercomparison Project International Project Office ([CMIP-IPO](https://wcrp-cmip.org/cmip-governance/project-office/)), the Program for Climate Model Diagnosis and Intercomparison ([PCMDI](https://pcmdi.llnl.gov/)) at Lawrence Livermore National Laboratory ([LLNL](https://www.llnl.gov/)), and the [UK MetOffice](https://www.metoffice.gov.uk/), with assistance from colleagues at the UK Centre for Environmental Data Analysis ([CEDA](https://www.ceda.ac.uk/)), the Deutsches Klimarechenzentrum ([DKRZ](https://www.dkrz.de/en/)) in Germany and the members of the Infrastructure for the European Network for Earth System Modelling ([IS-ENES](https://is.enes.org/)) consortium.
+
+This work is sponsored by the Regional and Global Model Analysis ([RGMA](https://climatemodeling.science.energy.gov/program/regional-global-model-analysis)) program of the Earth and Environmental Systems Sciences Division ([EESSD](https://science.osti.gov/ber/Research/eessd)) in the Office of Biological and Environmental Research ([BER](https://science.osti.gov/ber)) within the Department of Energy's ([DOE](https://www.energy.gov/)) Office of Science ([OS](https://science.osti.gov/)). The work at PCMDI is performed under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344.
+
+<p>
+    <img src="https://pcmdi.github.io/assets/CMIP/100px-CMIP_Logo_RGB_Positive-square-96dpi.png"
+         width="65"
+         style="margin-right: 30px"
+         title="Couple Model Intercomparison Project International Project Office"
+         alt="Couple Model Intercomparison Project International Project Office"
+    >&nbsp;
+    <img src="https://pcmdi.github.io/assets/PCMDI/100px-PCMDI-Logo-NoText-square-png8.png"
+         width="65"
+         style="margin-right: 30px"
+         title="Program for Climate Model Diagnosis and Intercomparison"
+         alt="Program for Climate Model Diagnosis and Intercomparison"
+    >&nbsp;
+    <img src="https://pcmdi.github.io/assets/DOE/480px-DOE_Seal_Color.png"
+         width="65"
+         style="margin-right: 30px"
+         title="United States Department of Energy"
+         alt="United States Department of Energy"
+    >&nbsp;
+    <img src="https://pcmdi.github.io/assets/LLNL/212px-LLNLiconPMS286-WHITEBACKGROUND.png"
+         width="65"
+         style="margin-right: 30px"
+         title="Lawrence Livermore National Laboratory"
+         alt="Lawrence Livermore National Laboratory"
+    >&nbsp;
+    <img src="https://pcmdi.github.io/assets/MetOffice/100px-Met_Office_LogoBLACK.png"
+         width="65"
+         style="margin-right: 30px"
+         title="UK Met Office"
+         alt="UK Met Office"
+    >
+</p>
+
+## Wiki, Forms, Automations, and Infrastructure work. 
+CMIP IPO (Daniel Ellis), LLNL (Paul Durack), MOHC (Matthew Mizielinski)
diff --git a/docs/CMIP6Plus/.DS_Store b/docs/CMIP6Plus/.DS_Store
diff --git a/docs/CMIP6Plus/Automations/.DS_Store b/docs/CMIP6Plus/Automations/.DS_Store
diff --git a/docs/CMIP6Plus/Automations/gencv_action.md b/docs/CMIP6Plus/Automations/gencv_action.md
@@ -0,0 +1,80 @@
+# [Action] To run create_CV 
+
+The flow of the github action which run when a new commits are pushed to a branch. 
+
+```mermaid
+graph TD
+  style AA fill:#003366,stroke:#ffffff,stroke-width:2px;
+  style BB fill:#005cbf,stroke:#ffffff,stroke-width:2px;
+  style CC fill:#0078d4,stroke:#ffffff,stroke-width:2px;
+  style DD fill:#009be1,stroke:#ffffff,stroke-width:2px;
+  style EE fill:#00a8e8,stroke:#ffffff,stroke-width:2px;
+  style FF fill:#00adef,stroke:#ffffff,stroke-width:2px;
+  style GG fill:#33b8ff,stroke:#ffffff,stroke-width:2px;
+  style HH fill:#66c1ff,stroke:#ffffff,stroke-width:2px;
+  style II fill:#99ccff,stroke:#ffffff,stroke-width:2px;
+
+  A[Checkout Repository] -->|1. Checkout| B[Check if Run is Necessary]
+  B -->|2. Determine Necessity| C[Set Up Git]
+  C -->|3. Configure Git Settings| D[Set GIT Repo Environment Variables]
+  D -->|4. Set Environment Variables| E[Display GIT Environment Variables]
+  E -->|5. Display Variables| F[Print Latest Commit SHA]
+  F -->|6. Print SHA and Path| G[Run Python Check]
+  G -->|7. Execute Python Script| H[Write New CV]
+  H -->|8. Write and Commit if Necessary| I[End]
+
+  style A fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+  style B fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+  style C fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+  style D fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+  style E fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+  style F fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+  style G fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+  style H fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+  style I fill:#4CAF50,stroke:#ffffff,stroke-width:2px;
+
+  A -->|Begin Workflow| B
+  B -->|Determine Necessity based on Git History| C
+  C -->|Configure Git Settings| D
+  D -->|Set Environment Variables| E
+  E -->|Display Variables| F
+  F -->|Print Commit SHA and Path| G
+  G -->|Execute Python Script| H
+  H -->|Write and Commit if Necessary| I
+
+  subgraph AA
+    A
+  end
+
+  subgraph BB
+    B
+  end
+
+  subgraph CC
+    C
+  end
+
+  subgraph DD
+    D
+  end
+
+  subgraph EE
+    E
+  end
+
+  subgraph FF
+    F
+  end
+
+  subgraph GG
+    G
+  end
+
+  subgraph HH
+    H
+  end
+
+  subgraph II
+    I
+  end
+```