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.

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

Fix broken links to kubernetes docs on reference page #14340

Merged

Conversation

JinVei
Copy link
Contributor

@JinVei JinVei commented Sep 8, 2023

Proposed Changes

Knative serving-api reference page has some broken links to kubernetes docs. Just try to fix it.

Release Note

NONE

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 8, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@knative-prow knative-prow bot added area/test-and-release It flags unit/e2e/conformance/perf test issues for product features size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 8, 2023
@knative-prow
Copy link

knative-prow bot commented Sep 8, 2023

Welcome @JinVei! It looks like this is your first PR to knative/serving 🎉

@knative-prow
Copy link

knative-prow bot commented Sep 8, 2023

Hi @JinVei. Thanks for your PR.

I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

@dprotaso
Copy link
Member

dprotaso commented Sep 8, 2023

These docs are autogenerated using this script

-out-file "docs/serving-api.md" \

which uses this tool https://github.com/ahmetb/gen-crd-api-reference-docs

I wonder if the tool should be bumped?

@codecov
Copy link

codecov bot commented Sep 11, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01% ⚠️

Comparison is base (fb6997c) 86.11% compared to head (f857fef) 86.10%.
Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14340      +/-   ##
==========================================
- Coverage   86.11%   86.10%   -0.01%     
==========================================
  Files         196      196              
  Lines       14781    14781              
==========================================
- Hits        12728    12727       -1     
  Misses       1747     1747              
- Partials      306      307       +1     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nak3
Copy link
Contributor

nak3 commented Sep 11, 2023

The version v1.21 is defined in our template hack/reference-docs-gen-config.json so I think this PR LGTM.

If we will bump the tool's version, @JinVei could you please bump it? I think you can bump the version with the following command:

$ source vendor/knative.dev/hack/library.sh
$ go_update_deps --upgrade --domain  github.com/ahmetb

@nak3 nak3 added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 11, 2023
@JinVei
Copy link
Contributor Author

JinVei commented Sep 11, 2023

The version v1.21 is defined in our template hack/reference-docs-gen-config.json so I think this PR LGTM.

If we will bump the tool's version, @JinVei could you please bump it? I think you can bump the version with the following command:

$ source vendor/knative.dev/hack/library.sh
$ go_update_deps --upgrade --domain  github.com/ahmetb

Sure, i can do it.
Should i bump the tool's version in this PR? It seems like it also makes a lot of changes to the code in k8s.io/klog/v2 and k8s.io/gengo.

@krsna-m
Copy link
Contributor

krsna-m commented Sep 11, 2023

I think as long as it is in a different commit it should be fine

@dprotaso
Copy link
Member

based on @nak3's comment you can probably skip updating the tool and instead update the config here: https://github.com/knative/serving/blob/main/hack/reference-docs-gen-config.json

@JinVei
Copy link
Contributor Author

JinVei commented Sep 12, 2023

based on @nak3's comment you can probably skip updating the tool and instead update the config here: https://github.com/knative/serving/blob/main/hack/reference-docs-gen-config.json

Yes, I have replaced kubernetes-api/v1.21 with kubernetes-api/v1.28 in reference-docs-gen-config.json, and renew serving-api.md by running this script update-reference-docs.sh.

@nak3
Copy link
Contributor

nak3 commented Sep 12, 2023

/lgtm
/approve

Thank you @JinVei !

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Sep 12, 2023
@knative-prow
Copy link

knative-prow bot commented Sep 12, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JinVei, nak3

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

@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 12, 2023
@knative-prow knative-prow bot merged commit 3010cb8 into knative:main Sep 12, 2023
59 checks passed
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. area/test-and-release It flags unit/e2e/conformance/perf test issues for product features lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants