From b9d8c3ff7e105faae2403dea6c805ffbe21ef599 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 25 Feb 2026 13:34:13 +0000 Subject: [PATCH] Fix support link pattern and add enforcement check Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --- .ci/scripts/check-support-links.sh | 25 +++++++++++++++++++ .../styles/InfluxDataDocs/SupportLink.yml | 13 ++++++++++ DOCS-CONTRIBUTING.md | 15 +++++++++++ .../troubleshoot-and-optimize/query-log.md | 2 +- lefthook.yml | 6 +++++ 5 files changed, 60 insertions(+), 1 deletion(-) create mode 100755 .ci/scripts/check-support-links.sh create mode 100644 .ci/vale/styles/InfluxDataDocs/SupportLink.yml diff --git a/.ci/scripts/check-support-links.sh b/.ci/scripts/check-support-links.sh new file mode 100755 index 000000000..a0330fa9b --- /dev/null +++ b/.ci/scripts/check-support-links.sh @@ -0,0 +1,25 @@ +#!/bin/bash +# Check for non-standard InfluxData support links +# Standard link: https://support.influxdata.com (no trailing slash, no path) + +set -e + +EXIT_CODE=0 + +echo "Checking for non-standard InfluxData support links..." + +# Find all markdown files with non-standard support.influxdata.com URLs +# Check for URLs with paths (/s/contactsupport, /s/login, etc.) +if grep -rn "https://support\.influxdata\.com/[^)\s]*" content --include="*.md" | grep -v "https://support\.influxdata\.com)"; then + echo "" + echo "ERROR: Found support.influxdata.com URLs with paths or trailing slashes." + echo "Please use the standard format: https://support.influxdata.com" + echo "" + EXIT_CODE=1 +fi + +if [ $EXIT_CODE -eq 0 ]; then + echo "✓ All support links use the standard format." +fi + +exit $EXIT_CODE diff --git a/.ci/vale/styles/InfluxDataDocs/SupportLink.yml b/.ci/vale/styles/InfluxDataDocs/SupportLink.yml new file mode 100644 index 000000000..a74d10782 --- /dev/null +++ b/.ci/vale/styles/InfluxDataDocs/SupportLink.yml @@ -0,0 +1,13 @@ +extends: substitution +message: "Use the standard InfluxData support link format: '%s'" +link: "https://github.com/influxdata/docs-v2/blob/master/DOCS-CONTRIBUTING.md" +level: error +ignorecase: false +nonword: true +# Match support.influxdata.com URLs with paths or trailing slashes +# and suggest the canonical form without them +swap: + # Match any URL with /s/ path (login, contactsupport, etc.) + 'https://support\.influxdata\.com/s/[^\)>\s]+': 'https://support.influxdata.com' + # Match base URL with trailing slash + 'https://support\.influxdata\.com/': 'https://support.influxdata.com' diff --git a/DOCS-CONTRIBUTING.md b/DOCS-CONTRIBUTING.md index 07f1f6ebe..07f681f52 100644 --- a/DOCS-CONTRIBUTING.md +++ b/DOCS-CONTRIBUTING.md @@ -164,6 +164,21 @@ Save images using the following naming format: `project/version-context-descript For example, `influxdb/2-0-visualizations-line-graph.png` or `influxdb/2-0-tasks-add-new.png`. Specify a version other than 2.0 only if the image is specific to that version. +#### InfluxData Support links + +When linking to InfluxData Support, use the canonical URL without trailing slashes or paths: + +```markdown +[contact InfluxData support](https://support.influxdata.com) +``` + +**Do not use**: +- `https://support.influxdata.com/` (trailing slash) +- `https://support.influxdata.com/s/contactsupport` (path) +- `https://support.influxdata.com/s/login/?ec=302&startURL=%2Fs%2Fcontactsupport` (login redirect) + +The pre-commit hook will check for and reject non-standard support link formats. + ### Essential Frontmatter Reference Every documentation page includes frontmatter which specifies information about the page. diff --git a/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md index 05a165f4b..751b01933 100644 --- a/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md +++ b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md @@ -22,7 +22,7 @@ Use it to monitor query performance, find slow-running queries, and troubleshoot > #### Query logging is not enabled by default > > The query log is not enabled by default on all clusters as it can create a negligible ingest load on your cluster. -> To enable it for your cluster, [contact InfluxData support](https://support.influxdata.com/s/login/?ec=302&startURL=%2Fs%2Fcontactsupport). +> To enable it for your cluster, [contact InfluxData support](https://support.influxdata.com). Use the Admin UI or the [`influxctl query` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/query/) to view the query log. diff --git a/lefthook.yml b/lefthook.yml index d822e1dfc..bee86bb72 100644 --- a/lefthook.yml +++ b/lefthook.yml @@ -22,6 +22,12 @@ pre-commit: echo " Use 'python' instead of 'py' for code fences." errors=1 fi + # Check for non-standard support.influxdata.com URLs + if grep -E 'https://support\.influxdata\.com/[^)\s]*' {staged_files} 2>/dev/null | grep -v 'https://support\.influxdata\.com)'; then + echo "❌ Found non-standard support.influxdata.com URL." + echo " Use 'https://support.influxdata.com' (no trailing slash, no path)." + errors=1 + fi exit $errors fail_text: "Deprecated markdown patterns found. See messages above for details." eslint-debug-check: