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

Commit

Permalink
(docs): Updating the necssary screenshots, text, and titles to take i…
Browse files Browse the repository at this point in the history
…nto account the new Plugins category filter component. Making things more clear.
  • Loading branch information
dericksozo committed Dec 25, 2023
1 parent 330b752 commit f433832
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 17 deletions.
Binary file modified docs/getting-started/assets/all-plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/assets/installed-plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/assets/plugin-versions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 19 additions & 17 deletions docs/getting-started/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: plugins
title: How To Use Plugins
description: Learn how to use Amplication plugins that extend the functionality of your generated application.
sidebar_label: Use Plugins
sidebar_label: How To Use Plugins
slug: /getting-started/plugins
pagination_next: plugins/overview
pagination_prev: getting-started/community-plugins
Expand All @@ -12,46 +12,48 @@ Amplication uses _Plugins_ to extend the functionality of your generated code.

Some plugins can be enabled when you first create your service.
For example, if you choose MySQL as your database, the _MySQL DB_ plugin will be enabled.
If you choose to turn on authentication for your service, that will enable the _NestJS Auth Module_ plugin.
If you choose to turn on authentication for your service, that will enable the _NestJS Auth Module_ plugin and other Authentication-focused plugins.

All community plugins published by Amplication are available on the _All Plugins_ page.
Your installed plugins are shown on the _Installed Plugins_ page.
Plugins can be manually enabled or disabled on either of these pages.
All community plugins published by Amplication are available on your service's _Plugins_ tab.
Plugins can be enabled or disabled on this tab.
To view your installed plugins, click on the _Installed Plugins_ category in the filter options on the left side.
The source code of all community Amplication plugins are [available on GitHub](https://github.com/amplication/plugins).

Besides the community plugins created by the Amplication team, you can [develop your own custom plugins](/plugins/overview/).
Besides the available community plugins, you can [develop your own custom plugins](/plugins/overview/).

## Community Plugins List

You can view all community plugins on the _All Plugins_ page.
They're also available on the [Community Plugins](/plugins-list) page here on the Amplication documentation.

## Viewing Open-Source Plugin Code

All Amplication plugins are open-source and available on GitHub.
You can find the plugin source code for each individual plugin in Amplication's [`plugins`](https://github.com/amplication/amplication-plugins) repository.

## How To Install A Plugin

To install a plugin:

1. In the _All Plugins_ page, click **Install** for the required plugin.
1. In your service's _Plugins_ tab, click **Install** for the required plugin.

![](./assets/all-plugins.png)

2. This will turn on the plugin's toggle into its _on_ state.
2. For streamlined searching, click on **Categories** in the filter panel to browse plugins by type.

3. Click on the plugin's toggle switch to activate it, changing its status to the _on_ state.

3. Go to the _Installed Plugins_ page. The installed plugins are listed.
4. Click on the _Installed Plugins_ category on the filter options on the left side. The installed plugins are listed.

4. To see the plugin's code on GitHub, select **View on GitHub**.
5. To see the plugin's code on GitHub, click the **View on GitHub** link.

## How To Uninstall A Plugin

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

## How To View Open-Source Plugin Code

All Amplication plugins are open-source and available on GitHub.
You can find the plugin source code for each individual plugin in Amplication's [`plugins`](https://github.com/amplication/amplication-plugins) repository.

## How To Modify Plugin Execution Order

The plugins are executed when Amplication generates code, according to their order on the *Installed Plugins* page.
The plugins are executed when Amplication generates code, according to their order on the *Installed Plugins* category.

:::tip
If a plugin execution is a prerequisite for another plugin, it must be located earlier in the list.
Expand Down

0 comments on commit f433832

Please sign in to comment.