Docs: Private Plugins #534
Conversation
| toc_max_heading_level: 2 | ||
| --- | ||
|
|
||
| # Creating and Using Private Plugins |
There was a problem hiding this comment.
In some places (in the docs) it is called "custom plugins" and here it's "private plugins". I would go with private plugins all over the place
|
|
||
| # Creating and Using Private Plugins | ||
|
|
||
| Private Plugins enable you to create [custom plugins](/plugins/overview/) exclusively for your organization's use. These plugins let you build secure, proprietary integrations while protecting sensitive business logic. |
There was a problem hiding this comment.
NSIU this sentence- "private plugins enable you to create custom plugins"???
There was a problem hiding this comment.
In addition- it's not only about integrations but also defining and managing standards and best practices
| 3. Set the plugin's **Display Name** and **Description** - these will appear in the UI when selecting plugins | ||
| 4. Choose the appropriate code generator (Node.js or .NET) that matches your target services | ||
|
|
||
| The Plugin Id you enter will become the name of your plugin's folder within the `plugins` folder. |
There was a problem hiding this comment.
"will become" sounds like we will create this folder. Maybe we need to say that the ID should match the folder name of the plugin in the repo or such
|
|
||
| :::note | ||
| For a real-world example of using settings in your plugin, check out the [Supertokens authentication plugin](https://github.com/amplication/plugins/blob/a94dac7956e51903df0240eef7b704999fc6a752/plugins/auth-supertokens/src/index.ts#L160). | ||
| For more detailed information about settings and configurations, see our [plugin settings documentation](/plugins/define-plugin-settings). |
There was a problem hiding this comment.
This linked page is not connected to the docs menu. Is it on purpose?
|
|
||
| ## Publish Your Plugin | ||
|
|
||
| After adding a version to your plugin, configuring your plugin settings, and tagging your repository, it's time to publish your plugin. |
There was a problem hiding this comment.
Let's add a short explanation about publishing the plugin. Why do we need to publish it, what will happen after publishing the version (- the version is available to be used in services and templates, and this becomes the latest version).
| ### Include the Plugin in a Template | ||
|
|
||
| 1. Navigate to the Templates tab in your Platform Console | ||
| 2. Click on Create Template |
There was a problem hiding this comment.
Click on Create Template or navigate to an existing Template
| ### Include Plugin in a Service | ||
| 1. Navigate to your service in the Platform Console |
There was a problem hiding this comment.
I guess you meant "in the Service Catalog"
| ### Common Issues and Solutions | ||
| - Undefined property errors: Verify plugin versions and publishing |
There was a problem hiding this comment.
- What does "publishing" mean?
- I think that all the errors in this section should mention when / where it can be seen, for example- "Undefined property errors" while generating the code for the service" or such
| You successfully created your private plugin. | ||
| It's version-controlled in your Git repository and available for use in both templates and services that match its code generator. | ||
|
|
||
| For additional support, contact our support team. |
There was a problem hiding this comment.
Let's elaborate on this...
Something like - for more information or in case of issues and questions, use our Discord channel (link) or contact our support team in case you are customers
(docs): Adding the content for the Private Plugins page including screenshots.
This PR takes care of #521.