Created initial solution-structure document

abpio · Dec 13, 2023 · 127269c · 127269c
1 parent 42afd23
commit 127269c
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 7 deletions.
diff --git a/en/studio/_planning.md b/en/studio/_planning.md
@@ -24,10 +24,10 @@
   * Referencing packages
   * Working With Existing Modules
     * Import, Install, Uninstall, Download Source Code
+* Solution Explorer
 * **Running Applications**
 * **Monitoring Applications**
 * **Working with Kubernetes**
-* Exploring modules
 * Analyzing Packages
 * Using the ABP Studio CLI
 * Extensibility / Plugin System

diff --git a/en/studio/quick-starts/microservice.md b/en/studio/quick-starts/microservice.md
@@ -56,7 +56,7 @@ Once you select the desired modules, click the *Next* button for the *UI Theme*
 
 ![abp-studio-new-solution-dialog-ui-theme](images/abp-studio-new-solution-dialog-ui-theme-microservice.png)
 
-LeptonX is the suggested UI theme that is proper for production usage. Select one of the themes and configure additional options if you want.
+LeptonX is the suggested UI theme that is proper for production usage. Select one of the themes and configure the additional options if you want.
 
 Now, we are ready to allow ABP Studio to create our solution. Just click the *Create* button and let it go. After clicking the Create button, the dialog is closed and your solution is loaded into ABP Studio:
 
@@ -68,9 +68,9 @@ You can explore the solution, but you need to wait for background tasks to be co
 
 ## Exploring the Solution
 
-This solution consists of several modules shown in the *Solution Explorer* section:
+This **solution** consists of several **modules** shown in the *Solution Explorer* section:
 
-> You can refer the *[Concepts](../concepts.md)* document to learn what do solution and module terms mean.
+> You can refer the ***[Concepts](../concepts.md)*** document to learn what do **solution** and **module** terms mean.
 
 ![abp-studio-created-microservice-solution-explorer](images/abp-studio-created-microservice-solution-explorer.png)
 

diff --git a/en/studio/solution-explorer.md b/en/studio/solution-explorer.md
@@ -0,0 +1,3 @@
+# ABP Studio Solution Explorer
+
+*TODO*
diff --git a/...io/solution-templates/microservice/images/microservice-solution-in-explorer.png b/...io/solution-templates/microservice/images/microservice-solution-in-explorer.png
diff --git a/en/studio/solution-templates/microservice/index.md b/en/studio/solution-templates/microservice/index.md
@@ -4,15 +4,15 @@ ABP Studio provides pre-architected and production-ready templates to jump start
 
 > **This document explains the Microservice solution template in every details. So, it is a reference document to fully understand the solution and refer when you have trouble.**
 >
-> **If you just want to quickly create a microservice solution, please refer to *[Quick Start: Creating a Microservice Solution with ABP Studio](../quick-starts/microservice.md)* document.**
+> **If you just want to quickly create a microservice solution, please refer to *[Quick Start: Creating a Microservice Solution with ABP Studio](../../quick-starts/microservice.md)* document.**
 
 ## Contents
 
 > *Documentation is still on going...*
 
 * [Overview](overview.md)
 * Architecture
-  * Folder and solution structure
+  * [Folder and solution structure](solution-structure.md)
   * Authentication
 * Main Components
   * Microservices
@@ -36,7 +36,7 @@ ABP Studio provides pre-architected and production-ready templates to jump start
   * Distributed Events
   * HTTP API Calls
   * gRPC Calls
-* Helm and Kubernetes
+* Helm Charts and Kubernetes
 * Guides
   * Adding new microservices
   * Adding new applications

diff --git a/en/studio/solution-templates/microservice/solution-structure.md b/en/studio/solution-templates/microservice/solution-structure.md
@@ -0,0 +1,31 @@
+# ABP Studio Microservice Solution Structure
+
+This document explains the solution and folder structure of ABP Studio's [microservice solution template](index.md).
+
+> This document assumes that you've created a new microservice solution by following the *[Quick Start: Creating a Microservice Solution with ABP Studio](../../quick-starts/microservice.md)* guide.
+
+## Understanding the Modules
+
+When you create a new microservice solution, you will see a tree structure similar to the one below in the *Solution Explorer* panel:
+
+![microservice-solution-in-explorer](images/microservice-solution-in-explorer.png)
+
+Each leaf item (e.g. `Acme.CloudCrm.IdentityService`, `Acme.CloudCrm.Web`, `Acme.CloudCrm.WebGateway`...) in the tree above is an **ABP Studio module**. An ABP Studio module can be a web application, an API gateway, a microservice, a console application or whatever .NET allows you to build. They are grouped into **solution folders** (`apps`, `gateways` and `services`) in that solution.
+
+**Each ABP Studio module has a separate .NET solution**; this allows your team to develop them individually, in keeping with the nature of the microservices architecture.
+
+> Refer to the *[Concepts](../../concepts.md)* document for a full definition of ABP Studio solution, module and package terms.
+
+The next sections explains the purpose of these modules.
+
+### AuthServer
+
+`Acme.CloudCrm.AuthServer` is the authentication server of the system. It is a single-sign-on point, which means all the applications are using it for user login. Once users login via an application, they don't need to enter credentials (username, password) again for the other applications in the same browser, until they logout from one of the applications.
+
+The `AuthServer` application is also used by microservices as the Authority for JWT Bearer Authentication.
+
+That application is mainly based on the [OpenIddict](../../../modules/openiddict.md), the [Identity](../../../modules/identity.md), and the [Account](../../../modules/account.md) modules. So, it basically has login, register, forgot password, two factor authentication and other authentication related pages.
+
+### Maui
+
+This is the mobile application that is built based on Microsoft MAUI framework.