Gatsby: bug(www): some plugin READMEs are not properly rendered

[RohitChattopadhyay]

Description

Plugin description is not rendering the Readme file properly, instead only _README.md_ is visible.

Steps to reproduce

Visit https://www.gatsbyjs.org/packages/gatsby-plugin-sass/

Expected result

Readme gatsby-plugin-sass should be transformed the same way as for other plugins

Actual result

What happened.

Environment

Windows, checked in Chrome and Edge

[iamdarshshah]

Similar Issues:

16322

13720

11129

Other Plugins with the same issue:

• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n/

• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n-tags/

• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n-readnext/

• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-sass-resources/?=gatsby-plugin-sass

• [ ] https://www.gatsbyjs.org/packages/bowlingx-gatsby-plugin-sass/?=gatsby-plugin-sass

• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-sass-resources/?=gatsby-plugin-sass

It seems that the issue still persists. @wardpeet can you check this? (reference: #16322)

[slimcoders]

Hi i wants to work on this issue please assign this issue to me.

[iamdarshshah]

@viveksharmaui sure go for it!!

[slimcoders]

Please assign me this issue so that i can start my work .

[iamdarshshah]

@viveksharmaui You can give it a try and request PR for this issue. The team will review your PR and will get back to you with the required changes if needed. Thanks

[slimcoders]

Sure! I will try

[slimcoders]

@iamdarshshah I'm struggling with setting up gatsby project can you help me? I want to run locally unable to regenerate this issue.

[RohitChattopadhyay]

@iamdarshshah I'm struggling with setting up gatsby project can you help me? I want to run locally unable to regenerate this issue.

Please elaborate on the problem you are facing
https://github.com/gatsbyjs/gatsby/tree/master/www
This is the codebase of the concerned website

[RohitChattopadhyay]

@iamdarshshah I'm struggling with setting up gatsby project can you help me? I want to run locally unable to regenerate this issue.

Please elaborate on the problem you are facing
https://github.com/gatsbyjs/gatsby/tree/master/www
This is the codebase of the concerned website

I have installed npm modules and run npm run dev but still facing error in development mode.

See if this helps https://www.gatsbyjs.org/contributing/website-contributions/

Adding screenshots/log of your error, will help a lot

[slimcoders]

Hi! I checked this issue and it is working fine in local I think it is production-related issue.

Similar Issues:

16322

13720

11129

Other Plugins with the same issue:

• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n/
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n-tags/
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n-readnext/
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-sass-resources/?=gatsby-plugin-sass
• [ ] https://www.gatsbyjs.org/packages/bowlingx-gatsby-plugin-sass/?=gatsby-plugin-sass
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-sass-resources/?=gatsby-plugin-sass

It seems that the issue still persists. @wardpeet can you check this? (reference: #16322)

I tested this and it is occuring in
1) gatsby-plugin-i18n
2) gatsby-plugin-i18n-tags
3) gatsby-plugin-i18n-readnext
4) gatsby-plugin-sass-resources
5) bowlingx-gatsby-plugin-sass
6) gatsby-plugin-sass-resources

this issue is not regenerated for gatsby-plugin-sass. It was rendered correctly on my system.

[github-actions[bot]]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[ZachHoskins]

Similar Issues:

16322

13720

11129

Other Plugins with the same issue:

• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n/
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n-tags/
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-i18n-readnext/
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-sass-resources/?=gatsby-plugin-sass
• [ ] https://www.gatsbyjs.org/packages/bowlingx-gatsby-plugin-sass/?=gatsby-plugin-sass
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-sass-resources/?=gatsby-plugin-sass

It seems that the issue still persists. @wardpeet can you check this? (reference: #16322)

I am still having the same issue with all of these plugins as well as the following plugins:

• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-coffeescript/
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-stylus/
• [ ] https://www.gatsbyjs.org/packages/gatsby-plugin-postcss/

I installed the Gatsby site locally on my machine, and I'm still getting the same issue locally.

@iamdarshshah, do you mind if I take a swing at this one to try to resolve this issue?

[iamdarshshah]

Sure @ZachHoskins Give it a try.

[ZachHoskins]

Now it looks like the issue is resolved. I looked through the PRs since I experienced the issue this morning, but I didn't find anything that specifically dealt with this issue. Here is a screenshot form the GraphQL query I ran this morning, and another that I ran just a few minutes ago after bringing my local repo up to date with the Gatsby one:

I think it's safe to say this issue is no longer an active issue. Perhaps a pull request that was approved today contained the fix for this issue in it.

[tesseralis]

I'm still seeing the invalid README pages on the described plugins so I don't think this issue is resolved just yet. @viveksharmaui are you still interested in helping with this issue?

[ZachHoskins]

I am also only seeing README.md on those pages now, but for some reason, it was displaying properly on the night of June 25. So I'm not quite sure why it went from not working to working and then back to not displaying properly again.

[marcysutton]

I'm still seeing this as well. It may help to look at the "View plugin on GitHub" URLs, since they contain some clues. For example, the i18n plugin page points to a search index: https://github.com/search?q=gatsby-plugin-i18n

[LekoArts]

As far as I remember those are issues with Algolia`s index and intermittent issues. Happy to read some more insights on that if you can find a culprit.

[github-actions[bot]]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[github-actions[bot]]

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.
Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community! 💪💜

[Nakasz]

Sir Please assign me this issue so that i can start my work .

[LekoArts]

This should be solved with https://github.com/gatsbyjs/gatsby/pull/27040 once Aloglia updates its index.

[nbaosullivan]

Hey @LekoArts - #27040 was just specific to one package (gatsby-plugin-postcss) due to a redundant readme property in the package.json file

[LekoArts]

My colleague added a commit to your PR removing the same entry from the other packages mentioned here :)

[nbaosullivan]

Ah fantastic, thanks for letting me know 👍