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

Commit bce7aaf

Browse files
dericksozodericksozo
committed
(docs): Implementing Paz's and Muly's feedback.
1 parent 2d0c76f commit bce7aaf

File tree

2 files changed

+72
-69
lines changed

2 files changed

+72
-69
lines changed

‎docs/how-to/deploy.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,14 @@ This guide provides an overview of Amplication's deployment options and links to
1212

1313
## Understanding Amplication's Deployment Architecture
1414

15-
Applications created with Amplication comprise two main components:
15+
Services created with Amplication comprise of at least two main parts:
1616

1717
1. The server that runs the API
1818
2. A database
1919

20+
There can be other parts like a Kafka message broker, or a Redis cache, or something else that your service needs.
21+
These will all be additional containers that will be specified in the `docker-compose` file.
22+
2023
When it comes to deployment, you have several options to choose from, allowing you to select the best approach for your development workflow and production needs.
2124

2225
## Deployment Options

‎sidebars.js

Lines changed: 68 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,6 @@ const sidebars = {
6969
"how-to/change-base-branch-for-pull-requests"
7070
]
7171
},
72-
{
73-
type: "category",
74-
label: "Deployment",
75-
link: {
76-
type: "doc",
77-
id: "how-to/deploy",
78-
},
79-
items: [
80-
"how-to/deploy",
81-
"getting-started/deploy-docker-desktop",
82-
"how-to/deploy-kubernetes",
83-
"how-to/deploy-to-aws-ecs",
84-
]
85-
},
8672
{
8773
type: "category",
8874
label: "Data Modeling",
@@ -97,6 +83,74 @@ const sidebars = {
9783
"how-to/how-to-set-access-permissions",
9884
"getting-started/relations"
9985
]
86+
},
87+
{
88+
type: "category",
89+
label: "Plugins",
90+
link: {
91+
type:"doc",
92+
id: "getting-started/plugins"
93+
},
94+
items: [
95+
"getting-started/plugins",
96+
"getting-started/community-plugins",
97+
"plugins/how-to-create-plugin",
98+
"plugins/how-to-test-plugin",
99+
"plugins/publish-plugin",
100+
{
101+
type: "category",
102+
label: "Custom Plugin Architecture",
103+
items: [
104+
"plugins/plugin-architecture",
105+
"plugins/plugin-events-before-after",
106+
"plugins/context-skip-default",
107+
"plugins/event-hierarchy",
108+
],
109+
},
110+
{
111+
type: "category",
112+
label: "Custom Plugin Events - Reference",
113+
items: [
114+
"plugins/plugin-events/create-server",
115+
"plugins/plugin-events/create-server-docker-compose",
116+
"plugins/plugin-events/create-server-docker-compose-dev",
117+
{
118+
type: 'doc',
119+
id: 'plugins/plugin-events/create-server-docker-compose-db',
120+
className: 'plugin-event-not-recommended',
121+
},
122+
"plugins/plugin-events/create-server-dot-env",
123+
"plugins/plugin-events/create-server-auth",
124+
"plugins/plugin-events/create-package-json",
125+
"plugins/plugin-events/create-entity-service",
126+
"plugins/plugin-events/create-entity-service-base",
127+
"plugins/plugin-events/create-entity-controller",
128+
"plugins/plugin-events/create-entity-controller-base",
129+
"plugins/plugin-events/create-entity-resolver",
130+
"plugins/plugin-events/create-entity-resolver-base",
131+
"plugins/plugin-events/create-message-broker-service",
132+
"plugins/plugin-events/create-message-broker-service-base",
133+
"plugins/plugin-events/create-message-broker-nestjs-module",
134+
"plugins/plugin-events/create-message-broker-client-options-factory",
135+
"plugins/plugin-events/create-message-broker-topics-enum",
136+
"plugins/plugin-events/create-prisma-schema",
137+
],
138+
}
139+
]
140+
},
141+
{
142+
type: "category",
143+
label: "Deployment",
144+
link: {
145+
type: "doc",
146+
id: "how-to/deploy",
147+
},
148+
items: [
149+
"how-to/deploy",
150+
"getting-started/deploy-docker-desktop",
151+
"how-to/deploy-kubernetes",
152+
"how-to/deploy-to-aws-ecs",
153+
]
100154
},
101155
{
102156
type: "category",
@@ -160,60 +214,6 @@ const sidebars = {
160214
"how-to/create-message-broker",
161215
],
162216
},
163-
{
164-
type: "category",
165-
label: "Plugins",
166-
link: {
167-
type:"doc",
168-
id: "getting-started/plugins"
169-
},
170-
items: [
171-
"getting-started/plugins",
172-
"getting-started/community-plugins",
173-
"plugins/how-to-create-plugin",
174-
"plugins/how-to-test-plugin",
175-
"plugins/publish-plugin",
176-
{
177-
type: "category",
178-
label: "Custom Plugin Architecture",
179-
items: [
180-
"plugins/plugin-architecture",
181-
"plugins/plugin-events-before-after",
182-
"plugins/context-skip-default",
183-
"plugins/event-hierarchy",
184-
],
185-
},
186-
{
187-
type: "category",
188-
label: "Custom Plugin Events - Reference",
189-
items: [
190-
"plugins/plugin-events/create-server",
191-
"plugins/plugin-events/create-server-docker-compose",
192-
"plugins/plugin-events/create-server-docker-compose-dev",
193-
{
194-
type: 'doc',
195-
id: 'plugins/plugin-events/create-server-docker-compose-db',
196-
className: 'plugin-event-not-recommended',
197-
},
198-
"plugins/plugin-events/create-server-dot-env",
199-
"plugins/plugin-events/create-server-auth",
200-
"plugins/plugin-events/create-package-json",
201-
"plugins/plugin-events/create-entity-service",
202-
"plugins/plugin-events/create-entity-service-base",
203-
"plugins/plugin-events/create-entity-controller",
204-
"plugins/plugin-events/create-entity-controller-base",
205-
"plugins/plugin-events/create-entity-resolver",
206-
"plugins/plugin-events/create-entity-resolver-base",
207-
"plugins/plugin-events/create-message-broker-service",
208-
"plugins/plugin-events/create-message-broker-service-base",
209-
"plugins/plugin-events/create-message-broker-nestjs-module",
210-
"plugins/plugin-events/create-message-broker-client-options-factory",
211-
"plugins/plugin-events/create-message-broker-topics-enum",
212-
"plugins/plugin-events/create-prisma-schema",
213-
],
214-
}
215-
]
216-
},
217217
{
218218
type: "category",
219219
label: "Learn",

0 commit comments

Comments
 (0)