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

Content of 'One-page API Reference for v1.29' not rendering properly in dark mode #44572

Closed
tjamet opened this issue Dec 29, 2023 · 9 comments · Fixed by #44581
Closed

Content of 'One-page API Reference for v1.29' not rendering properly in dark mode #44572

tjamet opened this issue Dec 29, 2023 · 9 comments · Fixed by #44581
Assignees
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes kind/bug Categorizes issue or PR as related to a bug. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@tjamet
Copy link

tjamet commented Dec 29, 2023

This is a Bug Report

Problem:

Using chrome (120.0.6099.129 (Official Build) (x86_64)) on macOS (12.7.1 (21G920)) and hitting the single-page API reference link from the official API documentation, I hit the documentation for Kubernetes 1.29 and I can only see the navigation with the list of objects.

image

I have observed the same problem on safari ( 17.1.2 (17616.2.9.11.12, 17616)):
image

And Firefox (121.0 (64-bit)):
image

Proposed Solution:

Get the content back as in the 1.28 documentation:

image

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

@tjamet tjamet added the kind/bug Categorizes issue or PR as related to a bug. label Dec 29, 2023
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Dec 29, 2023
@dipesh-rawat
Copy link
Member

/retitle One-page API reference missing for Kubernetes v1.29

@k8s-ci-robot k8s-ci-robot changed the title Generated single page documentation is empty for kubernetes 1.29 One-page API reference missing for Kubernetes v1.29 Dec 29, 2023
@dipesh-rawat
Copy link
Member

The API reference for v1.29 was successfully generated in PR #44345, as evidenced by the verified information in the repository file. It appears that we're encountering a rendering glitch.

@dipesh-rawat
Copy link
Member

Upon further investigation, it seems that the page data isn't rendering correctly in dark mode (sort of). I switched my device/browser theme to light mode, and the page info became visible (Refer below screenshot). It seems like there might be some missing CSS and scripts causing this issue.

api-refence-light-mode

@dipesh-rawat
Copy link
Member

This is definitely something we should address.
(cc: @tengqm)

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 29, 2023
@dipesh-rawat
Copy link
Member

/retitle Content of 'One-page API Reference for v1.29' not rendering properly in dark mode

@k8s-ci-robot k8s-ci-robot changed the title One-page API reference missing for Kubernetes v1.29 Content of 'One-page API Reference for v1.29' not rendering properly in dark mode Dec 29, 2023
@tengqm
Copy link
Contributor

tengqm commented Dec 30, 2023

/assign

@tengqm
Copy link
Contributor

tengqm commented Dec 30, 2023

@dipesh-rawat The original description of the issue is proper and correct, I don't know why you are so akin to change these issue descriptions. I'm raising this question because when an issue title is changed, my email client won't treat the issues as the same one. The "conversation" mode no longer works. I'm receiving emails for every comment as a separate email. It is not a big deal but it is really annoying.

@sftim
Copy link
Contributor

sftim commented Dec 30, 2023

Ah, does the API reference have special support for dark mode, separate from #25061?

Assuming that this is the case:
/kind bug
/area web-development

A short-term fix would be to drop the dark mode support, pending an implementation that works right. Let's see if #44581 sorts it out.

@k8s-ci-robot k8s-ci-robot added the area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes label Dec 30, 2023
@sftim
Copy link
Contributor

sftim commented Dec 30, 2023

For what it's worth, I agree with the title change in #44572 (comment)

The bug was about dark mode rendering and not that the reference was completely missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes kind/bug Categorizes issue or PR as related to a bug. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants