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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation could be more accurate on some points #11
Comments
Also, not related to the issue but, unless I am mistaken, I noticed it's not working for single types, only collection types, right? |
What do you mean? How do I do this? |
The "publicationState" parameter is part of the Strapi API. If we want to get the draft version from the api response, it's mandatory to set it to "preview".
|
The documentation needs a revision. Unfortunately, there are missing crucial information. E.g. where to place the config file? |
Correct, but check again 馃檪. The plugin has very recently been updated to support single types 馃憤馃徎 |
When it comes to configuring a plugin in Strapi, I did not include those specific details in the plugin README because those guides can already be found in the Strapi docs - https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/configurations/optional/plugins.html This plugin does not have a public API so if you are querying the API for draft/live versions, that is not related to the functionality of this plugin. Details on querying draft/live states can be found in the Strapi docs - https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.html |
@mattmilburn I have tested the latest version and successfully used it for a single type, so thanks for this important support! 馃憤 Regarding the install instructions, nothing mandatory of course but I think it's never too much to precise things, especially as v4 is still relatively new in the game. Here are some examples found across other marketplace plugins: Same for regarding draft/live, nothing mandatory but it helps and avoid potential struggles to have this check in mind before using the package. I close the issue as it's not critical, all the best for this package! |
The documentation is confused. Any other guide to follow? Thank you. |
Hi, great plugin 馃憤, easygoing instructions, but maybe you should precise a couple of things, as some of us are just starting out with v4 (I struggled with these at first):
plugin.js
file under theconfig
folder.publicationState
API parameter topreview
when querying the content, otherwise, the draft will never be part of the response.The text was updated successfully, but these errors were encountered: