search

ChristopherBiscardi / gatsby-mdx

Gatsby+MDX • Transformers, CMS UI Extensions, and Ecosystem Components for ambitious projects
https://gatsby-mdx.netlify.com/
715 stars 100 forks source link

npm / Gatsby search using old Readme stating "gatsby-mdx is the official integration" #413

Closed karlhorky closed 5 years ago

karlhorky commented 5 years ago

Describe the bug

The npm and Gatsby search are showing the old readme content, with a phrase stating "gatsby-mdx is the official integration", which is not true anymore:

https://www.npmjs.com/package/gatsby-mdx https://www.gatsbyjs.org/packages/gatsby-mdx/

I guess the readme content should match the current readme (https://github.com/ChristopherBiscardi/gatsby-mdx/blob/161c084282834cc2cbd864d09617c10d869d0022/README.md).

To Reproduce

Visit the links above to see the message.

Expected behavior

Consistent readmes.

Screenshots

Screen Shot 2019-07-15 at 10 53 12

Additional context

Related issue in gatsbyjs/gatsby: https://github.com/gatsbyjs/gatsby/issues/15651

Mention by @amberleyromo: https://github.com/gatsbyjs/gatsby/pull/15559#issuecomment-510714244

ChristopherBiscardi commented 5 years ago

Can't change the README without doing a release. Since people are still using the old gatsby-mdx releases in production, what I'll probably do is release a gatsby-mdx 1.0 and deprecate it immediately with a message pointing to the gatsby-plugin-mdx package.

Planning this for after I write and release the 1.0 blog post.

karlhorky commented 5 years ago

Ah ok, not even a minor bump to reduce the confusion until the blogpost happens? I guess if the post is coming soon, it's not a big deal...

For now the situation is pretty confusing though, especially for newcomers.

Graham42 commented 5 years ago

Just spent several hours going down the wrong path here and couldn't figure out why I couldn't get it to work. Would really appreciate a deprecated notice on the existing version.

ChristopherBiscardi commented 5 years ago

image

karlhorky commented 5 years ago

Thanks!

I guess what's remaining now from the description is the Gatsby search (https://www.gatsbyjs.org/packages/gatsby-mdx/):

Screen Shot 2019-07-25 at 20 59 30

I suppose that will come with the blog post.

ChristopherBiscardi commented 5 years ago

That's done by algolia and grabs the README from the released package so not sure there's anything we can do about it here

karlhorky commented 5 years ago

Hm, I thought I was reading somewhere in the issues here that there is a way to evict plugins from the index (or at least mark them as deprecated)...

Maybe I can find that still...

karlhorky commented 5 years ago

Can't find the issue at the moment, maybe @marcysutton or @DSchau or @jlengstorf can help here?

To the point: How can we remove gatsby-mdx from the Algolia search index (or mark it as deprecated)? It's been already marked as deprecated on npm.