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

Published 20 hours ago • verified publisher icon ipfs

fix links

Open ElPaisano opened this issue 3 years ago • 1 comments

This pr fixes various broken or incorrectly formatted links in the ipfs-docs repo.

The markdown-link-check tool was run against each .md file in the repo and any bad links were fixed.

ElPaisano avatar Oct 12 '22 03:10 ElPaisano

(I'll keep editing this comment as I have further questions)

@TMoMoreau Commenting here about links I'm unsure of:

ipfs-docs/docs/concepts/further-reading/academic-papers.md

Random notes about other pages: /ipfs-docs/docs/concepts/bitswap.md

  • I wasn't sure where the #want-list link (~line 13) was supposed to go and it was throwing an error, so I created a ## Want Lists subsection and pointed it there. LMK if that was the intention. Also, I updated the header depth because it was going from ## to #### https://github.com/ipfs/ipfs-docs/pull/1306/commits/3618641cc4f759dff979670cd650d476cb2cd575

/ipfs-docs/docs/concepts/case-study-audius.md

  • Line 61: http://www.simpleaswater.com appears to be unreachable. Could we use https://github.com/simpleaswater?

/ipfs-docs/docs/concepts/case-study-likecoin.md

  • Line 60: link to https://addons.mozilla.org/en-US/firefox/addon/liker-land/?src=search for the likecoin firefox returns an "oops we can't find that page". When I do a search for the Likecoin or like-land in the search bar, nothing comes up. Wondering if the extension is no longer supported, etc.?

/projects/ipfs-docs/docs/concepts/case-study-snapshot.md

  • line 98: https://shot.eth.link/ is returning an HTTP ERROR 524 when I hit it directly

/projects/ipfs-docs/docs/how-to/browser-tools-frameworks.md

  • line 12: https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/browser-browserify 404s. I don't see browser-browserify in the examples. Did it get moved? Could we link to https://github.com/browserify/browserify/tree/master/example instead?
  • line 16: https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/browser-parceljs 404s. Similar to browser, I don't see browser-parceljs in the examples. Did it get moved? Can we use https://github.com/ipfs-examples/js-ipfs-browser-parceljs

/projects/ipfs-docs/docs/how-to/create-simple-chat-app.md

  • Line 22: Link to live demo is 404ing https://ipfs.io/ipfs/bafybeia5f2yk6td7ciroeped2uwfivo333b524t3zmoderfhl3xn7wi7aa/&sa=D&source=editors&ust=1651157762663308&usg=AOvVaw1sQEgWa5q7YI8HnLTPUq0Y

/projects/ipfs-docs/docs/project/history.md

  • line 65: link to Kubo 0.5.0 release is 404ing. Anyone know where the blog post went? I couldn't find it on the blog website.

ElPaisano avatar Oct 14 '22 00:10 ElPaisano

@DannyS03 can you take a look at the links to the LibP2P docs from concepts/libp2p/? I was unsure about which pages to link to in a few cases. Basically just wondering if the updated links are the best spots to link to, or if you have other suggestions.

Also, in related (line 9 of the file), there's a link to https://docs.libp2p.io/examples/, which is busted. I looked in the LibP2P docs but couldn't figure out where it should go? Any thoughts?

The commit diff should have context https://github.com/ipfs/ipfs-docs/pull/1306/commits/398b050a733e40dd85bbb57095d0b3abf905afcf

Also, can you look at https://github.com/ipfs/ipfs-docs/pull/1306/commits/0faae2110206e29a14f2751364338ea47e8060fa#r997293840 and LMK if you have thoughts?

ElPaisano avatar Oct 17 '22 16:10 ElPaisano

  1. Want lists do not have any documentation of their own; in the docs themselves the paragraph that follows is the best reference we have for how they are structured and what they are. Therefore I'd just remove the link and leave the text plain.
  2. Likecoin's Firefox extension is definitely gone; no trace of it on Google or the add-on site on mozilla.org. Therefore I'd remove any mention of the Firefox extension.
  3. simpleaswater.com no longer exists and we're just quoting someone here so how about a joining of two smaller sentences with the callout to that site removed, like so: "We think about the IPFS and Filecoin community as a great role model for what we are doing with the community around Audius, in terms of activity and robustness," says Nagaraj, who calls out as particularly helpful..."
  4. shot.eth.link loaded for me in-browser and just forwards to shot.eth.limo, but only after a long while. I would just remove the mention of ...link, as they're both just ENS services.
  5. Use this link for Browserify: https://github.com/ipfs-examples/js-ipfs-browser-browserify The link you found for ParcelJS looks correct. However these both look like "todo" repos that are empty? If so, maybe these links should be removed for now.
  6. Use this: https://ipfs.io/ipfs/bafybeia5f2yk6td7ciroeped2uwfivo333b524t3zmoderfhl3xn7wi7aa/
  7. Use https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.5.md

johndmulhausen avatar Oct 17 '22 21:10 johndmulhausen

@DannyS03 can you take a look at the links to the LibP2P docs from concepts/libp2p/? I was unsure about which pages to link to in a few cases. Basically just wondering if the updated links are the best spots to link to, or if you have other suggestions.

Also, in related (line 9 of the file), there's a link to https://docs.libp2p.io/examples/, which is busted. I looked in the LibP2P docs but couldn't figure out where it should go? Any thoughts?

The commit diff should have context 398b050

Also, can you look at 0faae21#r997293840 and LMK if you have thoughts?

The missing redirect here will also be applied in the restructure PR. We had combined /tutorials/ and /examples/ under /tutorials/ -> https://docs.libp2p.io/tutorials/

salmad3 avatar Oct 18 '22 01:10 salmad3

docs/project/.swp seems like detritus

@johndmulhausen it spilled over from some python stuff I was working on, deleted from the project

ElPaisano avatar Oct 18 '22 17:10 ElPaisano

This looks mostly good to me, there are a few changes in here that aren't strictly link fixes, which should be fine so long as the changes are accurate.

There are also some libp2p link changes in here that @DannyS03 has requested be changed or left the way they were, I think it would be best to make those changes first, then we should be good to go here.

TMoMoreau avatar Nov 14 '22 16:11 TMoMoreau

Hey @DannyS03, I updated the links https://github.com/ipfs/ipfs-docs/pull/1306/commits/7f54aa20fff6e267cc19d4bebd7c7a9e8f629855.

However, markdown-link-check is showing 3 other busted links. Was wondering if it might have to do with the updated site.

  1. libp2p.md, line 38, "...The previous default of SECIO..." <- this link is 404ing. Should this just point to https://docs.libp2p.io/concepts/secure-comms/overview?

  2. libp2p.md, line 58, "...using core Libp2p abstractions like transport,.." <- 404ing. Heads up, I also see that link in https://docs.libp2p.io/concepts/fundamentals/protocols/ ("...The kind of protocols this article is concerned with are the ones built with libp2p itself, using the core libp2p abstractions like transport, peer identity, addressing, and so on.") and it's 404ing as well. Same link is 404ing in line 32 of libp2p.md

  3. libp2p.md, line 9 "Examples of Libp2p key features': https://docs.libp2p.io/examples/" <- 404ing, unsure from looking at the new site where this is supposed to go now

ElPaisano avatar Nov 29 '22 17:11 ElPaisano

Hey @DannyS03, I updated the links 7f54aa2.

However, markdown-link-check is showing 3 other busted links. Was wondering if it might have to do with the updated site.

  1. libp2p.md, line 38, "...The previous default of SECIO..." <- this link is 404ing. Should this just point to https://docs.libp2p.io/concepts/secure-comms/overview?
  2. libp2p.md, line 58, "...using core Libp2p abstractions like transport,.." <- 404ing. Heads up, I also see that link in https://docs.libp2p.io/concepts/fundamentals/protocols/ ("...The kind of protocols this article is concerned with are the ones built with libp2p itself, using the core libp2p abstractions like transport, peer identity, addressing, and so on.") and it's 404ing as well. Same link is 404ing in line 32 of libp2p.md
  3. libp2p.md, line 9 "Examples of Libp2p key features': https://docs.libp2p.io/examples/" <- 404ing, unsure from looking at the new site where this is supposed to go now

Hey @ElPaisano, nice. For some of the redirects, strange as we have included them in the aliases.

  1. Yes
  2. We can link Transports to concepts/transports/overview/
  3. This should be "guides", https://docs.libp2p.io/guides/

salmad3 avatar Nov 29 '22 21:11 salmad3

Hey @ElPaisano, nice. For some of the redirects, strange as we have included them in the aliases.

Yes We can link Transports to concepts/transports/overview/ This should be "guides", https://docs.libp2p.io/guides/

Updated in https://github.com/ipfs/ipfs-docs/pull/1306/commits/88eea40f5a9f65385aa75e134e8a3cffe121f346.

Link checker came back clean.

ElPaisano avatar Nov 29 '22 22:11 ElPaisano