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

Rewrite "Simple chat app" tutorial #1459

Closed
2color opened this issue Jan 27, 2023 · 8 comments
Closed

Rewrite "Simple chat app" tutorial #1459

2color opened this issue Jan 27, 2023 · 8 comments
Assignees
Labels
dif/medium 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 P1 High: Likely tackled by core team if no one steps up P2 Medium: Good to have, but can wait until someone steps up

Comments

@2color
Copy link
Member

2color commented Jan 27, 2023

Background

The impressive peer-to-peer chat app guide that @TheDiscordian created is no longer functional for several reasons:

Both impose severe impediments on browser-to-browser connectivity with libp2p — which, as it stands, is currently unsupported libp2p/js-libp2p#1462.

What can we do?

Informing readers about the limitation is vital here — let's ensure we set the right expectations.

May be helpful to link to the libp2p connectivity page for this.

@2color 2color added the need/triage Needs initial labeling and prioritization label Jan 27, 2023
@TheDiscordian
Copy link
Member

TheDiscordian commented Jan 27, 2023

The issue with CircuitRelayV1 has a warning header here: https://docs.ipfs.tech/how-to/create-simple-chat-app/#p2p-circuit

The WebRTC-Star section should likely be completely removed. The information is accurate though, and if anyone clicks one of the WebRTC-Star links they get a very clear warning.

If we add warnings about both of these we'll need a solution to add that actually works today, or to me it'd make more sense to hide or remove the guide for now. The guide is useful, but it's not really useful today because the things it talks about don't really work anymore.

@2color
Copy link
Member Author

2color commented Jan 27, 2023

The guide is useful, but it's not really useful today because the things it talks about don't really work anymore.

My suggestion would be to remove it for now (with a heavy heart because it was such a great example). We still have it on the blog, but by being in the docs, we're setting users up for failure.

In the mid-term, I'd suggest we follow the work on Helia and CircuitRelayV2 for browser-to-browser connectivity. Once we have some more tooling to do browser-to-browser connectivity maybe we can overhaul the guide.

@guseggert guseggert added P2 Medium: Good to have, but can wait until someone steps up and removed need/triage Needs initial labeling and prioritization labels Jan 30, 2023
@ElPaisano
Copy link
Contributor

Step 1: Suggestion is to remove this tutorial
Step 2: @TMoMoreau to sync with @TheDiscordian about new tutorial, blog post

@ElPaisano ElPaisano added the P1 High: Likely tackled by core team if no one steps up label Jan 30, 2023
@ElPaisano
Copy link
Contributor

ElPaisano commented Jan 30, 2023

@TMoMoreau I think that Step 1 (remove the outdated tutorial, and maybe add a redirect somewhere so that it doesn't just 404) should be done as soon as possible, since it's outdated. Is that something you think you can get to today? Then, can work on Step 2 a little more leisurely

Labeled the issue P1 and P2 to indicate this thought, that it's 2 tasks of different priorities. Thoughts?

@ElPaisano ElPaisano assigned ElPaisano and TMoMoreau and unassigned ElPaisano Jan 30, 2023
@ElPaisano
Copy link
Contributor

ElPaisano commented Jan 30, 2023

Suggestion for step 1:

  • add banner about tutorial being "archived"
  • Remove from main site navigation but don't delete
  • Redirect away from this page for the moment

@ElPaisano
Copy link
Contributor

ElPaisano commented Jan 30, 2023

Edit: Reread this issue and realize the note added in 1466 doesn't address this issue... so nvr mind, I would vote to remove this

Update: #1466 should address Part 1 of this, so we can just leave the tutorial as is for the moment.

@2color 2color added this to the 1/27/23 - 2/3/23 milestone Jan 31, 2023
@johnnymatthews johnnymatthews moved this to Needs triage in Protocol Docs Feb 6, 2023
@TMoMoreau TMoMoreau added kind/maintenance Work required to avoid breaking changes or harm to project's status quo dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week labels Feb 7, 2023
@TMoMoreau
Copy link
Contributor

With step 1 of this issue finished, I added new labels for step 2.

  • Add banner/warning to the current tutorial indicating that it is outdated.
  • Create new tutorial that will actually work if someone tries to follow it.

Unsure about the priority of the second step at the moment, this can be discussed here or in a sync.

@TMoMoreau TMoMoreau moved this from 👣 Needs triage to 📋 Backlog in Protocol Docs Feb 7, 2023
@TMoMoreau TMoMoreau moved this from 📋 Backlog to 👣 Needs triage in Protocol Docs Feb 7, 2023
@TMoMoreau TMoMoreau moved this from 👣 Needs triage to 📋 Backlog in Protocol Docs Feb 7, 2023
@TMoMoreau TMoMoreau changed the title Add clarification to the simple chat app Rewrite "Simple chat app" tutorial Feb 7, 2023
@2color
Copy link
Member Author

2color commented Mar 7, 2023

Closing this in favour of libp2p/universal-connectivity#1

@2color 2color closed this as completed Mar 7, 2023
@johnnymatthews johnnymatthews moved this from 📋 Backlog to ✅ Done in Protocol Docs Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/medium 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 P1 High: Likely tackled by core team if no one steps up P2 Medium: Good to have, but can wait until someone steps up
Projects
None yet
Development

No branches or pull requests

5 participants