diff --git a/extensions/content-health-monitor/Makefile b/extensions/content-health-monitor/Makefile index ede2af97..5bd9a94e 100644 --- a/extensions/content-health-monitor/Makefile +++ b/extensions/content-health-monitor/Makefile @@ -49,7 +49,7 @@ clean: .PHONY: update-manifest update-manifest: cp manifest.json manifest.old.json - uv run rsconnect write-manifest quarto content-health-monitor.qmd content_health_utils.py --overwrite + uv run rsconnect write-manifest quarto content-health-monitor.qmd content_health_utils.py images/refresh-report.png images/settings-gear-icon.png --overwrite jq -n --slurpfile old manifest.old.json --slurpfile new manifest.json \ '{"version": $$new[0].version, "locale": $$new[0].locale, "metadata": $$new[0].metadata, "extension": $$old[0].extension, "environment": $$old[0].environment} * ($$new[0] | del(.version, .locale, .metadata))' \ > manifest.merged.json @@ -67,4 +67,4 @@ help: @echo " clean - Clean up virtual environment and cache files" @echo " update-manifest - Update manifest.json preserving extension and environment blocks" @echo " help - Show this help message" - @echo " all - Setup environment and run tests (default)" \ No newline at end of file + @echo " all - Setup environment and run tests (default)" diff --git a/extensions/content-health-monitor/content_health_utils.py b/extensions/content-health-monitor/content_health_utils.py index 5771724b..83e1d737 100644 --- a/extensions/content-health-monitor/content_health_utils.py +++ b/extensions/content-health-monitor/content_health_utils.py @@ -66,10 +66,32 @@ def get_env_var(var_name, state, description=""): instruction = f"Please set the {var_name} environment variable." # Detailed instructions for MONITORED_CONTENT_GUID else: + one_tab = "    " # For indentation in HTML + two_tabs = f"{one_tab}{one_tab}" # For deeper indentation instruction = ( - f"Open the Content Settings panel, then navigate to the Vars pane. " - f"Create a new environment variable named {var_name}, set its value to the GUID of the content you want to monitor, " - f"and click Add Variable. When you're done, click Refresh Report in the upper right toolbar menu to continue." + f"To monitor a piece of content you must configure the {var_name} environment variable.

" + + f"Step 1: Locate the content you want to monitor in a new browser tab or window
" + f"{one_tab}Option A: Copy the GUID from the Content Settings panel
" + f"{two_tabs}• Click the gear icon in the top right toolbar to open Content Settings
" + f'{two_tabs}Settings gear icon location
' + f"{two_tabs}• Select the Info tab
" + f"{two_tabs}• Scroll to the bottom and click the copy button next to the GUID
" + f"{one_tab}Option B: Copy the full URL from your browser
" + f"{two_tabs}• If the address bar contains a GUID (ex: 1d97c1ff-e56c-4074-906f-cb3557685b75), " + f"you can simply copy the entire URL

" + + f"Step 2: Return to this report to set the environment variable
" + f"{one_tab}• Click the gear icon to open Content Settings
" + f"{one_tab}• Select the Vars tab
" + f"{one_tab}• Add a new variable named {var_name}
" + f"{one_tab}• Paste the GUID you copied into the value field
" + f"{one_tab}• Click Add Variable and then Save to save it

" + + f"Step 3: Click Refresh Report in the top right to to run a health check against the content specified in the new variable
" + f'Refresh report button

' + ) if description: diff --git a/extensions/content-health-monitor/images/refresh-report.png b/extensions/content-health-monitor/images/refresh-report.png new file mode 100644 index 00000000..c2677294 Binary files /dev/null and b/extensions/content-health-monitor/images/refresh-report.png differ diff --git a/extensions/content-health-monitor/images/settings-gear-icon.png b/extensions/content-health-monitor/images/settings-gear-icon.png new file mode 100644 index 00000000..dbbff815 Binary files /dev/null and b/extensions/content-health-monitor/images/settings-gear-icon.png differ diff --git a/extensions/content-health-monitor/manifest.json b/extensions/content-health-monitor/manifest.json index e0316c8a..cc7ad920 100644 --- a/extensions/content-health-monitor/manifest.json +++ b/extensions/content-health-monitor/manifest.json @@ -32,7 +32,7 @@ "version": "3.11.7", "package_manager": { "name": "pip", - "version": "25.1.1", + "version": "24.2", "package_file": "requirements.txt" } }, @@ -41,10 +41,16 @@ "checksum": "5f89d52674b219c0b0ed85f1a5785641" }, "content-health-monitor.qmd": { - "checksum": "7a31430ef0d92505829e214ac85f8633" + "checksum": "8dfce167badb4d889eeb93d1f4adbff8" }, "content_health_utils.py": { - "checksum": "73627372e41f90a2259ea5c0969d19a9" + "checksum": "3d599ebe8d29aa12ae630acc847e290a" + }, + "images/refresh-report.png": { + "checksum": "e5680e6188eb8d659e4313cb89d0be3b" + }, + "images/settings-gear-icon.png": { + "checksum": "e2bc43263eb8a9179b6e0e5ab3e22450" } } } diff --git a/extensions/content-health-monitor/test_content_health_utils.py b/extensions/content-health-monitor/test_content_health_utils.py index f436e613..d8e22975 100644 --- a/extensions/content-health-monitor/test_content_health_utils.py +++ b/extensions/content-health-monitor/test_content_health_utils.py @@ -163,7 +163,7 @@ def test_get_env_var_missing_canary_guid(self, state): assert result == "" assert state.show_instructions assert len(state.instructions) == 1 - assert "Open the Content Settings panel" in state.instructions[0] + assert "you must configure the MONITORED_CONTENT_GUID environment variable" in state.instructions[0] assert f"{var_name}" in state.instructions[0] def test_get_env_var_with_description(self, state):