You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-17Lines changed: 14 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,5 @@
1
1
# Azure-PlantUML
2
2
3
-
4
-
5
3
[PlantUML](http://en.plantuml.com/) sprites, macros and stereotypes for creating PlantUML diagrams with [Azure](https://azure.microsoft.com/en-us/) components.
6
4
7
5
Azure-PlantUML includes symbols and useful macros for all Azure services.
@@ -61,7 +59,7 @@ To be independent of any internet connectivity, you can also download `AzureComm
61
59
If you want to use the always up-to-date version in this repo, use the following:
AzureFunction(telemetryFunction, "Telemetry Processing", "v1, App Service plan P3v2, C#", "transform it into a different format, e.g. joining external information")
25
25
AzureCosmosDb(warmStorageCosmos, "Warm Storage", "2,000 RUs", "for consumption, e.g. display on a dashboard")
26
26
27
-
AzureStreamAnalytics(streamAnalytics, "Stream Analytics", "6 SUs", "apply complex queries over time periods, tolerates late (up to 21 days) and out-of-order (up to one hour) events")
27
+
AzureStreamAnalyticsJob(streamAnalytics, "Stream Analytics", "6 SUs", "apply complex queries over time periods, tolerates late (up to 21 days) and out-of-order (up to one hour) events")
AzureBlobStorage(coldBlobStorage, "Cold Storage", "General Purpose v2, Cool, RA-GRS", "all incoming data records are archived indefinitely at low cost, and are easily accessible for batch processing")
Copy file name to clipboardExpand all lines: scripts/README.md
+42-6Lines changed: 42 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,15 +28,17 @@ playwright install-deps
28
28
29
29
## Configure
30
30
31
-
### Icon files
31
+
### Add Icon files
32
32
33
33
Download the [Microsoft Azure architecture icons](https://docs.microsoft.com/en-us/azure/architecture/icons/) and copy all folders from `Azure_Public_Service_Icons_V4\Azure_Public_Service_Icons\Icons` to [source/official](../source/official)
34
34
35
35
Place any icons that are not part of the Microsoft Azure Architecture bundle into [source/manual](../source/manual). For additional icons not in the official set, we suggest using the [Amazing Icon Downloader](https://chrome.google.com/webstore/detail/amazing-icon-downloader/kllljifcjfleikiipbkdcgllbllahaob/)
36
36
37
37
### Application Settings
38
38
39
-
Create a new file named `appsettings.json` within the `scripts` directory and save the following contents:
39
+
Create a new file named `appsettings.json` within the `scripts` directory and add the following content based on your environment:
40
+
41
+
**Windows**
40
42
41
43
```json
42
44
{
@@ -47,12 +49,42 @@ Create a new file named `appsettings.json` within the `scripts` directory and sa
47
49
}
48
50
```
49
51
50
-
### Configuration File: Config.yaml
52
+
**Ubuntu**
51
53
52
-
This configuration file is used to map specific SVG file names to Azure services.
53
-
On top each Azure service is mapped to his primary category.
> The path to PlantUML may vary based on the version you are using and how you installed it. Be sure to update the value for `plantUmlPath` accordingly to match your envioronment.
75
+
76
+
### Update Config.yaml
77
+
78
+
Update this file to add or remove icons in your distro. The `source` attribute represents the svg file name. Logic has been added to the PlantUML generation program to simplify the value used here. Dashes, spaces, and certain prefixes and suffixes are removed when searching for source files. For example, adding **App Service Plan Linux** will work for the following source files:
The `target` attribute will be used for the PlantUML element stereotype and all target file names. Keep in mind that services are grouped into categories as reflected in the YAML structure.
86
+
87
+
## Generate PlantUML Elements
56
88
57
89
Use `dotnet run` from the `scripts` folder to execute the application.
58
90
@@ -77,3 +109,7 @@ From a logical point of view, the following happens:
77
109
1. In addition to single Azure services PUML files, also a combined PUML file per category is generated
78
110
1. A markdown table with all Azure services, their colored and monochrome symbols and the PUML files is generated
79
111
1. VSCode snippets for all Azure services for their PlantUML usage are generated
112
+
113
+
## Update the Azure Symbols page
114
+
115
+
When the program completes, replace the markdown table in [AzureSymbols.md](https://github.com/plantuml-stdlib/Azure-PlantUML/blob/release/2-2/AzureSymbols.md?plain=1#L34) with the contents from `table.md` located in your target folder.
0 commit comments