Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit 1b29b37

Browse files
authored
Merge pull request #506 from amplication/docs/plugins-revamp
Docs: Plugins Revamp
2 parents 7eb8e88 + df3c2ed commit 1b29b37

12 files changed

+490
-162
lines changed

docs/dictionary/en-custom.txt

+4-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,10 @@ Supertokens
9797
Bitwarden
9898
Jovu
9999
Jovu's
100+
passwordless
100101
Appsettings
101102
appsettings
102103
Codespaces
103-
Keycloak
104+
Keycloak
105+
thirdparty
106+
emailpassword
Loading

docs/getting-started/plugins.md

+34-28
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,56 @@
11
---
22
id: plugins
3-
title: How To Use Plugins
4-
description: Learn how to use Amplication plugins that extend the functionality of your generated application.
5-
sidebar_label: How To Use Plugins
3+
title: Plugins Explained
4+
description: Learn how to use Amplication plugins to extend the functionality of your generated service.
5+
sidebar_label: Plugins Explained
66
slug: /getting-started/plugins
77
pagination_next: plugins/overview
88
pagination_prev: getting-started/community-plugins
99
---
1010

11-
Amplication uses _Plugins_ to extend the functionality of your generated code.
11+
Amplication uses _Plugins_ to extend the functionality of your generated service. These software additions allow developers to customize the default behavior of [Amplication's code generation process](/plugins/plugin-architecture/), providing hooks into various stages of service creation.
1212

13-
Some plugins can be enabled when you first create your service.
14-
For example, if you choose MySQL as your database, the _MySQL DB_ plugin will be enabled.
15-
If you choose to turn on authentication for your service, that will enable the _NestJS Auth Module_ plugin.
16-
17-
All community plugins published by Amplication are available on the _All Plugins_ page.
18-
Your installed plugins are shown on the _Installed Plugins_ page.
19-
Plugins can be manually enabled or disabled on either of these pages.
20-
The source code of all community Amplication plugins are [available on GitHub](https://github.com/amplication/plugins).
13+
Amplication offers a wide range of community-created plugins that are open-source and available on GitHub. You also have the flexibility to develop your own [custom plugins](/plugins/overview/) so you can tailor your generated service to meet your exact requirements.
2114

22-
Besides the community plugins created by the Amplication team, you can [develop your own custom plugins](/plugins/overview/).
15+
You can enable certain plugins when you first create your service.
16+
For example, if you choose MySQL as your database, the _MySQL DB_ plugin will be enabled.
17+
If you choose to turn on authentication for your service, that will enable Authentication-related plugins.
2318

2419
:::tip
2520
[Amplication's AI](/amplication-ai) can help you find new plugins for your service, and even install them automatically, with a single request.
2621

2722
Ask Jovu: `Which plugins do you recommend for adding caching capabilities to my Amplication service?`
2823
:::
2924

30-
## Community Plugins List
25+
## Node.js and .NET Plugins
3126

32-
You can view all community plugins on the _All Plugins_ page.
33-
They're also available on the [Community Plugins](/plugins-list) page here on the Amplication documentation.
27+
Amplication supports both Node.js and .NET for code generation. Plugins are technology-specific.
3428

35-
## Viewing Open-Source Plugin Code
29+
When you switch between Node.js and .NET, you'll see a different set of available plugins, each optimized for the chosen stack.
3630

37-
All Amplication plugins are open-source and available on GitHub.
38-
You can find the plugin source code for each individual plugin in Amplication's [`plugins`](https://github.com/amplication/amplication-plugins) repository.
31+
Node.js plugins integrate seamlessly with the Node.js ecosystem and popular frameworks like NestJS. .NET plugins are designed to work with .NET Core and leverage the power of the .NET ecosystem.
3932

40-
## How To Install A Plugin
33+
## How To Install a Plugin
4134

42-
To install a plugin:
35+
To see all community-created plugins, first visit the _Plugins_ tab in your Amplication dashboard.
4336

44-
1. In the _All Plugins_ page, click **Install** for the required plugin.
37+
To install an individual plugin:
4538

46-
![](./assets/all-plugins.png)
39+
1. On the left sidebar in the Plugins page, you can browse by _Plugin Categories_ categories like Database, Authentication, and more, or click on _All Plugins_ to see the complete list.
40+
2. Click the **Install** button next to the desired plugin.
41+
3. The plugin's toggle will switch to its _on_ state, indicating it's now active.
42+
4. You can view all your installed plugins in the _Installed Plugins_ tab.
43+
5. To see a plugin's source code on GitHub, select **View on GitHub** next to the installed plugin.
4744

48-
2. This will turn on the plugin's toggle into its _on_ state.
45+
Plugins can be manually enabled or disabled from both the _All Plugins_ and _Installed Plugins_ tabs.
4946

50-
3. Go to the _Installed Plugins_ page. The installed plugins are listed.
47+
![](./assets/all-plugins-and-categories.png)
5148

52-
4. To see the plugin's code on GitHub, select **View on GitHub**.
49+
:::tip
50+
Explore different plugin categories to discover plugins that can enhance specific parts of your service, such as database management, authentication, or API functionality.
51+
:::
5352

54-
## How To Uninstall A Plugin
53+
## How To Uninstall a Plugin
5554

5655
To uninstall, or deactivate, a plugin, click the toggle switch into its _off_ state.
5756

@@ -76,7 +75,7 @@ By default, the latest version of the plugin will be available in the list of pl
7675

7776
1. To change the installed version of a plugin, in the **All Plugins** page, click the **Settings** icon.
7877

79-
The plugins settings page opens.
78+
The plugin's settings page opens.
8079

8180
![](./assets/plugin-versions.png)
8281

@@ -88,6 +87,13 @@ By default, the latest version of the plugin will be available in the list of pl
8887
Each version of the Plugin has its own settings, so when you replace the version you also replace its settings.
8988
:::
9089

90+
## How To View Open-Source Plugin Code
91+
92+
All Amplication plugins are open-source and available on GitHub.
93+
You can find the plugin source code for each individual plugin in Amplication's [`plugins`](https://github.com/amplication/amplication-plugins) repository.
94+
95+
Besides the plugins created by the Amplication team and the community, you can [develop your own custom plugins](/plugins/overview/).
96+
9197
## How To Develop a Custom Plugin
9298

9399
To add more functionality, you can develop your own plugins, or can use plugins developed by the community, as they become available.

docs/how-to/authentication-plugin-examples.md

-76
This file was deleted.

0 commit comments

Comments
 (0)