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

Issue with k8s.io/docs/home/ Example buttons do not work #16542

Closed
rschooley opened this issue Sep 25, 2019 · 11 comments · Fixed by #16569
Closed

Issue with k8s.io/docs/home/ Example buttons do not work #16542

rschooley opened this issue Sep 25, 2019 · 11 comments · Fixed by #16569
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/critical-urgent Highest priority. Must be actively worked on as someone's top priority right now.

Comments

@rschooley
Copy link

This is a Bug Report

Problem:
The "kubectl example" and "curl example" buttons do not currently work.

Bootstrap fails to load and I'm guessing the toggle for the details panel is handled by that.

Proposed Solution:
Make sure the file is deployed: https://kubernetes.io/js/bootstrap-3.3.7.min.js
or just use a CDN

Page to Update:
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.16

Additional Information
Screen Shot 2019-09-24 at 11 41 54 PM

@savitharaghunathan
Copy link
Member

/kind bug

@k8s-ci-robot k8s-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Sep 25, 2019
@savitharaghunathan
Copy link
Member

1.16 is pointing to 3.3.7. Updating it to point to v4.3.1 (https://kubernetes.io/js/bootstrap-4.3.1.min.js )should make these buttons work.

@mcbenjemaa
Copy link
Member

mcbenjemaa commented Sep 25, 2019

Yes should work but the change must be made in the api reference generator

@mcbenjemaa
Copy link
Member

/assign

@aimeeu
Copy link
Contributor

aimeeu commented Sep 25, 2019

@medmedchiheb Thanks for assigning this to yourself! I'm not very familiar with the kubernetes-incubator/reference-docs. Is it possible to point to a CDN instead of updating bootstrap.min.js ? Also, updating reference-docs is the long-term fix. Since the process of generating the API docs is started manually, how do we update the content in kubernetes/website/static/docs/reference/generated/kubernetes-api?

@mcbenjemaa
Copy link
Member

mcbenjemaa commented Sep 25, 2019

It's just a quick fix, as you can see from the template.
And then you can test by executing update-imported-docs

https://github.com/kubernetes-incubator/reference-docs/blob/88f6483855ac68ee6041cd8e90169f7f5268dc2b/gen-apidocs/generators/html.go#L604

@sftim
Copy link
Contributor

sftim commented Sep 26, 2019

/priority backlog
(definitely worth fixing though)

@k8s-ci-robot k8s-ci-robot added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Sep 26, 2019
@aimeeu
Copy link
Contributor

aimeeu commented Sep 26, 2019

this is two-fold: 1) update the code in the kubernetes-incubutor/reference-docs project (longterm fix); and 2) update kubernetes/website/static..... See Slack thread

@mcbenjemaa
Copy link
Member

already fixed bootstrap version

https://github.com/kubernetes-incubator/reference-docs/blob/6c1496ba33b6aed9ab6af886412e8487f534194e/gen-apidocs/generators/html.go#L604

@aimeeu
Copy link
Contributor

aimeeu commented Sep 26, 2019

/remove-priority backlog
/priority critical-urgent

Updating the current generated API doc index.html is critical because the buttons don't work (see #16263 for v1.15). Long-term fix has already been added to kubernetes-incubator/reference-docs.

@k8s-ci-robot k8s-ci-robot added priority/critical-urgent Highest priority. Must be actively worked on as someone's top priority right now. and removed priority/backlog Higher priority than priority/awaiting-more-evidence. labels Sep 26, 2019
@sftim
Copy link
Contributor

sftim commented Sep 26, 2019

/lifecycle active

@k8s-ci-robot k8s-ci-robot added the lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. label Sep 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/critical-urgent Highest priority. Must be actively worked on as someone's top priority right now.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants