Pushing to prod — Dec 12, 2024

.github/actions/demo-notebook/action.yml

@@ -23,12 +23,6 @@ runs:
         pip install fairlearn aequitas 
         pip install shap==0.44.1
 
-    - name: Check dependencies
-      shell: bash
-      run: |
-        pip install pycairo
-        pip check
-
     - name: Ensure .env file is available
       shell: bash
       id: find_env
@@ -48,4 +42,4 @@ runs:
           echo "Execute for intro_for_model_developers_EXECUTED.ipynb failed";
           cat render_errors.log;
           exit 1;
-          }
+          }

.github/actions/prod-notebook/action.yml

@@ -23,12 +23,6 @@ runs:
         pip install fairlearn aequitas 
         pip install shap==0.44.1
 
-    - name: Check dependencies
-      shell: bash
-      run: |
-        pip install pycairo
-        pip check
-
     - name: Ensure .env file is available
       shell: bash
       id: find_env

.github/actions/staging-notebook/action.yml

@@ -23,12 +23,6 @@ runs:
         pip install fairlearn aequitas 
         pip install shap==0.44.1
 
-    - name: Check dependencies
-      shell: bash
-      run: |
-        pip install pycairo
-        pip check
-
     - name: Ensure .env file is available
       shell: bash
       id: find_env

.github/workflows/deploy-docs-prod.yaml

@@ -17,6 +17,11 @@ jobs:
     steps:
       - name: Check out repository
         uses: actions/checkout@v2
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
 
       - name: Fetch Quarto
         uses: ./.github/actions/fetch-quarto

.github/workflows/deploy-docs-staging.yaml

@@ -17,6 +17,11 @@ jobs:
     steps:
       - name: Check out repository
         uses: actions/checkout@v2
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
 
       - name: Fetch Quarto
         uses: ./.github/actions/fetch-quarto

.github/workflows/validate-docs-site.yaml

@@ -17,6 +17,11 @@ jobs:
     - name: Check out repository
       uses: actions/checkout@v2
 
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
     - name: Fetch Quarto
       uses: ./.github/actions/fetch-quarto
 

internal/templates/_single-source.qmd

@@ -4,7 +4,7 @@
 <!-- VISIBLE IN USER GUIDES ONlY -->
 
 :::: {.content-visible unless-format="revealjs"}
-1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
+1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
 
 1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
 
@@ -16,7 +16,7 @@
 <!-- VISIBLE IN TRAINING SLIDES ONLY -->
 
 :::: {.content-hidden unless-format="revealjs"}
-1. In the left sidebar, click **{{< fa cubes >}} Model Inventory**.
+1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
 
 1. Select a model by clicking on it or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models).
 

internal/templates/tachyons-flexbox.qmd

@@ -2,8 +2,6 @@
 title: "Tachyons Flexbox"
 subtitle: "Template"
 search: false
-filters:
-  - tachyons
 ---
 
 <!-- LAYOUT FOR 2 COLUMNS USING TACHYONS FLEXBOX: https://tachyons.io/docs/layout/flexbox/ -->

internal/templates/videos/example.qmd

@@ -1,7 +1,5 @@
 ---
 title: "Tachyons quarto filter"
-filters:
-  - tachyons
 self-contained: true
 ---
 

internal/templates/videos/index.qmd

@@ -19,8 +19,6 @@ format:
 title-slide-attributes:
   data-background-color: "#083E44"
   data-background-image: "home-hero.svg"
-filters:
-  - tachyons
 ---
 
 # Intros for training modules

internal/testing/css-grid/tachyons-grid.qmd

@@ -2,8 +2,6 @@
 title: "Tachyons Grid"
 subtitle: "Testing page"
 search: false
-filters:
-  - tachyons
 ---
 
 ## Content template test

internal/testing/lightbox.qmd

@@ -3,8 +3,6 @@ title: "Lightbox gallery"
 lightbox: true
 subtitle: "CSS styling"
 search: false
-filters: 
-    - tachyons
 ---
 
 :::: {.flex .flex-wrap .justify-around}

site/404.qmd

@@ -2,8 +2,6 @@
 title: "inValidPage (404)"
 html:
   page-layout: full
-filters:
-  - tachyons
 ---
 
 ```{=html}

site/Makefile

@@ -51,6 +51,8 @@ notebooks:
 	@rm -rf $(DEST_DIR_NB)/code_sharing
 	@echo "Moving Quickstart notebook into the root of notebooks/ ..."
 	@if [ -f "$(DEST_DIR_NB)/code_samples/quickstart_customer_churn_full_suite.ipynb" ]; then mv $(DEST_DIR_NB)/code_samples/quickstart_customer_churn_full_suite.ipynb $(DEST_DIR_NB)/quickstart_customer_churn_full_suite.ipynb; fi
+	@echo "Copying _metadata.yml into notebooks/ ..."
+	@cp developer/_metadata.yml $(DEST_DIR_NB)/_metadata.yml
 	@echo "Zip up notebooks.zip ..."
 	@zip -r notebooks.zip $(DEST_DIR_NB) > /dev/null 2>&1
 
@@ -73,6 +75,8 @@ test-descriptions:
 	@rm -rf $(DEST_DIR_TESTS)
 	@mkdir -p $(DEST_DIR_TESTS)
 	@cp -r $(SRC_DIR)/build/_test_descriptions/validmind/tests/. $(DEST_DIR_TESTS)
+	@echo "Copying _metadata.yml into tests/ ..."
+	@cp developer/_metadata.yml $(DEST_DIR_TESTS)/_metadata.yml
 
 # Get all source files
 get-source: clean clone notebooks python-docs test-descriptions

site/_extensions/nrichers/preview/preview.lua

@@ -2,6 +2,7 @@
 
 -- Track if CSS has already been added to prevent duplication
 local css_added = false
+local skip_filter = false  -- Default: Do not skip
 
 -- Helper function to add a CSS file to the document header
 function add_css(doc)
@@ -12,8 +13,21 @@ function add_css(doc)
   end
 end
 
+-- Function to check metadata for `skip_preview`
+function Meta(meta)
+  -- Set `skip_filter` to true if `skip_preview` is set in the metadata
+  if meta.skip_preview and meta.skip_preview == true then
+    skip_filter = true
+  end
+end
+
 -- Main function to apply preview
 function Div(el)
+  -- If the filter is skipped, do nothing
+  if skip_filter then
+    return nil
+  end
+
   if el.classes:includes("preview") then
     -- Get the `source`, `target`, `width`, `height`, and `offset` attributes, with defaults if not specified
     local source = el.attributes.source or "index.qmd"
@@ -45,6 +59,11 @@ end
 
 -- Ensure CSS is added once per document
 function Pandoc(doc)
+  -- If the filter is skipped, do nothing
+  if skip_filter then
+    return doc
+  end
+
   add_css(doc)
   return doc
 end

site/_quarto-development.yml

@@ -1,4 +1,5 @@
 format:
   html:
     include-in-header: 
-      - environments/heap-development.html
+      - environments/heap-development.html
+      - zendesk-chat.html

site/_quarto-production.yml

@@ -1,4 +1,5 @@
 format:
   html:
     include-in-header: 
-      - environments/heap-production.html
+      - environments/heap-production.html
+      - zendesk-chat.html

site/_quarto-staging.yml

@@ -1,4 +1,5 @@
 format:
   html:
     include-in-header: 
-      - environments/heap-staging.html
+      - environments/heap-staging.html
+      - zendesk-chat.html

site/_quarto.yml

@@ -73,7 +73,48 @@ website:
         file: https://validmind.com/
         target: _blank
     right:
-      - text: "Login"
+      # HOME BUTTON FOR DEVELOPER & TRAINING SECTIONS
+      - text: "{{< fa house >}}"
+        file: index.qmd
+      # DOCUMENTATION MENU FOR DEVELOPER & TRAINING SECTIONS
+      - text: "{{< fa book-open >}} Documentation"
+        menu:
+        - text: "{{< fa circle-info >}} About {{< var vm.product >}}"
+          file: about/overview.qmd
+        - text: "{{< fa rocket >}} Get Started"
+          file: get-started/get-started.qmd
+        - text: "{{< fa circle-info >}} Guides"
+          file: guide/guides.qmd
+        - text: "{{< fa circle-question >}} FAQ"
+          file: faq/faq.qmd
+        - text: "{{< fa envelope-open-text >}} Support"
+          file: support/support.qmd
+        - text: "---"
+        - text:  "{{< fa cube >}} Developers"
+        - text: "{{< fa code >}} {{< var validmind.developer >}}"
+          file: developer/get-started-validmind-library.qmd
+        - text: "---"
+        - text:  "{{< fa graduation-cap >}} {{< var validmind.training >}}"
+        - text: "{{< fa building-columns >}} Training Courses"
+          file: training/training.qmd
+        - text: "---"
+        - text: "{{< fa square-check >}} validmind.com {{< fa external-link >}}"
+          file: https://validmind.com/
+          target: _blank
+      # TRAINING MENU FOR ACADEMY SECTION
+      - text: "{{< fa graduation-cap >}} Training"
+        menu:
+        - text: "{{< fa house >}} ValidMind Academy"
+          file: training/training.qmd
+        - text: "---"
+        - text:  "{{< fa building-columns >}} Fundamentals"
+        - text: "{{< fa gear >}} For Administrators"
+          file: training/administrator-fundamentals/administrator-fundamentals-register.qmd
+        - text: "{{< fa code >}} For Developers"
+          file: training/developer-fundamentals/developer-fundamentals-register.qmd
+        - text: "{{< fa user-check >}} For Validators"
+          file: training/validator-fundamentals/validator-fundamentals-register.qmd
+      - text: "Log In"
         menu:
           - text: "Public Internet"
           - text: "{{< var validmind.platform >}} · `US1` {{< fa right-to-bracket >}}"
@@ -129,6 +170,7 @@ website:
         - text: "---"
         - text: "Releases"
         # MAKE-RELEASE-NOTES-EMBED-MARKER
+        - releases/2024-dec-06/release-notes.qmd
         - releases/2024-oct-22/release-notes.qmd
         - releases/2024-sep-25/release-notes.qmd
         - releases/2024-sep-09/release-notes.qmd
@@ -391,4 +433,9 @@ format:
     link-external-newwindow: true
     link-external-icon: true
     callout-appearance: simple
-    link-external-filter: '^https:\/\/(docs\.validmind\.ai|docs-staging\.validmind\.ai|docs-demo\.vm\.validmind\.ai)\/.*'
+    link-external-filter: '^https:\/\/(docs\.validmind\.ai|docs-staging\.validmind\.ai|docs-demo\.vm\.validmind\.ai)\/.*'
+    lightbox: true
+
+filters:
+  - tachyons
+  - preview