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 links in API reference docs #9795

Merged
merged 1 commit into from
Aug 20, 2018

Conversation

tengqm
Copy link
Contributor

@tengqm tengqm commented Aug 9, 2018

This PR fixes the links generated in the API reference docs.

Closes: #9649, #9748

This PR fixes the links generated in the API reference docs.
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 9, 2018
@k8sio-netlify-preview-bot
Copy link
Collaborator

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 56bef56

https://deploy-preview-9795--kubernetes-io-master-staging.netlify.com

@xiangpengzhao
Copy link
Contributor

Hi @tengqm, I wonder how the files are generated. Thanks! ref: #9756 (comment)

@tengqm
Copy link
Contributor Author

tengqm commented Aug 9, 2018

@xiangpengzhao refer to: kubernetes-incubator/reference-docs project. The logic fixed is in PR kubernetes-sigs/reference-docs#55

If you want to generate the api references locally, clone the repo, review the first few lines of the Makefile and then do make api. The generated files are located under gen-apidocs/generators/build/.

@xiangpengzhao
Copy link
Contributor

@tengqm Thanks! Awesome!

@bradtopol
Copy link
Contributor

Assigning @zacharysarah I believe this is all correct but its such a huge change I think @zacharysarah should take a look.

@zacharysarah
Copy link
Contributor

@tengqm Thanks for this! ✨

/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zacharysarah

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 Aug 20, 2018
@k8s-ci-robot k8s-ci-robot merged commit 10d0c34 into kubernetes:master Aug 20, 2018
rosti pushed a commit to rosti/website that referenced this pull request Aug 23, 2018
This PR fixes the links generated in the API reference docs.
krmayankk pushed a commit to krmayankk/kubernetes.github.io that referenced this pull request Aug 28, 2018
This PR fixes the links generated in the API reference docs.
krmayankk pushed a commit to krmayankk/kubernetes.github.io that referenced this pull request Aug 28, 2018
This PR fixes the links generated in the API reference docs.
@tengqm tengqm deleted the fix-api-ref-doc branch July 5, 2020 02:07
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. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Webhook API type not documented
6 participants