docs: Gatsby-link package not showing up in plugins and old docs

[endormi]

Description

I've been trying to find the gatsby-link package inside the plugin list, not finding it (other packages are there). This also seems to be old docs, because it's not showing anywhere probably due to gatsby-link not showing in the plugins list.

Expected result

Gatsby-link not found in plugins and found README.md

Actual result

Can't find neither of them.

If this ends up needing to be fixed, I'm more than happy to work on this.
If this is how it is supposed to be, feel free to close this.

[sidharthachatterjee]

I'll let the @gatsbyjs/docs team weigh in on this since I'm not sure

In the mean time, check out the documentation at https://www.gatsbyjs.org/docs/gatsby-link/

[gillkyle]

Hey @endormi, thanks for bringing this up! True it's not showing up in the plugins list, not sure that's intentional or not. Since it is natively a part of Gatsby (not technically a plugin) it seems like it's probably okay the way it is IMO.

Maybe others have a stronger opinion?

[wardpeet]

@gillkyle you're correct! I don't think it belongs in the gatsby-plugin listing either. I do get that it might be a bit confusing.

if this is a problem we could add gatsby-image & gatsby-link manually to the list so they show.

[endormi]

If it is needed, I can add it manually or else IMO it should be removed from the packages folder, because it's not connected anywhere.

[endormi]

Any updates @wardpeet, @gillkyle ?

[gillkyle]

@endormi the gatsby-image folder inside of packages is what gets bundled up and released with the monorepo setup for Gatsby, so it's important to keep that one around 🙂.

It seems like gatsby-image is showing up in the plugin list as of now, this might have been an issue with algolia and npm-search that we're relying on to get those readmes. That issue is being tracked in other places too: algolia/npm-search#365

gatsby-link is now exported from gatsby by default, because it doesn't need to be installed it doesn't need to be included in the plugin list.

Because I'm seeing the image package showing up now I think it's fine to close this for now, thanks for bringing it up!

[endormi]

Okay, good. What about the gatsby-link.md. I personally don't think it's not needed. Reason being, because you can't find it in the website. @gillkyle

[gillkyle]

@endormi have you been able to find the doc on linking between pages? Or possibly the recipe on linking? Being a part of core Gatsby it's documented in several places (and hopefully isn't too hard to find) 🙂 because nothing needs to be installed to use the Link component that Gatsby exports, IMO it doesn't really fit in as well with the plugins that are meant to extend the usage of native Gatsby.

If those are difficult to find it might be worth considering moving those to make them easier to discover, a lot of this could have been considered in #13712 as well.

[endormi]

I meant the gatsby API reference, that is a page with only a link to the reference, I don't think that's needed let alone it's doesn't seem to be on the website.

[gillkyle]

I'm not sure I understand what pages or references you're talking about then I guess, my bad!

Can you provide links to the page or lines of code where that link is?

[endormi]

Yeah, link. Like I said I have been trying to find that page on the website, but I haven't found it.

[gillkyle]

Ah yes! That's a broken link and a PR to fix that would be appreciated! That should link to this page.

[endormi]

Hmm, to gatsby-image? That's a gatsby-link.md. Just making sure, if that is the case, I will make a fix for it ASAP

[gillkyle]

🤦‍♂ my bad haha I'm bouncing around between too many things, you're correct this is the proper link: https://www.gatsbyjs.org/docs/gatsby-link/

Updating that link would be appreciated in a PR so others don't face the confusion you did!

[endormi]

😄 no worries