Исправления в документации.
This commit is contained in:
@@ -51,6 +51,48 @@ IMPORTANT CONSIDERATIONS:
|
||||
5. Implement validation for input variables where appropriate.
|
||||
```
|
||||
|
||||
## Diagram Formatting Guidelines
|
||||
|
||||
When interpreting the PlantUML diagrams, note that they follow specific formatting conventions to clearly represent infrastructure components and their relationships.
|
||||
|
||||
### Activity Diagram Formatting
|
||||
|
||||
Activity diagrams use a structured format with header separators (====) and detail separators (----):
|
||||
|
||||
```
|
||||
:Activity Name
|
||||
====
|
||||
parameter1=value1
|
||||
parameter2=value2
|
||||
parameter3=value3
|
||||
----
|
||||
Additional context or explanation;
|
||||
```
|
||||
|
||||
The parameters section contains key configuration values, and variables are properly escaped with single quotes when they contain special characters (like Terraform variables):
|
||||
|
||||
Example: `local_path='${kubeconfig_path}'` instead of `local_path=${kubeconfig_path}`
|
||||
|
||||
### Component Diagram Formatting
|
||||
|
||||
Component diagrams use the C4 model approach with consistent tagging:
|
||||
|
||||
```
|
||||
Component(id, "Name", "Technology", "Description", $tags="tag")
|
||||
```
|
||||
|
||||
### Sequence Diagram Formatting
|
||||
|
||||
Sequence diagrams show detailed interactions with parameters and context similar to activity diagrams, using the same header/detail separator pattern.
|
||||
|
||||
### Deployment Diagram Formatting
|
||||
|
||||
Deployment diagrams use consistent stereotypes (<<Server>>, <<Worker>>, <<Config>>) and clear connection representations.
|
||||
|
||||
### Class Diagram Formatting
|
||||
|
||||
Class diagrams represent Terraform resources as UML classes with proper property types and relationships.
|
||||
|
||||
## Modifying the Infrastructure
|
||||
|
||||
To modify the infrastructure, you can:
|
||||
|
||||
Reference in New Issue
Block a user