feat: add plugin cli docs page

[joshuaellis]

What does it do?

• adds plugin-cli docs page

Why is it needed?

• so we can publicly document the plugin CLI as experimental

Related issue(s)/PR(s)

• resolves CONTENT-1752

Direct preview links:
👉 Reference
👉 Guide

[vercel]

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	Jan 29, 2024 8:58am

[pwizla]

Thank you for the PR, @joshuaellis. Excited to see what the Plugin CLI will do!

However, when you create PR for docs, could you please disable your linter/Prettier tool(s)?

These tools autoformat content which often leads to "polluting" documentation PRs content.
At best, they convert single quotes into double quotes, and we don't need that level of strict conventions in documentation files, especially in files that are not exposed to the users (such as sidebars.js).
At worse, they introduce UX flaws — for instance, there's a very specific reason some lines are indented; indenting some blocks makes the difference between the following result:

and the following one (notice how the block looks "included" into step 2):

Before I dive deeper into the real content, could you please exclude/revert all the "pure formatting" content from this PR (removed spaces, converted quotes, etc.)? 🙏

(Also I changed the assignee because on the documentation repo, the assignee is the technical writer in charge of merging the PR; because a merge into main instantly triggers a new website deployment.)

[pwizla]

Hi @joshuaellis, FYI I'll probably go ahead and clean up the PR myself this week.
Is it for v4 or v5 btw? 🤔

[joshuaellis]

Sorry @pwizla, been super busy. I'll try to get to it too, but let's see who does first. It's released in v4 as experimental...

I thought I disabled the workspace plugins last time too... have you looked at adding vscode workspace settings file? 😊

[pwizla]

It's OK @joshuaellis I can do it this time, no worries.

I've never played with workspace settings in VSCode, no, and wouldn't know where to start. However Derrick added an .editorconfig file a while back and I believe the file is still in the repo if you need it :)

[pwizla]

@joshuaellis I updated the formatting.
I'll now review the plugin CLI docs.
To save time, is it OK if I directly push updates to your branch, instead of having back & forth comments, discussions, and suggestions on GitHub?

[joshuaellis]

absolutely! go right ahead ✨

[pwizla]

Hi @joshuaellis,

I finally had a deeper look at the PR.

I'll split the content because the current page actually groups 2 very different things:

• a reference section (list of commands)
• a guide on how to use the plugin CLI

For the guide part, I need a bit more context to properly introduce the subject and understand the added value of the feature. For instance, you can currently already create a plugin with strapi generate plugin. When should a user use this over the strapi plugin:init command? 🤔 Is there some additional internal documentation in Notion about the plugin CLI (esp. why it was created, what are the actual use cases, etc.)?

[joshuaellis]

the plugin:init command will supersede the generate plugin command :)

The set up of the former is geared towards using the entire plugin CLI kit as opposed to the latter which is not.... I hope that helps? There aren't any other documents really that I can recall 🤔

[pwizla]

Thank you! So, at some point, we'll also need to rewrite the Plugin creation & setup page. Any ETA on when plugin:init will replace generate plugin?

[joshuaellis]

Thank you! So, at some point, we'll also need to rewrite the Plugin creation & setup page. Any ETA on when plugin:init will replace generate plugin?

exactly! Hopefully in V5, still need to hash the details out – I can ping you on the PR when it's ready & in the JIRA ticket to keep an eye on if that's helpful for you?

[pwizla]

Sure, let's do this! For now I'll adapt the content of this PR to better fit with the current content, hierarchy and style guide. I'll ping you when it's done for a final review :)

[pwizla]

@joshuaellis, I reworked the content a bit. If you'd like to have a look:

Direct preview links:
👉 Reference
👉 Guide

[joshuaellis]

L O V E
I T