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

UI Improvement for k8s.io/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro/ #47076

Open
gsarkardev opened this issue Jul 3, 2024 · 5 comments
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@gsarkardev
Copy link

I am learning Kubernetes from the available documentation. When browsing through tutorials of this good quality, the medium and the way content is formatted becomes crucial for the learner. But I see that ~ 40% or more of the available screen estate is consumed by the very unnecessary section of "Edit this page, Create child page..." etc. Please refer to the marked portion in the screenshot attached to clearly pinpoint the section I'm talking about. The specific page is https://kubernetes.io/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro/.

I feel the section instead of consuming almost half of the page, can be easily moved down at the bottom or moved up to the up of a tutorial. This allows for a better zoomed - in experience as well as a cleaner and more optimal layout when at normal zoom levels.

Screenshot from 2024-07-03 19-34-38

@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jul 3, 2024
@dipesh-rawat
Copy link
Member

Page reported in issue: https://kubernetes.io/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro/
/area web-development

@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 Jul 3, 2024
@dipesh-rawat
Copy link
Member

The side menu with "Edit this page" options are features of the Docsy theme used by the site. Moving them below the page might not be very practical or feasible. While it is possible to adjust the padding and alignment, I'm concerned about the impact on other pages. The current layout looks good to me, but I'm open to improvements if others have suggestions.

@gsarkardev
Copy link
Author

I understand that you might consider changes if others have suggestions.

... I'm concerned about the impact on other pages.

Considering that I'm new to Kubernetes, and not necessarily would have visited other pages, would you mind sharing what is your concern about the impact on other pages?

@aj11anuj
Copy link
Member

The blank white sidebar that you are referring to is utilized on other pages to navigate the headings of that page, see below -

Screenshot (10350)

  • Changing or removing the yellow section can break the site's structure.
  • Removing the sidebar may make some pages look empty that contain less content.
  • The documentation site is responsive and doesn't cause viewing or reading issues on different devices.

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 needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

4 participants