website icon indicating copy to clipboard operation
website copied to clipboard

Two hamburger buttons

Open 532910 opened this issue 5 years ago • 31 comments

I believe two hamburger buttons confuses users on https://kubernetes.io/docs/home

image

532910 avatar Jun 23 '20 22:06 532910

Hi @532910

My guess is that there are a few different approaches to address this. What should solutions focus on?

sftim avatar Jun 23 '20 23:06 sftim

Hi, my idea is replacing the second hamburger icon from the top with a caret icon (▼/▲).

This is an example of using fa-caret-up and fa-caret-down of Font Awesome (ref. Triangle Icons | Font Awesome):

hamburger & caret icon top

initial collapsed state fa-caret-down

expanded state fa-caret-up

Why I replace the second one Because it's more common there is a hamburger icon on the top right corner.

Why I chose the caret (triangle) icon When we tap the icon, the TOC area moves up and down with animation. Its move fits the triangle shape. I think the shape can imply the motion of up and down, so it's more intuitive.

shuuji3 avatar Jun 24 '20 06:06 shuuji3

First of all, the second hamburger button is related to the documentation and must not be grouped with the search field. The search field is related to the whole site and must be above documentation section. Ths second hamburger button is the TOC for documentation and must be placed the same line as Documentation The triangle button should be nice for this.

image

532910 avatar Jun 24 '20 09:06 532910

I like this modification. It sounds reasonable to me.

Putting a search box on the header allows users to search soon because it is always shown on the header. Currently, we cannot see the search box after scrolling the page, so we need to scroll the page to the top.

shuuji3 avatar Jun 24 '20 10:06 shuuji3

Consider basing the UI for the lower menu on <details> from HTML5.

(Maybe even use <details>)

sftim avatar Jun 24 '20 10:06 sftim

/kind bug /priority backlog

sftim avatar Jun 24 '20 21:06 sftim

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

fejta-bot avatar Sep 22 '20 21:09 fejta-bot

Still looks odd.

532910 avatar Oct 08 '20 04:10 532910

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle rotten

fejta-bot avatar Nov 07 '20 04:11 fejta-bot

/remove-lifecycle rotten

532910 avatar Nov 14 '20 21:11 532910

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale

fejta-bot avatar Feb 12 '21 21:02 fejta-bot

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten

fejta-bot avatar Mar 14 '21 22:03 fejta-bot

/remove-lifecycle rotten /area web-development

sftim avatar Mar 15 '21 09:03 sftim

I tried to use <details> and <summary> elements. What do you think about the below design?

Screenshot

Before a tap:

After a tap: (intentionally elipsising several elements)

shuuji3 avatar Mar 15 '21 09:03 shuuji3

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale

fejta-bot avatar Jun 13 '21 10:06 fejta-bot

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten

fejta-bot avatar Jul 13 '21 10:07 fejta-bot

/lifecycle frozen

sftim avatar Jul 13 '21 10:07 sftim

/remove-lifecycle rotten

sftim avatar Jul 13 '21 10:07 sftim

/assign kLamda

kLamda avatar Sep 09 '21 12:09 kLamda

@shuuji3 did you have a pull request for this?

sftim avatar Oct 03 '21 17:10 sftim

This is a great issue for anyone to work on. It'd be great to see progress here.

sftim avatar Oct 03 '21 17:10 sftim

@sftim No, I have not prepared a PR for this issue. The above screenshot was a just experiment on the browser. I'm glad if someone can work on.

@kLamda do you have a time to work on this issue?

shuuji3 avatar Oct 05 '21 03:10 shuuji3

Yeah, sure I have time time to work on this issue.

kLamda avatar Oct 05 '21 03:10 kLamda

Thank you! 🙂 Maybe I can post the html snippet I tried in the experiment later.

shuuji3 avatar Oct 05 '21 03:10 shuuji3

I tried to replicate the above "Table of Contents" screenshot again. Here is the difference of HTML structure:

Before change current-html

After change after-change

I created a new <details> and <summary> elements and moved the <nav id="td-section-nav"> element next to the <summary> element inside the <details> like this:

<details open="">
  <summary>Table of Contents</summary>
  <nav id="td-section-nav">...</nav>
</details>

In addition to this change, I think we need some modifications of classes and the second hamburger buttons etc.

I hope this would be helpful.

ref. <details>: The Details disclosure element - HTML: HyperText Markup Language | MDN

shuuji3 avatar Oct 05 '21 09:10 shuuji3

We ought to sort this. /priority important-longterm /remove-priority backlog

sftim avatar Sep 14 '22 21:09 sftim

/triage accepted

sftim avatar Oct 29 '22 13:10 sftim

I'd like to give this a try, This hasn't been fixed yet. @sftim can this issue be reassigned due to inactivity?

Gauravpadam avatar Aug 11 '23 01:08 Gauravpadam

I'd like to give this a try, This hasn't been fixed yet. @sftim can this issue be reassigned due to inactivity?

For Kubernetes SIG Docs, anyone can work on any issue (our more jargon-y way of saying this is “no cookie licking”) and open a pull request to propose a related change.

sftim avatar Oct 27 '23 14:10 sftim

Also see: https://github.com/kubernetes/website/issues/41171

sftim avatar Oct 10 '24 23:10 sftim