Merge pull request #825 from TineoC/fix/kep-see-also-related-enhancements

fix: link see-also KEP references to their pages on this site

Author: kubernetes-prow[bot]

layouts/keps/single.html

@@ -81,15 +81,7 @@ <h1>KEP-{{ .Params.kepNumber }}: {{ .Title }}</h1>
           <div class="kep-banner-sublabel">Related Enhancements</div>
           <ul class="kep-link-list">
             {{ range . }}
-            <li>
-              {{- if and (strings.HasPrefix . "http") (not (strings.Contains . "[")) -}}
-                <a href="{{ . }}" target="_blank" rel="noopener"><i class="fas fa-external-link-alt"></i> {{ . }}</a>
-              {{- else if and (strings.HasPrefix . "/") (not (strings.Contains . "[")) -}}
-                <a href="https://github.com/kubernetes/enhancements/tree/master{{ . }}" target="_blank" rel="noopener"><i class="fab fa-github"></i> {{ . }}</a>
-              {{- else -}}
-                {{ . | markdownify }}
-              {{- end -}}
-            </li>
+            <li>{{- partial "keps/see-also.html" . -}}</li>
             {{ end }}
           </ul>
         </div>

layouts/partials/keps/page-by-number.html

@@ -0,0 +1,14 @@
+{{- /* Returns this site's page for a KEP number, or "" when that KEP has no page.
+       Not every KEP gets one — see content/en/resources/keps/_content.gotmpl for the
+       stage/status filter. Keeps the /resources/keps/<number>/ URL scheme in one place.
+
+       @param {string} context The KEP number, e.g. "4569".
+       @returns {page.Page|string} The page, or "" when there is none — falsy either way,
+                so callers can reach for `with`.
+*/ -}}
+{{- $page := "" -}}
+{{- /* An empty number would make GetPage return the section page listing every KEP. */ -}}
+{{- with printf "%v" . -}}
+  {{- $page = site.GetPage (printf "resources/keps/%s" .) -}}
+{{- end -}}
+{{- return $page -}}

layouts/partials/keps/see-also.html

@@ -0,0 +1,51 @@
+{{- /* Renders one KEP `seeAlso` entry as a link. Shapes present in keps.json:
+       - markdown link:      "[Title](https://…)"
+       - full URL:           "https://…"
+       - root-relative path: "/keps/sig-scheduling/624-scheduling-framework"
+       - bare repo path:     "keps/sig-node/4569-cgroup-v1-maintenance-mode/README.md"
+       - nested path:        "/keps/prod-readiness/sig-apps/3329"
+       - singular "/kep/":   "/kep/sig-network/0752-endpointslices/"
+       - free text:          "KEP-32", "TBD", "n/a"
+
+       Every path shape resolves to the referenced KEP's own page on this site, so every
+       entry reads the same way regardless of how it was written. Paths we can't resolve
+       fall back to GitHub, and anything else is left as text.
+
+       @param {string} context One seeAlso entry.
+*/ -}}
+{{- $entry := . -}}
+{{- if strings.Contains $entry "[" -}}
+  {{ $entry | markdownify }}
+{{- else if strings.HasPrefix $entry "http" -}}
+  <a href="{{ $entry }}" target="_blank" rel="noopener"><i class="fas fa-external-link-alt" aria-hidden="true"></i> {{ $entry }}</a>
+{{- else -}}
+  {{- $path := printf "/%s" (strings.TrimPrefix "/" $entry) -}}
+  {{- /* A few entries write "/kep/…" for "/keps/…"; normalizing here fixes both the
+         lookup below and the directory name the GitHub fallback links to. */ -}}
+  {{- $path = replaceRE `^/kep/` "/keps/" $path -}}
+  {{- $kep := "" -}}
+  {{- /* The SIG is usually the only directory before the number, but some entries nest
+         further ("/keps/prod-readiness/sig-apps/3329", kubeadm's own subdirectory). */ -}}
+  {{- with findRESubmatch `^/keps/(?:[^/]+/)*([0-9]+)([^/]*)` $path 1 -}}
+    {{- $number := index . 0 1 -}}
+    {{- $directory := printf "%s%s" $number (index . 0 2) -}}
+    {{- $lookup := strings.TrimLeft "0" $number -}}
+    {{- with partialCached "keps/page-by-number.html" $lookup $lookup -}}
+      {{- /* A zero-padded number is legacy per-directory numbering ("0006-apply.md",
+             kubeadm's "0023-kubeadm-config.md") that only coincidentally matches a
+             modern KEP number, so require an exact directory match before trusting it.
+             Unpadded numbers are global KEP numbers and stay correct even when the
+             KEP's directory has since been renamed. */ -}}
+      {{- if or (not (strings.HasPrefix $number "0")) (eq .Params.name $directory) -}}
+        {{- $kep = . -}}
+      {{- end -}}
+    {{- end -}}
+  {{- end -}}
+  {{- if $kep -}}
+    <a href="{{ $kep.RelPermalink }}"><i class="fas fa-link" aria-hidden="true"></i> KEP-{{ $kep.Params.kepNumber }}: {{ $kep.Title }}</a>
+  {{- else if strings.Contains $path "/keps/" -}}
+    <a href="https://github.com/kubernetes/enhancements/tree/master{{ $path }}" target="_blank" rel="noopener"><i class="fab fa-github" aria-hidden="true"></i> {{ $entry }}</a>
+  {{- else -}}
+    {{ $entry | markdownify }}
+  {{- end -}}
+{{- end -}}

layouts/shortcodes/keps-data.html

@@ -19,7 +19,6 @@
 {{- end -}}
 
 {{- $validStages := slice "alpha" "beta" "stable" "deprecated" -}}
-{{- $validStatuses := slice "implementable" "implemented" -}}
 
 {{- /* Build unique release and SIG lists */ -}}
 {{- $releaseSet := dict -}}
@@ -114,9 +113,13 @@
       </thead>
       <tbody>
         {{ range $data := $kepData }}
-          {{- $hasValidStage := and $data.stage (in $validStages $data.stage) -}}
-          {{- $hasValidStatus := and $data.status (in $validStatuses $data.status) -}}
-          {{- $hasPage := or $hasValidStage $hasValidStatus -}}
+          {{- /* Link to the KEP's own page on this site, falling back to the enhancements
+                 repo for the KEPs that have no page. Cached because this table lists every
+                 KEP and most of them repeat the same lookup. */ -}}
+          {{- $kepUrl := printf "https://features.k8s.io/%s" $data.kepNumber -}}
+          {{- with partialCached "keps/page-by-number.html" $data.kepNumber $data.kepNumber -}}
+            {{- $kepUrl = .RelPermalink -}}
+          {{- end -}}
           {{- $stage := $data.stage -}}
           {{- if not $stage }}
             {{- if or (eq $data.status "implementable") (eq $data.status "implemented") }}
@@ -144,18 +147,10 @@
           {{- $allAuthors = strings.TrimLeft $allAuthors " " -}}
           <tr data-stage="{{ $stage }}" data-latest-milestone="{{ if $latest }}{{ strings.TrimPrefix "v" $latest }}{{ end }}" data-sig="{{ $data.owningSig }}" data-kep="{{ $data.kepNumber }}" data-created="{{ $data.creationDate }}" data-authors="{{ $allAuthors }}">
             <td class="kep-col-number" data-order="{{ $data.kepNumber }}">
-              {{- if $hasPage }}
-              <a href="/resources/keps/{{ $data.kepNumber }}/" class="kep-number-link">{{ $data.kepNumber }}</a>
-              {{- else }}
-              <a href="https://features.k8s.io/{{ $data.kepNumber }}" class="kep-number-link">{{ $data.kepNumber }}</a>
-              {{- end }}
+              <a href="{{ $kepUrl }}" class="kep-number-link">{{ $data.kepNumber }}</a>
             </td>
             <td class="kep-col-title">
-              {{- if $hasPage }}
-              <a href="/resources/keps/{{ $data.kepNumber }}/" class="kep-title-link">{{ $data.title }}</a>
-              {{- else }}
-              <a href="https://features.k8s.io/{{ $data.kepNumber }}" class="kep-title-link">{{ $data.title }}</a>
-              {{- end }}
+              <a href="{{ $kepUrl }}" class="kep-title-link">{{ $data.title }}</a>
             </td>
             <td class="kep-col-sig">
               {{- $sigSlug := strings.TrimPrefix "sig-" $data.owningSig -}}