Skip to content

fix links #1306

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

Merged
merged 25 commits into from
Nov 30, 2022
Merged

fix links #1306

merged 25 commits into from
Nov 30, 2022

Conversation

ElPaisano
Copy link
Contributor

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
Copy link
Contributor Author

ElPaisano commented Oct 14, 2022

(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 #### 3618641

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

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

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

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

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

/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
Copy link
Contributor Author

ElPaisano commented Oct 17, 2022

@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?

Copy link

@johndmulhausen johndmulhausen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/project/.swp seems like detritus

@johndmulhausen
Copy link

  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

@salmad3
Copy link
Contributor

salmad3 commented Oct 18, 2022

@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/

@ElPaisano
Copy link
Contributor Author

docs/project/.swp seems like detritus

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

@TMoMoreau
Copy link
Contributor

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.

Copy link
Contributor

@salmad3 salmad3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that the Doks theme is merged, we can update these links to be up-to-date instead of relying on redirects.

@ElPaisano
Copy link
Contributor Author

ElPaisano commented Nov 29, 2022

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

@salmad3
Copy link
Contributor

salmad3 commented Nov 29, 2022

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/

@ElPaisano
Copy link
Contributor Author

ElPaisano commented Nov 29, 2022

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 88eea40.

Link checker came back clean.

@ElPaisano ElPaisano marked this pull request as ready for review November 29, 2022 22:43
@ElPaisano ElPaisano requested a review from salmad3 November 29, 2022 22:45
Copy link
Contributor

@salmad3 salmad3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @ElPaisano!

Copy link
Contributor

@TMoMoreau TMoMoreau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@ElPaisano ElPaisano merged commit 16bb246 into ipfs:main Nov 30, 2022
@ElPaisano ElPaisano deleted the patch2 branch November 30, 2022 20:18
@ElPaisano ElPaisano restored the patch2 branch December 2, 2022 02:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants