Anchors to a description of a feature gate in a list of feature gates. #52619
Conversation
Update the formatting of the feature gate list to make it look similar to Definitions in Markdown. <https://www.markdownguide.org/extended-syntax/#definition-lists>
k8s-ci-robot
added
the
sig/docs
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/S
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/area web-development It's great to see changes suggested here. |
k8s-ci-robot
added
the
area/web-development
|
Please update the PR description to hyperlink to the preview. |
| {{- if $shouldDisplayThisFeatureGate -}} | ||
| {{- with $featureGateFile.Content -}} | ||
| <li> | ||
| <dt id="{{ $featureGateName }}"><code class="feature-gate-name">{{ $featureGateName }}</code></dt> |
There was a problem hiding this comment.
I might:
| <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.
There was a problem hiding this comment.
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
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).
|
LGTM |
This PR proposes an updated version of the feature gate list formatting to make it look similar to Definition Lists1 in Markdown. Along with the list update, anchors have been added so that other articles can link to the description of the corresponding feature gate rather than just the feature gate page.
Footnotes
https://www.markdownguide.org/extended-syntax/#definition-lists ↩