Conversation
Signed-off-by: bupd <bupdprasanth@gmail.com>
Signed-off-by: bupd <bupdprasanth@gmail.com>
Signed-off-by: bupd <bupdprasanth@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: bupd The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hey @bupd, thanks for starting to work on this. When I was checking your preview, I instinctively clicked the KEP Number instead of the KEP Title. Maybe we should consider the best solution for the links in the table as well. |
|
If all the details are covered in the new sub-page, maybe considering adding information that's not hyperlinked (such as the k8s release related to that KEP, for example). |
Where I can find that info if it's already there somewhere we can do so. |
Also I didn't change the table much just updated the title to lead to the sub page other things remain as before. Thanks 👍 |
|
I need to think about this more. I'll bring it up at the next meeting. There are no blockers on your side; I would appreciate it if you could also add the link to the subpage by clicking the KEP #. |
Signed-off-by: bupd <bupdprasanth@gmail.com>
TineoC
left a comment
There was a problem hiding this comment.
<ul class="list-unstyled">
{{ range $stage, $milestone := $data.milestone }}
{{ if $milestone }}
{{- $version := strings.TrimPrefix "v" $milestone -}}
<li>
{{ $stage }}:
<a href="https://github.com/kubernetes/sig-release/tree/master/releases/release-{{ $version }}" class="kep-milestone" target="_blank" rel="noopener noreferrer">
{{ $milestone }}
</a>
</li>
{{ end }}
{{ end }}
</ul>
This could link the kep with the k8s release. Do you think https://github.com/kubernetes/sig-release/tree/master/releases/release-X.Y.Z is a good link to use? <ul class="list-unstyled">
{{ range $stage, $milestone := $data.milestone }}
{{ if $milestone }}
{{- $version := strings.TrimPrefix "v" $milestone -}}
<li>
{{ $stage }}:
<a href="https://github.com/kubernetes/sig-release/tree/master/releases/release-{{ $version }}" class="kep-milestone" target="_blank" rel="noopener noreferrer">
{{ $milestone }}
</a>
</li>
{{ end }}
{{ end }}
</ul> |
|
I agree with #618 (comment) Let's try to merge something that adds value without the complexity of making it perfect. |
|
/kind feature |
| {{/* Stage badge */}} | ||
| {{ with .Params.stage }} | ||
| <div class="kep-stage-badge kep-stage-{{ . }}"> | ||
| <span class="badge">{{ . | upper }}</span> | ||
| </div> | ||
| {{ end }} |
| <h2>Links</h2> | ||
| <ul> | ||
| <li> | ||
| <a href="https://features.k8s.io/{{ .Params.kepNumber }}" target="_blank" rel="noopener"> |
There was a problem hiding this comment.
(nit)
| <a href="https://features.k8s.io/{{ .Params.kepNumber }}" target="_blank" rel="noopener"> | |
| <a href="https://kep.k8s.io/{{ .Params.kepNumber }}" target="_blank" rel="noopener"> |
| <div class="kep-sigs mt-4"> | ||
| <h2>SIGs</h2> | ||
| <p> | ||
| <strong>Owning SIG:</strong> |
There was a problem hiding this comment.
| <strong>Owning SIG:</strong> | |
| <p class="kep-sigs-owner">Owning SIG:</p> |
There was a problem hiding this comment.
(and then add an associated stylesheet entry)
| {{ end }} | ||
|
|
||
| {{/* Feature gates */}} | ||
| {{ with .Params.featureGates }} |
There was a problem hiding this comment.
We can maybe one day link to https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/#NameGoesHere (or whatever)
Also the Kubernetes website people can - if asked - set up short URLs if we want, eg https://features.k8s.io/gates/NameGoesHere that redirects to https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/#NameGoesHere
| <div class="kep-feature-gates mt-4"> | ||
| <h2>Feature Gates</h2> | ||
| <table class="table table-sm"> | ||
| <thead> |
| {{ with .Params.approvers }} | ||
| <p> | ||
| <strong>Approvers:</strong> | ||
| {{ range $i, $approver := . }} | ||
| {{- if $i }}, {{ end -}} | ||
| <a href="https://github.com/{{ trim $approver "@" }}">{{ $approver }}</a> | ||
| {{ end }} | ||
| </p> | ||
| {{ end }} |
| <ul> | ||
| {{ range . }} | ||
| <li> | ||
| <a href="https://github.com/kubernetes/enhancements/tree/master{{ . }}">{{ . }}</a> |
There was a problem hiding this comment.
Maybe we could link to the generated page for the related KEP?
| {{ range $i, $sig := . }} | ||
| {{- if $i }}, {{ end -}} | ||
| <a href="https://github.com/kubernetes/community/tree/master/{{ $sig }}"> | ||
| {{ strings.TrimPrefix "sig-" $sig | humanize | title }} |
There was a problem hiding this comment.
(nit)
| {{ strings.TrimPrefix "sig-" $sig | humanize | title }} | |
| SIG {{ strings.TrimPrefix "sig-" $sig | humanize | title }} |
| {{ with .alpha }}<tr><td>Alpha</td><td>{{ . }}</td></tr>{{ end }} | ||
| {{ with .beta }}<tr><td>Beta</td><td>{{ . }}</td></tr>{{ end }} | ||
| {{ with .stable }}<tr><td>Stable</td><td>{{ . }}</td></tr>{{ end }} | ||
| {{ with .deprecated }}<tr><td>Deprecated</td><td>{{ . }}</td></tr>{{ end }} |
There was a problem hiding this comment.
Ideally we use special marking to show that future milestones are anticipated, rather than commitments.
| {{/* Feature gates */}} | ||
| {{ with .Params.featureGates }} | ||
| <div class="kep-feature-gates mt-4"> | ||
| <h2>Feature Gates</h2> |
There was a problem hiding this comment.
(nit)
| <h2>Feature Gates</h2> | |
| <h2>Feature Gates</h2> | |
| <p>This enhancement was designed with opt-in or opt-out at the feature level; | |
| there are <a href="https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/">feature gates</a> associated with it.</p> |
|
|
||
| {{/* External links section */}} | ||
| <div class="kep-links mt-4"> | ||
| <h2>Links</h2> |
There was a problem hiding this comment.
Could we consider making these headings linkable by adding anchor links to them?
| {{ with .Params.seeAlso }} | ||
| <div class="kep-see-also mt-4"> | ||
| <h2>Related KEPs</h2> | ||
| <ul> | ||
| {{ range . }} | ||
| <li> | ||
| <a href="https://github.com/kubernetes/enhancements/tree/master{{ . }}">{{ . }}</a> | ||
| </li> | ||
| {{ end }} |
There was a problem hiding this comment.
This block generation logic may need a small tweak, because not all links in the KEP JSON seeAlso attribute point to the k/enhancements repo. Some refer to external sites or other repositories, and the current logic always renders them to the k/enhancements path, which results in 404 links. I have included a few examples below (Refer the Related KEPs section)
- https://deploy-preview-618--kubernetes-contributor.netlify.app/resources/keps/1281/
- https://deploy-preview-618--kubernetes-contributor.netlify.app/resources/keps/1965/
- https://deploy-preview-618--kubernetes-contributor.netlify.app/resources/keps/2332/
- https://deploy-preview-618--kubernetes-contributor.netlify.app/resources/keps/1152/
There was a problem hiding this comment.
Mmm, yes, let's avoid making an assumption about what this field is set to.
|
Thanks for the review @lmktfy , @dipesh-rawat , @TineoC - will ping you again once i made the requested changes, Thanks |
|
PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |

Summary
Closes #611
This PR adds individual pages for each KEP (Kubernetes Enhancement Proposal) that has progressed beyond the provisional stage. Pages are dynamically generated at build time using Hugo content adapters.
Changes
keps.jsondatalayouts/keps/)KEP Page Contents
Each generated page displays:
Implementation Notes
content/en/resources/keps/{kepNumber}.md