Publishing changes from PR #359 onwards

.github/workflows/ai_explain.yaml

@@ -6,13 +6,13 @@ permissions:
 
 on:
   pull_request:
-    types: [opened, synchronize]
+    types: [review_requested]
 
 jobs:
   explain-pr:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
+      - name: Check out repository
         uses: actions/checkout@v3
 
       - name: Set up Python
@@ -32,4 +32,4 @@ jobs:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           GITHUB_REPOSITORY: ${{ github.repository }}
           GITHUB_REF: ${{ github.ref }}
-        run: python .github/workflows/ai_explain.py
+        run: python .github/workflows/ai_explain.py

.github/workflows/delete-pr-preview.yaml

@@ -16,4 +16,4 @@ jobs:
         run: aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID }} && aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY }} && aws configure set default.region us-east-1
 
       - name: Delete PR preview
-        run: aws s3 rm s3://${{ vars.S3_BUCKET_DEMO }}/site/pr_previews/${{ github.head_ref }}/ --recursive && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null
+        run: aws s3 rm s3://docs-ci-cd-demo/site/pr_previews/${{ github.head_ref }}/ --recursive && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null

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

@@ -1,24 +1,47 @@
-# Deploy our docs site to S3 whenever we push a commit to the main branch
-
-name: Deploy to S3 production bucket
+name: Deploy docs site to production
 
 on:
   push:
     branches:
       - prod
+  workflow_run:
+    workflows: ["Merge staging into prod"]
+    types:
+      - completed
+  workflow_dispatch:
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout repository
+      - name: Check out repository
         uses: actions/checkout@v2
+
+      - name: Get latest Quarto release URL
+        id: get-quarto-url
+        run: |
+          API_URL="https://api.github.com/repos/quarto-dev/quarto-cli/releases/latest"
+          DOWNLOAD_URL=$(curl -s $API_URL | jq -r '.assets[] | select(.name | endswith("linux-amd64.deb")).browser_download_url')
+          echo "DOWNLOAD_URL=$DOWNLOAD_URL" >> $GITHUB_ENV
+
+      - name: Download and install Quarto
+        run: |
+          wget ${{ env.DOWNLOAD_URL }} -O quarto-latest-linux-amd64.deb
+          sudo dpkg -i quarto-latest-linux-amd64.deb
+
+      - name: Render docs site
+        run: |
+            cd site 
+            quarto render --profile production &> render_errors.log || { 
+            echo "Quarto render failed immediately";
+            cat render_errors.log;
+            exit 1;
+            }
 
       # Prod bucket is in us-east-1
       - name: Configure AWS credentials
         run: aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID }} && aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY }} && aws configure set default.region us-east-1
 
-      - name: Sync to S3
-        run: 
-          aws s3 sync site/_site s3://${{ vars.S3_BUCKET_PROD }}/site --delete && aws cloudfront create-invalidation --distribution-id E2I9R40IH01NW3 --paths "/*" --no-cli-pager
+      - name: Deploy docs site
+        run: aws s3 sync site/_site s3://docs-ci-cd-prod/site --delete && aws cloudfront create-invalidation --distribution-id E2I9R40IH01NW3 --paths "/*" --no-cli-pager

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

@@ -0,0 +1,47 @@
+name: Deploy docs site to staging
+
+on:
+  push:
+    branches:
+      - staging
+  workflow_run:
+    workflows: ["Merge main into staging"]
+    types:
+      - completed
+    workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+
+      - name: Get latest Quarto release URL
+        id: get-quarto-url
+        run: |
+          API_URL="https://api.github.com/repos/quarto-dev/quarto-cli/releases/latest"
+          DOWNLOAD_URL=$(curl -s $API_URL | jq -r '.assets[] | select(.name | endswith("linux-amd64.deb")).browser_download_url')
+          echo "DOWNLOAD_URL=$DOWNLOAD_URL" >> $GITHUB_ENV
+
+      - name: Download and install Quarto
+        run: |
+          wget ${{ env.DOWNLOAD_URL }} -O quarto-latest-linux-amd64.deb
+          sudo dpkg -i quarto-latest-linux-amd64.deb
+
+      - name: Render docs site
+        run: |
+            cd site 
+            quarto render --profile staging &> render_errors.log || { 
+            echo "Quarto render failed immediately";
+            cat render_errors.log;
+            exit 1;
+            }
+
+      # Staging bucket is in us-west-2
+      - name: Configure AWS credentials
+        run: aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID_STAGING }} && aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY_STAGING }} && aws configure set default.region us-west-2
+
+      - name: Deploy docs site
+        run: aws s3 sync site/_site s3://docs-ci-cd-staging/site --delete && aws cloudfront create-invalidation --distribution-id E2FB73KGY63MV6 --paths "/*" --no-cli-pager

.github/workflows/release_notes_check.yml

@@ -10,7 +10,7 @@ jobs:
     if: github.event.pull_request.draft == false
 
     steps:
-      - name: Checkout repository
+      - name: Check out repository
         uses: actions/checkout@v2
 
       - name: Set up Python

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

@@ -14,7 +14,7 @@ jobs:
     if: github.event.pull_request.draft == false
 
     steps:
-    - name: Checkout repository
+    - name: Check out repository
       uses: actions/checkout@v2
 
     - name: Get latest Quarto release URL
@@ -31,8 +31,8 @@ jobs:
 
     - name: Render site
       run: |
-          cd ./site 
-          quarto render &> render_errors.log || { 
+          cd site 
+          quarto render --profile development &> render_errors.log || { 
           echo "Quarto render failed immediately";
           cat render_errors.log;
           exit 1;
@@ -48,11 +48,12 @@ jobs:
           echo "No warnings or errors detected during Quarto render"
         fi
 
+      # Demo bucket is in us-east-1
     - name: Configure AWS credentials
       run: aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID }} && aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY }} && aws configure set default.region us-east-1
 
     - name: Deploy PR preview
-      run: aws s3 sync site/_site s3://${{ vars.S3_BUCKET_DEMO }}/site/pr_previews/${{ github.head_ref }} --delete && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager
+      run: aws s3 sync site/_site s3://docs-ci-cd-demo/site/pr_previews/${{ github.head_ref }} --delete && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager
 
     - name: Post comment with preview URL
       uses: actions/github-script@v6

README.md

@@ -141,4 +141,4 @@ make get-source
 
 After you pull in the changes, commit them to this repo as part of the release notes process.
 
-<!-- Aug 2024: Need to mention rendered Python `.html` docs and generated `.md` test descriptions -->
+<!-- September 16, 2024: Need to mention rendered Python `.html` docs and generated `.md` test descriptions -->

internal/templates/_single-source.qmd

@@ -0,0 +1,25 @@
+<!-- REPLACE WITH YOUR ACTUAL INSTRUCTIONS -->
+
+
+<!-- VISIBLE IN USER GUIDES ONlY -->
+
+:::: {.content-visible unless-format="revealjs"}
+1. In the left sidebar, click **Model 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)]
+
+1. In the expanded sidebar that appears for your model, click **Model Activity**.
+
+::::
+
+
+<!-- VISIBLE IN TRAINING SLIDES ONLY -->
+
+:::: {.content-hidden unless-format="revealjs"}
+1. In the left sidebar, click **Model 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).
+
+1. In the expanded sidebar that appears for your model, click **Model Activity**.
+
+::::

internal/templates/about-validmind.md

@@ -16,7 +16,7 @@ If you haven't already seen our [Get started with the ValidMind Developer Framew
 
 For access to all features available in this notebook, create a free ValidMind account.
 
-Signing up is FREE — [**Sign up now**](https://app.prod.validmind.ai)
+Signing up is FREE — {{< var link.register >}} 
 
 :::
 

site/Makefile

@@ -1,12 +1,13 @@
 # Define source and destination directories
 SRC_DIR := _source/developer-framework
 DEST_DIR_NB := notebooks
+SRC_DIR_PYTHON := python-docs
 DEST_DIR_PYTHON := _site/validmind
 DEST_DIR_TESTS := tests
 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
 
 # Define .PHONY target for help section
-.PHONY: help clean clone notebooks python-docs docs-site deploy-demo deploy-demo-branch delete-demo-branch deploy-prod release-notes
+.PHONY: help clean clone notebooks python-docs docs-site deploy-demo deploy-demo-branch delete-demo-branch deploy-prod deploy-staging release-notes
 
 # Help section
 help:
@@ -21,6 +22,7 @@ help:
 	@echo "  deploy-demo-branch   Deploy docs demo site to s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/"
 	@echo "  delete-demo-branch   Delete docs demo site in s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/"
 	@echo "  deploy-prod          Deploy docs prod site to s3://docs-ci-cd-prod/site/"
+	@echo "  deploy-staging       Deploy docs staging site to s3://docs-ci-cd-staging/site/"
 	@echo "  help                 Display this help message (default target)"
 	@echo "  release-notes        Generate release notes from pull requests since latest tag and update _quarto.yml"
 
@@ -54,13 +56,14 @@ notebooks:
 python-docs:
 	@if [ -d "$(SRC_DIR)/docs/_build/" ]; then \
 		echo "\nUpdating Python documentation ..."; \
-		rm -rf $(DEST_DIR_PYTHON); \
-		mkdir -p $(DEST_DIR_PYTHON); \
-		cp -r $(SRC_DIR)/docs/_build/. $(DEST_DIR_PYTHON); \
-	else \
-		echo "\nNo updated Python documentation available locally, skipping step ..."; \
-	fi
-
+		rm -rf $(SRC_DIR_PYTHON); \
+		mkdir -p $(SRC_DIR_PYTHON); \
+		cp -r $(SRC_DIR)/docs/_build/. $(SRC_DIR_PYTHON); \
+	fi; \
+	echo "Copying Python documentation into docs site ..."; \
+	rm -rf $(DEST_DIR_PYTHON); \
+	mkdir -p $(DEST_DIR_PYTHON); \
+	cp -r $(SRC_DIR_PYTHON)/. $(DEST_DIR_PYTHON);
 
 test-descriptions:
 	@echo "\nUpdating test descriptions source ..."
@@ -75,7 +78,7 @@ get-source: clean clone notebooks python-docs test-descriptions
 
 # Get all source files
 docs-site: clean clone notebooks python-docs test-descriptions
-	quarto render
+	quarto render --profile development
 #	quarto render notebooks/how_to/explore_tests.ipynb --execute
 #	quarto render notebooks/how_to/explore_test_suites.ipynb --execute
 
@@ -85,12 +88,12 @@ deploy-demo:
 		echo "You're not on the docs-demo branch, no action taken."; \
 	else \
 		echo "\nDeploying docs-demo site ..."; \
-		quarto render && aws s3 sync ./_site s3://docs-ci-cd-demo/site/ && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; \
+		quarto render --profile development && aws s3 sync ./_site s3://docs-ci-cd-demo/site/ && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; \
 	fi
 
 # Deploy PR branch to https://docs-demo.vm.validmind.ai/
 deploy-demo-branch:
-	@quarto render && aws s3 sync ./_site s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/ --delete && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; 
+	@quarto render --profile development && aws s3 sync ./_site s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/ --delete && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; 
 	@echo "\nDeployed to https://docs-demo.vm.validmind.ai/pr_previews/$(GIT_BRANCH)/index.html"
 
 # Delete PR branch on https://docs-demo.vm.validmind.ai/
@@ -104,7 +107,17 @@ deploy-prod:
 		echo "You're not on the prod branch, no action taken."; \
 	else \
 		echo "\nDeploying prod site ..."; \
-		quarto render && aws s3 sync ./_site s3://docs-ci-cd-prod/site/ --delete && aws cloudfront create-invalidation --distribution-id E2I9R40IH01NW3 --paths "/*" --no-cli-pager > /dev/null; \
+		quarto render --profile production && aws s3 sync ./_site s3://docs-ci-cd-prod/site/ --delete && aws cloudfront create-invalidation --distribution-id E2I9R40IH01NW3 --paths "/*" --no-cli-pager > /dev/null; \
+	fi
+
+# Deployment to https://docs.validmind.ai/
+# TO DO Fix Cloudfront distribution ID
+deploy-staging:
+	@if [ "`git rev-parse --abbrev-ref HEAD`" != "nrichers/sc-6277/deploy-staging-docs-site-workflow" ]; then \
+		echo "You're not on the staging branch, no action taken."; \
+	else \
+		echo "\nDeploying staging site ..."; \
+		quarto render --profile staging && aws s3 sync ./_site s3://docs-ci-cd-staging/site/ --delete && aws cloudfront create-invalidation --distribution-id E2FB73KGY63MV6 --paths "/*" --no-cli-pager > /dev/null; \
 	fi
 
 # Generate release notes

site/_quarto-development.yml

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

site/_quarto-production.yml

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

site/_quarto-staging.yml

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