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

Improve use of space for docs #49387

Open
chbrandt opened this issue Jan 10, 2025 · 9 comments
Open

Improve use of space for docs #49387

chbrandt opened this issue Jan 10, 2025 · 9 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

@chbrandt
Copy link

chbrandt commented Jan 10, 2025

Documentation pages provide two tables of content: one -- on the left -- for the whole site, and the other -- on the right -- for the current document. For instance, I'm at Updating Configuration via a ConfigMap. The one on the right is using too much space and should be moved somewhere else (see screenshots); My suggestion is to move it also to the left, below/above the site's ToC.

Notice the amount of empty space on the (right side) pages that could be used for a better (reading) experience:

image

image

image

@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 Jan 10, 2025
@network-charles
Copy link
Contributor

This is a hugo theme called docsy.

@sftim
Copy link
Contributor

sftim commented Jan 10, 2025

/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 Jan 10, 2025
@chbrandt
Copy link
Author

Thanks for the info @network-charles . Using docsy example image, here is what I'm proposing:

Image

I never played with Hugo, but I understand those themes can be customised.
On the side: I took the chance to visit the themes gallery, Relearn seems to provide the layout I am proposing.

@network-charles
Copy link
Contributor

Oh, nice.

It’ll be great for you to discuss your proposal at the SIG Docs meeting tomorrow. Changing a theme is a major change from a UI/UX perspective. But if you are customizing the existing one then that's a minor change.

@AmarNathChary
Copy link
Contributor

Thanks for the info @network-charles . Using docsy example image, here is what I'm proposing:

Image

I never played with Hugo, but I understand those themes can be customised. On the side: I took the chance to visit the themes gallery, Relearn seems to provide the layout I am proposing.

It's a good idea. IMO the content length on the right side changes according to the pages we are in. We can have an extra slide bar for this WDYT?

@chbrandt
Copy link
Author

@network-charles

It’ll be great for you to discuss your proposal at the SIG Docs meeting tomorrow. Changing a theme is a major change from a UI/UX perspective. But if you are customizing the existing one then that's a minor change.

I miss that message in due time. Where do I find information for the next meeting?

@chbrandt
Copy link
Author

@AmarNathChary

We can have an extra slide bar for this WDYT?

Yes, that would work too. Even better, I'd say.

@network-charles
Copy link
Contributor

I miss that message in due time. Where do I find information for the next meeting?

https://kubernetes.slack.com/

After joining the workspace, join the #sig-docs channel. All the information you need are on the channel info section.

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

5 participants