ipfs-webui icon indicating copy to clipboard operation
ipfs-webui copied to clipboard

feat: improve repo size labels and explanation

Open lidel opened this issue 6 years ago • 9 comments

cc https://github.com/ipfs-shipyard/ipfs-webui/issues/1042, https://github.com/ipfs-shipyard/ipfs-webui/issues/629

MFS can store files in "lazy" fashion, which means root is added to MFS, but children are fetched lazily, on first use.

Example

English wikipedia mirror is ~650 GB. Lazy pointer to it can be added to MFS instantly via:

$ ipfs files cp /ipfs/QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco /en.wikipedia-on-ipfs.org

Problem

This feature of MFS creates a problem in WebUI, it looks like "Files" take more space than "entire repo":

Screenshot_2019-10-11  cohosting full - Files - IPFS

This will become a problem when we start taking advantage of this lazy mode in website cohosting (discussed in https://github.com/ipfs-shipyard/cohosting/issues/6)

Solution?

We need to change the labels, make them more informative. Below is a quick mock that illustrates what additional information needs to be conveyed. The problem is that it does not look good, and we need to clean this up somehow.

Screenshot_2019-10-11  cohosting full - Files - IPFS(1)

Thoughts?

lidel avatar Oct 11 '19 11:10 lidel

A few ideas which hopefully reflect the state of affairs accurately …

A - Modify two labels

Change the third and fourth labels to "all blocks" and "local repo" respectively, to help explain why the "files" number might be larger. Artboard Copy 3

B - A plus a hover-triggered explainer panel

Add a feature which offers the user text explaining more about the numbers Artboard Copy

C - A plus a click-triggered panel

Similar to above Artboard Copy 2

If B or C seem worthwhile and tests well (test? yes let's!), i'll design the full panel. If none fit the bill, we can try something else …

ericronne avatar Oct 11 '19 17:10 ericronne

I'd go with B or C: we really need an explainer for these values. We already have a lot of whitespace on the top of Files screen, so B may save space, but I have no strong feelings here.

@ericronne small clarification: value behind blocks is "the number of blocks" (I have over 600 000 of blocks in my repo). The all blocks label suggests value represents total size used by blocks, but that value is already under local repo. Perhaps we should rename "pins" and "blocks" to something like # of blocks and # of pins to make it clear its not size, but a number of items?

lidel avatar Oct 14 '19 12:10 lidel

I wonder if simply removing all would help.

B

Artboard Copy

C

Artboard Copy 2

C feels more user friendly to me, but creates slightly more visual noise.

ericronne avatar Oct 14 '19 21:10 ericronne

Yup, dropping all is better :+1: I also would go with C, just for clarity's sake: B introduces problem of having 2019-10-15--01-20-40 and 2019-10-15--01-20-59 pretty close to each other.

lidel avatar Oct 14 '19 23:10 lidel

Do we have a panel design? If not, I’ll handle...

ericronne avatar Oct 15 '19 16:10 ericronne

Not sure: we have a similar expandable thingy () on Settings screen:

Screenshot_2019-10-15 Settings - IPFS

when clicked it expands inline:

Screenshot_2019-10-15 Settings - IPFS(1)

We probably should have consistent design in both places (keep/update both), or change > to something else

lidel avatar Oct 15 '19 17:10 lidel

I dont think this is a bug. It maybe confusing and need some UI adjust but behavior is correct.

hsn10 avatar Mar 31 '21 00:03 hsn10

I personally like the B approach but would prefer a pattern of tooltip over numbers for more information.

@juliaxbow what do you think?

SgtPooki avatar Dec 05 '22 22:12 SgtPooki

We will move forward with the C approach previously discussed: image

SgtPooki avatar Jul 06 '23 20:07 SgtPooki