Skip to content

feat: use path field from keps.json for KEP README URLs - #804

Open
TineoC wants to merge 3 commits into
kubernetes:mainfrom
TineoC:fix/kep-use-directory-field
Open

feat: use path field from keps.json for KEP README URLs#804
TineoC wants to merge 3 commits into
kubernetes:mainfrom
TineoC:fix/kep-use-directory-field

Conversation

@TineoC

@TineoC TineoC commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Prefers path field from keps.json over owningSig/name for README URLs.

Also fixes two bugs where the fallback README.MD URL and relative link/image path resolution still used the old owningSig/name pattern instead of $kepPath — these were broken for nested KEPs (depth 3+ paths like sig-cloud-provider/azure/2328-ccm-instance-metadata).

Depends on: kubernetes/enhancements#6225

Pages to test:

Verify these render correctly on the deploy preview:

Page Type Path pattern Expected
https://deploy-preview-804--kubernetes-contributor.netlify.app/resources/keps/1040/ Non-nested (depth 2) sig-api-machinery/1040-priority-and-fairness README loads (no regression)
https://deploy-preview-804--kubernetes-contributor.netlify.app/resources/keps/2328/ Nested (depth 3) sig-cloud-provider/azure/2328-ccm-instance-metadata README loads (was broken, now fixed)
https://deploy-preview-804--kubernetes-contributor.netlify.app/resources/keps/2500/ Nested (depth 3) sig-cluster-lifecycle/kubeadm/2500-kubeadm-join-control-plane-workflow README loads (was broken, now fixed)
https://deploy-preview-804--kubernetes-contributor.netlify.app/resources/keps/586/ Nested with images sig-cloud-provider/azure/586-azure-availability-zones Relative images/links resolve correctly
https://deploy-preview-804--kubernetes-contributor.netlify.app/resources/keps/667/ Nested with images sig-cloud-provider/azure/667-out-of-tree-azure Relative images/links resolve correctly
https://deploy-preview-804--kubernetes-contributor.netlify.app/resources/keps/ KEP listing All 649 KEPs listed with correct links

Note: Maximum nesting depth in keps.json is 3 (sig/subdir/kep-name). No depth 4+ KEPs exist in the current data.

Deploy preview: https://deploy-preview-804--kubernetes-contributor.netlify.app

@kubernetes-prow
kubernetes-prow Bot requested a review from mrbobbytables June 24, 2026 21:05
@kubernetes-prow kubernetes-prow Bot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 24, 2026
@kubernetes-prow
kubernetes-prow Bot requested a review from palnabarun June 24, 2026 21:05
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: TineoC

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 24, 2026
@TineoC

TineoC commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

/hold until k/enhancements PR is approved

@kubernetes-prow kubernetes-prow Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 24, 2026
@kubernetes-prow kubernetes-prow Bot added the language/en Issues or PRs related to English language label Jul 14, 2026
@TineoC
TineoC force-pushed the fix/kep-use-directory-field branch from 98836d3 to 675c712 Compare July 14, 2026 16:39
@TineoC TineoC changed the title feat: use directory field for KEP README URLs feat: use path field from keps.json for KEP README URLs Jul 14, 2026
@TineoC

TineoC commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

/retest all

@kubernetes-prow

Copy link
Copy Markdown
Contributor

@TineoC: No presubmit jobs available for kubernetes/contributor-site@main

Details

In response to this:

/retest all

Instructions 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.

@TineoC

TineoC commented Jul 18, 2026

Copy link
Copy Markdown
Contributor Author

/unhold

@kubernetes-prow kubernetes-prow Bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 18, 2026
@TineoC

TineoC commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

This is ready to merge

cc. @lmktfy @jberkus

@Prajyot-Parab

Copy link
Copy Markdown
Member

/lgtm
/hold for @lmktfy @jberkus

@kubernetes-prow kubernetes-prow Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 11, 2026
@kubernetes-prow kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants