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

Commit ea4c02c

Browse files
committed
(docs): Implementing Paz's feedback into the latest version of the draft.
1 parent c68a9be commit ea4c02c

File tree

4 files changed

+16
-15
lines changed

4 files changed

+16
-15
lines changed
24.4 KB
Loading

docs/how-to/platform-console.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ These components are managed through a new dashboard interface, separate from th
2525
## Benefits
2626

2727
- **Standardization**: Ensure all services follow organizational best practices and configurations.
28-
- **Efficiency**: Quickly create new services based on pre-defined templates.
29-
- **Centralized Management**: Update multiple services from a single location. When you update a template, all services using that template are automatically updated.
3028
- **Customization**: Create and use private plugins to tailor services to your organization's specific needs.
29+
- **Efficiency**: Quickly create new services based on pre-defined templates.
30+
- **Smooth Maintenance**: Update multiple services from a single location. When you update a template, all services using that template can automatically get a PR with the required changes.
31+
- **Technical Debt Prevention**: Implement organization-wide best practices across all services through templates and private plugins, creating a scalable architecture that resists the accumulation of technical debt as your project grows.
3132

3233
## Platform Console Templates
3334

@@ -48,26 +49,26 @@ To create a new template:
4849
5. Choose a database (e.g., PostgreSQL).
4950
6. Click "Create" to finalize the template.
5051

52+
![Amplication Create New Template](./assets/template-name-and-stack.png)
53+
5154
### Managing Templates
5255

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

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

6162
To edit a template:
6263

63-
1. Select the template from the Platform Console dashboard.
64-
2. Navigate to the "Settings" tab.
65-
3. Make your desired changes in the "General" or "Plugins" sections.
66-
4. All changes are saved automatically.
64+
1. Navigate to the Settings tab to update the configuration or the Plugins tab to install and update plugins.
65+
2. Make your desired changes in the "General" or "Plugins" sections.
66+
3. All changes are saved automatically.
6767

68-
:::note
69-
When you update a template, **all services using that template will be automatically updated**, ensuring consistency across your infrastructure.
68+
<!-- :::note
69+
When you update a template, **all services using that template will be updated in your next build**, ensuring consistency across your infrastructure.
7070
:::
71+
-->
7172

7273
### Using Templates
7374

@@ -97,7 +98,7 @@ To create a private plugin:
9798

9899
1. In the Platform Console dashboard, navigate to the "Private Plugins" section.
99100
2. Click on "Create Private Repository".
100-
3. Follow the creation wizard to define your plugin's functionality.
101+
3. Connect to your plugin repository and add your existing private plugins to the project.
101102

102103
## Platform Changes Sidebar
103104

@@ -117,5 +118,5 @@ The Platform Console feature is designed to enhance the maintainability of your
117118
As this feature is currently in beta, we encourage you to explore its capabilities and share your feedback to help us further improve and refine it.
118119

119120
:::tip
120-
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).
121+
For any questions or issues related to the Platform Console, please contact us or write your feedback on our [GitHub discussion](https://github.com/amplication/amplication/discussions/8979).
121122
:::

docusaurus.config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ module.exports = {
7777
label: "Plugins",
7878
},
7979
{
80-
to: "/how-to/import-prisma-schema/",
80+
to: "/platform-console/",
8181
position: "left",
82-
label: "Import DB",
82+
label: "Platform Console",
8383
},
8484
/* {
8585
to: "/deploy",

sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ const sidebars = {
1313
"getting-started/set-up-entities",
1414
"getting-started/configure-roles-and-permissions",
1515
"getting-started/add-plugins-for-service",
16+
"how-to/platform-console",
1617
"getting-started/commit-changes-and-build-new-versions"
1718
],
1819
},
@@ -153,7 +154,6 @@ const sidebars = {
153154
"getting-started/cli"
154155
],
155156
},
156-
"how-to/platform-console",
157157
"how-to/analytics-dashboard",
158158
"how-to/understanding-break-the-monolith",
159159
"how-to/how-to-create-service"

0 commit comments

Comments
 (0)