kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix feature-state shortcode for accurate feature gate rendering within tabs 

- Adjusted shortcode logic to correctly render feature gates and their states.
- Ensured compatibility with nested tab structures, resolving issues with displaying feature gates inside tabs.
pull/47976/head
Reza Ghanbari 2024-09-18 00:17:02 +02:00
parent bcaf5a0a8c
commit 44e798ad79
1 changed files with 15 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
layouts/shortcodes/feature-state.html
View File

@ -1,55 +1,48 @@
{{ $valid_states := "alpha, beta, deprecated, stable" }}
{{ $state := .Get "state" }}
{{ $for_k8s_version := .Get "for_k8s_version" | default (.Page.Param "version")}}
{{ $for_k8s_version := .Get "for_k8s_version" | default (.Page.Param "version") }}
{{ $is_valid := strings.Contains $valid_states $state }}
{{ $feature_gate_name := .Get "feature_gate_name" }}
<!-- When 'feature_gate_name' parameter is not specified, continue with the values provided. -->
{{ if not $feature_gate_name }}
{{ if not $is_valid }}
{{ errorf "%q is not a valid feature-state, use one of %q" $state $valid_states }}
{{ else }}
<div class="feature-state-notice feature-{{ $state }}">
<span class="feature-state-name">{{ T "feature_state" }}</span> <code>{{T "feature_state_kubernetes_label" }} {{ $for_k8s_version }} [{{ $state }}]</code>
</div>
<div class="feature-state-notice feature-{{ $state }}">
<span class="feature-state-name">{{ T "feature_state" }}</span>
<code>{{ T "feature_state_kubernetes_label" }} {{ $for_k8s_version }} [{{ $state }}]</code>
</div>
{{ end }}
{{- else -}}
<!-- When 'feature_gate_name' is specified, the following code block extracts the status of the feature gate from the description file. -->
<!-- Set the path for feature gate description files -->
{{ else }}
<!-- When 'feature_gate_name' is specified, extract status of the feature gate -->
{{- $featureGateDescriptionFilesPath := "/docs/reference/command-line-tools-reference/feature-gates" -}}
<!-- Access the 'English' site and get the feature gate description pages -->
{{- with index (where .Site.Sites "Language.Lang" "eq" "en") 0 -}}
{{- with .GetPage $featureGateDescriptionFilesPath -}}
<!-- Sort Feature gate pages list -->
{{- $sortedFeatureGates := sort (.Resources.ByType "page") -}}
{{- $featureGateFound := false -}}
<!-- Iterate through feature gate files -->
{{- range $featureGateFile := $sortedFeatureGates -}}
{{- $featureGateNameFromFile := $featureGateFile.Params.Title -}}
{{- if eq $featureGateNameFromFile $feature_gate_name -}}
<!-- Extract information from the final stage of the feature gate -->
{{- $currentStage := index $featureGateFile.Params.stages (sub (len $featureGateFile.Params.stages) 1) -}}
{{- with $currentStage -}}
<!-- Display feature state information -->
<div class="feature-state-notice feature-{{ .stage }}" title="{{ printf "%s %s" (T "feature_state_feature_gate_tooltip") $feature_gate_name }}">
<span class="feature-state-name">{{ T "feature_state" }}</span> <code>{{T "feature_state_kubernetes_label" }} v{{ .fromVersion }} [{{ .stage }}]</code>
</div>
<div class="feature-state-notice feature-{{ .stage }}" title="{{ printf "%s %s" (T "feature_state_feature_gate_tooltip") $feature_gate_name }}">
<span class="feature-state-name">{{ T "feature_state" }}</span>
<code>{{ T "feature_state_kubernetes_label" }} v{{ .fromVersion }} [{{ .stage }}]</code>
</div>
{{- $featureGateFound = true -}}
{{- end -}}
{{- end -}}
{{- end -}}
<!-- Check if specified feature gate is not found -->
{{- if not $featureGateFound -}}
{{- errorf "Invalid feature gate: '%s' is not recognized or lacks a matching description file in '%s'" $feature_gate_name (print "en" $featureGateDescriptionFilesPath) -}}
{{- errorf "Invalid feature gate: '%s' is not recognized or lacks a matching description file in '%s'" $feature_gate_name (print "en" $featureGateDescriptionFilesPath) -}}
{{- end -}}
{{- end -}}