Skip to content

Revise the rendering of feature state #52635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −2
Open

Revise the rendering of feature state #52635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion i18n/en/en.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,10 @@ other = "Error"
other = "Examples"

[feature_gate_enabled]
other = "(enabled by default: {{ .enabled }})"
other = "(enabled by default)"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution: this might break localizations that still rely on the old text.

If we're OK with that, we can proceed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lmktfy : What should be the action taken by the respective localisationss to remove this dependency and amend it to follow the enablement of the feature?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have two ideas

  1. at merge time, find the list of localizations that will become stale, and notify them
  2. use a new key and not feature_gate_enabled

I recommend option 1 over option 2, and also option 1 over not notifying.


[feature_gate_disabled]
other = "(disabled by default)"

[feature_gate_stage_alpha]
other = "Alpha"
Expand Down
7 changes: 6 additions & 1 deletion layouts/shortcodes/feature-state.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@

<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> {{ T "feature_gate_enabled" (dict "enabled" .defaultValue) }}
<code>{{ T "feature_state_kubernetes_label" }} v{{ .fromVersion }} [{{ .stage }}]</code>
{{- if eq .defaultValue true -}}
{{ T "feature_gate_enabled" }}
{{- else -}}
{{ T "feature_gate_disabled" }}
{{- end -}}
</div>

{{- $featureGateFound = true -}}
Expand Down