Skip to content

Commit

Permalink
(docs): Creating the inital developer documentation page for Amplicat…
Browse files Browse the repository at this point in the history
…ion.com's new Platform Console.
  • Loading branch information
dericksozo committed Sep 24, 2024
1 parent 1b29b37 commit 7ad55e5
Show file tree
Hide file tree
Showing 5 changed files with 121 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/how-to/assets/platform-changes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
120 changes: 120 additions & 0 deletions docs/how-to/platform-console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
---
title: Platform Console
description: Learn about Amplication's Platform Console, including templates and private plugins for standardizing service creation and management.
sidebar_label: Platform Console
slug: /platform-console
---

The **Platform Console** is a powerful new feature in Amplication that allows your team to define, manage, and maintain standardized templates and private plugins for their backend services.

:::note
The Platform Console features, including the usage of templates and creation of services based on templates, are **currently in beta**.
:::

## Overview

The Platform Console introduces two main components:

1. **Platform Console Templates**: Pre-configured service templates that serve as a blueprint for creating new services.
2. **Private Plugins**: Custom plugins visible only to your organization that can be added to templates or services to extend functionality.

These components are managed through a new dashboard interface, separate from the existing services view.

![Amplication Platform Console](./assets/amplication-platform-console.png)

## Benefits

- **Standardization**: Ensure all services follow organizational best practices and configurations.
- **Efficiency**: Quickly create new services based on pre-defined templates.
- **Centralized Management**: Update multiple services from a single location. When you update a template, all services using that template are automatically updated.
- **Customization**: Create and use private plugins to tailor services to your organization's specific needs.

## Platform Console Templates

Platform Console Templates allow you to create a single source of truth for your services' architecture. These templates can include:

- Pre-configured settings
- Standard plugins
- Custom private plugins

### Creating a Template

To create a new template:

1. Navigate to the Platform Console dashboard.
2. Click on "Create Template".
3. Provide a name for your template (e.g., "Node.js with PostgreSQL").
4. Select the desired components (e.g., Admin UI, GraphQL API, REST API).
5. Choose a database (e.g., PostgreSQL).
6. Click "Create" to finalize the template.

### Managing Templates

Managing and updating templates is very similar to updating individual services. You have access to the same settings and options available for services, including:

- Viewing all templates in the Platform Console dashboard.
- Adding entities to the service template.
- Adding or removing plugins, including custom plugins.
- Renaming templates and updating their descriptions.
- Changing the code generator version for the template.

To edit a template:

1. Select the template from the Platform Console dashboard.
2. Navigate to the "Settings" tab.
3. Make your desired changes in the "General" or "Plugins" sections.
4. All changes are saved automatically.

:::note
When you update a template, **all services using that template will be automatically updated**, ensuring consistency across your infrastructure.
:::

### Using Templates

To create a new service based on a template:

1. Click on the "Add Resource" button.
2. Select "Service from Template" from the available options.
3. In the modal that appears, choose a specific service template.
4. Provide a name for your new service.
5. Click "Create" to generate the new service based on the selected template.

This process ensures that the new service inherits all the pre-configured settings and plugins defined in the template.

![Amplication Create Services From Template](./assets/create-service-from-template.png)

## Private Plugins

Private plugins allow you to create custom functionality specific to your organization's needs. These can be added to templates or directly to services.

:::note
Creating and managing private plugins requires an Enterprise plan or higher.
:::

### Creating a Private Plugin

To create a private plugin:

1. In the Platform Console dashboard, navigate to the "Private Plugins" section.
2. Click on "Create Private Plugin".
3. Follow the creation wizard to define your plugin's functionality.

## Platform Changes Sidebar

The Platform Console introduces a new **_Platform_ Changes** sidebar that replaces the **_Pending_ Changes** sidebar. It's only visible when you're viewing the Platform Console.

"Platform Changes" shows changes made to templates and private plugins, while "Pending Changes" still shows service-level changes.

:::note
Platform changes are separate from service-level changes. Make sure to review and commit platform changes separately from service changes.
:::

![Amplication Create Services From Template](./assets/platform-changes.png)

## Conclusion

The Platform Console feature is in beta, so we encourage you to explore its capabilities and provide feedback to help us improve and refine it.

:::tip
For any questions or issues related to the Platform Console, please [contact our support team](https://amplication.com/contact) or write your feedback on our [GitHub discussion](https://github.com/amplication/amplication/discussions/8979).
:::
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ const sidebars = {
"getting-started/cli"
],
},
"how-to/platform-console",
"how-to/analytics-dashboard",
"how-to/understanding-break-the-monolith",
"how-to/how-to-create-service"
Expand Down

0 comments on commit 7ad55e5

Please sign in to comment.