Skip to content

Setting up local plugin in Strapi without the Plugin SDK#2392

Merged
Bassel17 merged 14 commits into
mainfrom
plugins/setup-local-plugin
Feb 26, 2025
Merged

Setting up local plugin in Strapi without the Plugin SDK#2392
Bassel17 merged 14 commits into
mainfrom
plugins/setup-local-plugin

Conversation

@Bassel17

@Bassel17 Bassel17 commented Feb 24, 2025

Copy link
Copy Markdown
Member

What does it do?

  • Adding as section to local plugin creation about how to set it up without plugin sdk
  • adding a warning for local plugins that are created with plugin sdk and how to manage it's dependencies

Why is it needed?

  • people are having issues with plugins setup locally, this is a solution for them to go with before we fix the issue on our side
  • documents how you can create a plugin without the sdk for even more complicated issues

Related issues:

Resolves strapi/strapi#22547
Resolves strapi/strapi#22162
Resolves strapi/strapi#22536
Resolves strapi/strapi#21823

@Bassel17 Bassel17 added the pr: updated content PRs updating existing documentation content label Feb 24, 2025
@Bassel17 Bassel17 self-assigned this Feb 24, 2025
@Bassel17 Bassel17 requested a review from pwizla as a code owner February 24, 2025 12:53
@vercel

vercel Bot commented Feb 24, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 25, 2025 9:55am

@github-actions github-actions Bot added the temp - port to docs-next (Temporary label) The content of this PR should be ported to docs-next.strapi.io label Feb 24, 2025
@jhoward1994

Copy link
Copy Markdown
Contributor

What do you think about removing the section you've added at L152?

As we're discussing in DX-1897 - I wonder if it'd be better for us to treat this as a bug and raise an issue in the monorepo ?

@Bassel17

Copy link
Copy Markdown
Member Author

What do you think about removing the section you've added at L152?

As we're discussing in DX-1897 - I wonder if it'd be better for us to treat this as a bug and raise an issue in the monorepo ?

we can indeed do that
@maccomaccomaccomacco thoughts ? the section mentioned above essentially discusses the issue we have and the proposed workaround

@pwizla

pwizla commented Feb 25, 2025

Copy link
Copy Markdown
Collaborator

What do you think about removing the section you've added at L152?
As we're discussing in DX-1897 - I wonder if it'd be better for us to treat this as a bug and raise an issue in the monorepo ?

Indeed, I was going to say that:

  • From a pure docs point of view, a big "caution" callout is frightening for users, and we should find another way to pass the information.
  • This kind of thing seems more likely to be fixed at the product level than "permanently" documented. If the issue will be resolved soon, we could temporarily add a ::: note callout with a link to another resource.

Edit: I made further adjustments and turned it into a section.

Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
@pwizla pwizla changed the title docs: setting up local plugin in strapi and warning Setting up local plugin in Strapi without the Plugin SDK Feb 25, 2025
@pwizla pwizla added the source: Dev Docs PRs/issues targeting the Developer Docs label Feb 25, 2025
@pwizla pwizla added this to the v5.6.3 milestone Feb 25, 2025
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
Comment thread docusaurus/docs/dev-docs/plugins/development/create-a-plugin.md Outdated
@pwizla pwizla self-requested a review February 25, 2025 09:49

@pwizla pwizla left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, made some adjustments (formatting, consistency with the rest of the docs)

@pwizla

pwizla commented Feb 26, 2025

Copy link
Copy Markdown
Collaborator

@jhoward1994 @Bassel17 @innerdvations OK to merge this one today? 😊 Or should I wait?

(merged = live on docs.strapi.io a few minutes later)

@Bassel17

Copy link
Copy Markdown
Member Author

@pwizla go ahead it's good to go

@Bassel17 Bassel17 merged commit 5c4178c into main Feb 26, 2025
@Bassel17 Bassel17 deleted the plugins/setup-local-plugin branch February 26, 2025 14:20
@pwizla pwizla removed the temp - port to docs-next (Temporary label) The content of this PR should be ported to docs-next.strapi.io label Mar 20, 2025
pwizla added a commit that referenced this pull request Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr: updated content PRs updating existing documentation content source: Dev Docs PRs/issues targeting the Developer Docs

Projects

None yet

5 participants