Skip to content

Anchors to a description of a feature gate in a list of feature gates. #52619

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
+6 −5
Open

Anchors to a description of a feature gate in a list of feature gates. #52619

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
11 changes: 6 additions & 5 deletions layouts/shortcodes/feature-gate-list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<!-- Sort Feature gate pages list -->
{{- $sortedFeatureGates := sort ($featureDataFiles.Resources.ByType "page") -}}

<ul class="feature-gate-list">
<dl class="feature-gate-list">
{{- range $featureGateFile := $sortedFeatureGates -}}

<!-- Extract the feature gate name from the "Title" parameter in file -->
Expand Down Expand Up @@ -48,13 +48,14 @@

{{- if $shouldDisplayThisFeatureGate -}}
{{- with $featureGateFile.Content -}}
<li>
<dt id="{{ $featureGateName }}"><code class="feature-gate-name">{{ $featureGateName }}</code></dt>
Copy link
Contributor

Choose a reason for hiding this comment

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

I might:

Suggested change
<dt id="{{ $featureGateName }}"><code class="feature-gate-name">{{ $featureGateName }}</code></dt>
<dt id="feature-{{ $featureGateName }}"><code class="feature-gate-name">{{ $featureGateName }}</code></dt>

to avoid the risk of a collision with some other site feature. However, don't let this block a merge.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I initially considered using a prefix as well, but then dismissed the idea. I guess anchors can be used to link to feature gate descriptions instead of linking to the general page, like here.

website/content/en/docs/concepts/architecture/leases.md

Lines 92 to 95 in e9518c5

You can disable API server identity leases by disabling the `APIServerIdentity`
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/).

The code will turn to ⬇️

- You can disable API server identity leases by disabling the `APIServerIdentity`
- [feature gate](/docs/reference/command-line-tools-reference/feature-gates/).
+ You can disable API server identity leases by disabling the [`APIServerIdentity`
+ feature gate](/docs/reference/command-line-tools-reference/feature-gates/#APIServerIdentity).

<dd>
{{- $hasParagraphWrapper := (hasPrefix ( . | markdownify ) "<p>") -}}
{{- if not $hasParagraphWrapper }}<p>{{ end -}}
<code class="feature-gate-name">{{ $featureGateName }}</code>: {{ . | markdownify -}}
{{ . | markdownify -}}
{{- if not $hasParagraphWrapper }}</p>{{ end -}}
</li>
</dd>
{{- end -}}
{{- end -}}
{{- end -}}
</ul>
</dl>