Skip to content
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

Jump to bottom

Fix schema URL fragment in custom-resource-definitions.md #48321

Merged
merged 1 commit into from
Oct 15, 2024
Merged

Fix schema URL fragment in custom-resource-definitions.md #48321

merged 1 commit into from
Oct 15, 2024

Conversation

MikeSpreitzer
Copy link
Member

@MikeSpreitzer MikeSpreitzer commented Oct 13, 2024 •
edited
Loading

Description

This PR fixes the fragment in the URL for OpenAPI v3 schemas.

This is needed because GitHub changed the way it renders markdown into HTML, in particular how it renders multi-word anchors. This change was made over a year ago. The spec repo itself merged a PR that fixes the cross-references, OAI/OpenAPI-Specification#3548, 8 months ago.

Issue

Closes: #

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Oct 13, 2024
@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 13, 2024
@MikeSpreitzer MikeSpreitzer force-pushed the fix-schema-ref-fragment branch from b1834ad to 59f546c Compare October 13, 2024 17:47
@MikeSpreitzer
Copy link
Member Author

/cc @sttts
/cc @liggitt

@k8s-ci-robot k8s-ci-robot requested review from liggitt and sttts October 13, 2024 17:48
@netlify Netlify
Copy link

netlify bot commented Oct 13, 2024

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit b1834ad
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/670c06f5f4fef50008de7ca2
😎 Deploy Preview https://deploy-preview-48321--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify Netlify
Copy link

netlify bot commented Oct 13, 2024 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 60ff42b
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/670d4acba979ba0008f998aa
😎 Deploy Preview https://deploy-preview-48321--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@MikeSpreitzer
Copy link
Member Author

BTW, should this URL point to a specific tag of github.com/OAI/OpenAPI-Specification rather than main?

Should it point to 3.0.3 rather 3.0.0, since 3.0.3 advertises itself as a clarification of 3.0.0?

@tengqm
Copy link
Contributor

tengqm commented Oct 14, 2024

IMO, "main" is a moving target. Pinning to a specific tag would be good.

@MikeSpreitzer
Fix fragment in schema URL
60ff42b 
Also switched to a particular tag in the spec repo.
Also called out the minor release number in the text of the reference.

Signed-off-by: Mike Spreitzer <mspreitz@us.ibm.com>
@MikeSpreitzer MikeSpreitzer force-pushed the fix-schema-ref-fragment branch from 59f546c to 60ff42b Compare October 14, 2024 16:46
@MikeSpreitzer
Copy link
Member Author

Ready for another look. @Shubham82 , @tengqm .

@Shubham82
Copy link
Contributor

Thanks, @MikeSpreitzer The preview looks good to me.
https://deploy-preview-48321--kubernetes-io-main-staging.netlify.app/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#validation

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 14, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 2fbd7c8f88e4c2787365bb075ba03675166988aa

@tengqm
Copy link
Contributor

tengqm commented Oct 15, 2024

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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

The pull request process is described here

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 15, 2024
@k8s-ci-robot k8s-ci-robot merged commit 8097577 into kubernetes:main Oct 15, 2024
6 checks passed
@MikeSpreitzer MikeSpreitzer deleted the fix-schema-ref-fragment branch October 23, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deads2k deads2k Awaiting requested review from deads2k

@reylejano reylejano Awaiting requested review from reylejano

@liggitt liggitt Awaiting requested review from liggitt

@sttts sttts Awaiting requested review from sttts

Assignees

@Shubham82 Shubham82

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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@MikeSpreitzer @tengqm @Shubham82 @k8s-ci-robot