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.

Sign up for GitHub

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

Jump to bottom

[META] Changing language around pinning #742

Closed
lidel opened this issue Jul 26, 2019 · 3 comments · Fixed by #997
Closed

[META] Changing language around pinning #742

lidel opened this issue Jul 26, 2019 · 3 comments · Fixed by #997
Assignees
@lidel @jessicaschilling @rafaelramalho19
Labels
area/pinning Integrating pinning into GUI apps effort/days Estimated to take multiple days, but less than a week exp/intermediate Prior experience is likely helpful kind/maintenance Work required to avoid breaking changes or harm to project's status quo need/analysis Needs further analysis before proceeding P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/design-content Content design, writing, information architecture topic/design-ux UX strategy, research, not solely visual design

Comments

@lidel
Copy link
Member

lidel commented Jul 26, 2019 •
edited by jessicaschilling
Loading

Note: This issue is part of a larger pinning service integration epic undertaken spring/summer 2020.

ETA April 2020

Important! Whatever we do here needs to be in alignment with decisions made in the larger-level issue ipfs/ipfs-gui#10

Changing language around some features

We are at the stage where we need to rework language around some features provided by IPFS Companion. Current labels describe what happens at the technical level and don't tell much about the purpose unless user is already familiar with low level details of our stack.

Motivation

Pinning keeps the data you care about from being purged when garbage collection happens.

It is a low level concept that does not have good UX when translated to GUI.
User is unable to assign label or manage pins in efficient manner: it is just a simple on/off toggle presented in browser action menu for an active browser tab:

2019-07-26-115906_599x33_scrot:

We plan to move "pinning" from using ipfs pin API to copying content to be "pinned" into MFS. This will keep content from being purged by GC (presence in MFS acts as implicit pin) and let user to manage "pinned" content via "Files" screen in Web UI.

The problem is, if we continue using "pin" metaphor after that change happens, we will introduce a lot of confusion (no longer ipfs pin), especially when Web UI decides to show resources pinned with ipfs pin API at some point.

Changes to explore

When pinning via IPFS Companion switches to MFS we should stop calling ipfs pin and remove "pin" from UI related to this feature. This means we need a different name for this.

Replace "pin" with other term and stick to it in our UI.

In discussion about DNSLink websites @olizilla suggested something like "make this [..] available offline and re-host it" (#710 (comment)). It is a short and simple way of describing what happens without going into technicalities.

I imagine we would replace "Pin IPFS Resource" with either:

  • something along lines "Persist and co-host this", "Keep co-hosting this", "Co-host this"
  • we could also have explicit "Copy to My Files", "Copy to my Drive" (I don't want to use "MFS" in UI..), however it is one-off action that does not emphasize we persist and co-host

Would appreciate some UX help on fleshing out details of this.
@lidel lidel added topic/design-ux UX strategy, research, not solely visual design UX labels Jul 26, 2019
@lidel lidel mentioned this issue Jul 26, 2019
Closed
@ericronne ericronne added the topic/design-visual Visual design ONLY, not part of a larger UX effort label Jul 26, 2019
@lidel
Copy link
Member Author

lidel commented Aug 20, 2019

cc design discussion about MFS-based website cohosting: ipfs/ipfs-desktop#1034

@jessicaschilling jessicaschilling added topic/design-content Content design, writing, information architecture and removed topic/design-ux UX strategy, research, not solely visual design topic/design-visual Visual design ONLY, not part of a larger UX effort UX labels Mar 30, 2020
@jessicaschilling jessicaschilling added exp/intermediate Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week kind/maintenance Work required to avoid breaking changes or harm to project's status quo need/analysis Needs further analysis before proceeding P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/design-ux UX strategy, research, not solely visual design labels Apr 7, 2020
@jessicaschilling
Copy link
Contributor

ETA: We also need to consider larger thoughts around MFS "pinning" vs low-level pinning and how we actually want to present this to GUI users: ipfs/ipfs-gui#10

@jessicaschilling jessicaschilling added the area/pinning Integrating pinning into GUI apps label May 28, 2020
@jessicaschilling jessicaschilling changed the title Changing language around Pinning [META] Changing language around pinning May 28, 2020
@jessicaschilling
Copy link
Contributor

@lidel and @rafaelramalho19 -- moving this into the pinning integration epic for the sake of incorporating what we can from this discussion. Just FYI 😊

@jessicaschilling jessicaschilling mentioned this issue Sep 8, 2020
Closed
12 tasks
lidel added a commit that referenced this issue May 7, 2021
@lidel
feat: replace pinning with import to mfs
887e53e 
This changes the way IPFS content is kept around.
Instead of using low level pins we copy the item to MFS,
unifying experience to match recent changes in ipfs-webui v2.12
and ipfs-desktop v0.15.0

This also removed page-action, because it was Firefox-specific feature
and made maintenance and testing more difficult
(now we have same UX in all browsers).

Closes #742
Closes #888
Closes ipfs/ipfs-gui#91
@lidel lidel mentioned this issue May 7, 2021
Merged
lidel added a commit that referenced this issue May 10, 2021
@lidel @jessicaschilling
feat: replace pinning with import to mfs (#997)
7aba6d9 
This changes the way IPFS content is kept around.
Instead of using low level pins we copy the item to MFS,
unifying experience to match recent changes in ipfs-webui v2.12:
https://github.com/ipfs/ipfs-webui/releases/v2.12.0
and ipfs-desktop v0.15.0:
https://github.com/ipfs/ipfs-desktop/releases/tag/v0.15.0

This also removed page-action, because it was Firefox-specific feature
and made maintenance and testing more difficult
(now we have same UX in all browsers).

Closes #742
Closes #888
Closes ipfs/ipfs-gui#91

Co-authored-by: Jessica Schilling <jessica@protocol.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lidel lidel

@jessicaschilling jessicaschilling

@rafaelramalho19 rafaelramalho19

Labels
area/pinning Integrating pinning into GUI apps effort/days Estimated to take multiple days, but less than a week exp/intermediate Prior experience is likely helpful kind/maintenance Work required to avoid breaking changes or harm to project's status quo need/analysis Needs further analysis before proceeding P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/design-content Content design, writing, information architecture topic/design-ux UX strategy, research, not solely visual design
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: replace pinning with import to mfs ipfs/ipfs-companion
4 participants
@lidel @jessicaschilling @ericronne @rafaelramalho19