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

Commit ba1cd91

Browse files
committed
(docs): Adding the new Overview page for the Blueprints feature along with the necessary screenshots.
1 parent 2a8cd8b commit ba1cd91

File tree

5 files changed

+83
-0
lines changed

5 files changed

+83
-0
lines changed
Loading
Loading
Loading

docs/platform-features/blueprints.md

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
id: blueprints
3+
title: Blueprints
4+
sidebar_label: Blueprints
5+
slug: /blueprints
6+
---
7+
8+
# Blueprints
9+
10+
Blueprints are a powerful feature that let organizations create and manage any type of resource in their development ecosystem.
11+
Whether you're working with Java services, Python apps, deployment configurations, or database setups, Blueprints provide a flexible way to define, generate, and manage these resources.
12+
13+
![Project-level Blueprints Tab](./assets/blueprints/blueprint.png)
14+
15+
## Why Use Blueprints
16+
17+
Amplication provides enterprise-grade code generation for Node.js and .NET services, offering integration with industry-leading tools like Prisma, PostgreSQL, and MongoDB.
18+
19+
With Blueprints, we expand these capabilities to support any programming language, framework, database, or deployment option your team uses.
20+
This allows you to create standardized resources that match your organization's specific technology choices and requirements.
21+
22+
With Blueprints you can:
23+
24+
- Create resources for any programming language or framework
25+
- Standardize resource creation across your organization
26+
- Define custom deployment configurations
27+
- Connect external services and APIs
28+
- Set up database resources
29+
30+
## How To Access Blueprints
31+
32+
Access Blueprints from your Workspace by navigating to the dedicated Blueprints tab, where you can create and manage all your blueprints.
33+
34+
1. Navigate to your workspace settings
35+
2. Select the "Blueprints" tab
36+
3. Begin creating and managing your blueprints
37+
38+
## Core Concepts
39+
40+
### Blueprint
41+
42+
A blueprint defines how a specific type of resource will be implemented in your project. It provides the foundation for generating consistent, standardized resources across your organization. Each blueprint can generate multiple resources based on your specific requirements.
43+
44+
### Resource
45+
46+
A resource is a specific instance of a blueprint that developers use in their projects.
47+
When you create a resource from a blueprint, you get a fully configured instance that follows your organization's standards and best practices.
48+
You can manage that blueprint resource with the same tools that you can other resources
49+
For example, you can create multiple Java microservices from a single Java Spring Boot blueprint.
50+
51+
![A resource created from a Blueprint](./assets/blueprints/resource.png)
52+
53+
### Plugins
54+
55+
Plugins define the code generation logic for your blueprints. When you create a resource from a blueprint, its associated plugins determine how the actual code and configuration files are generated.
56+
57+
Each plugin can provide specific functionality for your blueprint. For example:
58+
59+
- Code generation for specific programming languages
60+
- Infrastructure configurations like Terraform files
61+
- Database schema definitions
62+
- API integrations and configurations
63+
64+
:::note
65+
Organizations can create private plugins to implement their specific requirements and standards. Visit the [Private Plugins](/private-plugins) page to learn more.
66+
:::
67+
68+
### Relations
69+
70+
Relations define connections between different blueprints, allowing you to model in-depth relationships in your architecture. For example, you can:
71+
72+
1. Connect service blueprints to their deployment configurations
73+
2. Link services to their respective databases
74+
3. Define dependencies between different components
75+
76+
![Relations between Blueprints](./assets/blueprints/relations.png)
77+
78+
## Next Steps
79+
80+
- **Create Your First Blueprint** - Learn how to create, configure, and implement your first blueprint resource
81+
- **Working with Blueprint Relations** - Discover how to connect blueprints to model your system architecture
82+
- **Blueprint Examples and Use Cases** - Explore real-world examples of how to use blueprints effectively

sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ const sidebars = {
2424
"how-to/service-catalog",
2525
"how-to/live-service-templates",
2626
"platform-features/technical-debt-management",
27+
"platform-features/blueprints",
2728
{
2829
type: "doc",
2930
id: "plugins/private-plugins",

0 commit comments

Comments
 (0)