search

prismicio / gatsby-source-prismic-graphql

Gatsby source plugin for Prismic GraphQL
MIT License
17 stars 14 forks source link

THIS PLUGIN IS NOT THE RECOMMENDED SOLUTION - UPDATE THE DOCUMENTATION TO MAKE THAT CLEAR #40

Open matthewtgilbride opened 4 years ago

matthewtgilbride commented 4 years ago

https://prismic.io/blog/gatsby-prismic-plugins

Let this serve as a warning to anyone that comes here. I have made multiple PR's and put some time into this plugin only to find what seems to be the "right" information from Prismic buried on their blog. Long story short, you should probably be using gatsby-source-prismic, and preview support there is more limited.

@MarcMcIntosh - I apologize in advance if this issue comes off as obnoxious - I very much appreciate your efforts - but I think it's important for others to see it until the documentation both here and on Prismic's website is updated - care to comment?

Others have commented about updating documentation. IMHO the first thing mentioned in the documentation should be a clear disclaimer about the recommended solution (gatsby-source-prismic) as well as it's limitations. Furthermore, Prismic's documentation (a multi part tutorial advocating the use of gatsby-source-prismic-graphql as well as another page stating that gatsby-source-prismic-graphql is the recommended plugin) should be updated ASAP.

mrseanbaines commented 4 years ago

Thanks for sharing this @matthewtgilbride. A bit annoying as I've spent quite a bit of time fighting to get previews working 😩. Also quite strange as this repo was only recently forked from the original, and the updated Prismic Gatsby docs - which I believe are also very new - still suggest to use this.

I'm not sure I understand what gatsby-source-prismic gives you over this plugin? Is it less buggy? Can you use useStaticQuery? Do previews even work with it or are they suggesting to use Gatsby Cloud's [rather expensive] preview feature?

matthewtgilbride commented 4 years ago

For anyone coming here looking for clarity: https://community.prismic.io/t/what-is-the-approach-with-regard-to-gatsby-plugins/1538/4

PierreAndreis commented 4 years ago

If this is not the recommended plugin, why would prismic write a guide in how to migrate from the "recommended" plugin to the deprecated one?

https://user-guides.prismic.io/en/articles/3647135-how-to-migrate-a-project-from-gatsby-source-prismic-to-gatsby-source-prismic-graphql

shouldn't this article be the other way around? how to migrate from this plugin to the recommended one

GreatState commented 4 years ago

If this is not the recommended plugin, why would prismic write a guide in how to migrate from the "recommended" plugin to the deprecated one?

https://user-guides.prismic.io/en/articles/3647135-how-to-migrate-a-project-from-gatsby-source-prismic-to-gatsby-source-prismic-graphql

shouldn't this article be the other way around? how to migrate from this plugin to the recommended one

That is indeed strange!