Relax test for language prefix in the links

[Andygol]

What happened?

The test https://github.com/open-telemetry/opentelemetry.io/actions/runs/18612491468/workflow?pr=5891#L136 failed due to strict conditions for evaluating the log level.

WARN  File /home/runner/work/opentelemetry.io/opentelemetry.io/content/uk/community/_index.md: drop unnecessary '/uk/' prefix from /uk/community/marketing-guidelines/
WARN  File /home/runner/work/opentelemetry.io/opentelemetry.io/content/uk/community/_index.md: drop unnecessary '/uk/' prefix from /uk/site/

_{See https://github.com/open-telemetry/opentelemetry.io/actions/runs/18612491468/job/53072630692?pr=5891#step:5:10 ☝️}

What did you expect would happen?

I expect that this level of logs should be passed or have less critical level for assessment.

What is the name + path of the page where you encountered the issue?

opentelemetry.io/layouts/_markup/render-link.html

Lines 45 to 47 in 9a2a3eb

	{{ if and (hasPrefix $url $langPathPrefix) .Page.File -}}
	{{ warnf "File %s: drop unnecessary '%s' prefix from %s"
	.Page.File.Filename $langPathPrefix $url -}}

and

scripts/check-build-log.sh

Possible options to avoid the test fails

Since the links in the footer are outside the scope of the render-links decorator for automatically adding a language code prefix, you have to add it manually for the corresponding links in site.param.links (See lines 136-147 in the hugo.yaml). However, at the same time, the logic for checking for the presence of language code in the decorator also works for links in the footer, which leads to a warning. To solve the issue quickly, you can use one of these suggestions:

• Add exceptions to the .warnings-skip-list.txt file for the specific warnings, or
• Use fmt.Warnidf with INFO ID in render-link.html#L46 and add ignoreLogs: [INFO] into hugo.yaml to suppress this type of log messages.

However, a more reliable way to solve the issue would probably be to add an exception for footer links to the decorator's link checking logic.

I eagerly await a decision on possible ways to resolve this issue.

_{Tip:
React
with 👍 to help prioritize this issue. Please use comments to provide useful
context, avoiding +1 or me too, to help us triage it. Learn more
here.}

[chalin]

Thanks for the detailed report. The root of the problem is that the same URL/path (from Site.Params.links) gets processed in two different ways:

• In a markdown context, via render-link -- which adjusts the path
• In an HTML context, via footer/links -- (currently) no link processing

I'd rather that the links paths get processed uniformly. I'll look into this as soon as I can. In the meantime, yes, adding the warnings to the skip file is the simplest solution.

---

I'd prefer to have the footer links apply the locale processing logic (and add a prefix as necessary), but it requires too many changes to Docsy (to make it easier to override footer/links.html, and then duplicate or auto-synced partial. I don't think that it's worth it.

It seems that the simplest solution would be to use the query param disable_locale_prefix_check (or _warning) inside the link render hook.

[Andygol]

So, as we're moving towards changing the hook, I had another look at the hook code and thought, why not check for the presence of a language prefix, but only for the default language, not all the others? If you've got the default language prefix, you'll end up with invalid links and a 404 error.

[Andygol]

I experimented a little with changing the check rules to detect the presence of the default language prefix in links on localized pages. It looks something like this.

--- a/layouts/_markup/render-link.html
+++ b/layouts/_markup/render-link.html
@@ -42,9 +42,16 @@
   {{ $lang := .Page.Language.Lang -}}
   {{ if ne $lang $defaultLang -}}
     {{ $langPathPrefix := add "/" $lang "/" -}}
-    {{ if and (hasPrefix $url $langPathPrefix) .Page.File -}}
-      {{ warnf "File %s: drop unnecessary '%s' prefix from %s"
+    {{ $defaultLangPrefix := add "/" $defaultLang "/" -}}
+    {{ if and (hasPrefix $url $defaultLangPrefix) .Page.File -}}
+      {{/* Warn when a localized page links to a path that includes the default language prefix (e.g. '/en/...'). */ -}}
+      {{ warnf "File %s: drop default-language prefix '%s' from %s when linking from localized page"
+              .Page.File.Filename $defaultLangPrefix $url -}}
+    {{/* If the link already contains the current locale prefix warn to drop it.
+    {{ else if and (hasPrefix $url $langPathPrefix) .Page.File -}}
+      {{ warnidf "locale_prefix_check" "File %s: drop unnecessary '%s' prefix from %s"
               .Page.File.Filename $langPathPrefix $url -}}
+    */ -}}
     {{ else -}}
       {{ $localizedPagePath := add $langPathPrefix (strings.TrimPrefix "/" $url) -}}
       {{/*

I have commented out the check for the language prefix for localized links for now. If such a check is needed, this code can be uncommented and the appropriate parameter added to ignore warnings for localized links in hugo.yaml