diff --git a/docs/getting-started/examples.md b/docs/getting-started/examples.md index caa51cc7..4ae4c1ad 100644 --- a/docs/getting-started/examples.md +++ b/docs/getting-started/examples.md @@ -21,7 +21,7 @@ with Diagram("Grouped Workers", show=False, direction="TB"): EC2("worker5")] >> RDS("events") ``` -![grouped workers diagram](/img/grouped_workers_diagram.png) +![grouped workers diagram](/diagrams/img/grouped_workers_diagram.png) ## Clustered Web Services @@ -52,7 +52,7 @@ with Diagram("Clustered Web Services", show=False): svc_group >> memcached ``` -![clustered web services diagram](/img/clustered_web_services_diagram.png) +![clustered web services diagram](/diagrams/img/clustered_web_services_diagram.png) ## Event Processing on AWS @@ -87,7 +87,7 @@ with Diagram("Event Processing", show=False): handlers >> dw ``` -![event processing diagram](/img/event_processing_diagram.png) +![event processing diagram](/diagrams/img/event_processing_diagram.png) ## Message Collecting System on GCP @@ -125,7 +125,7 @@ with Diagram("Message Collecting", show=False): pubsub >> flow ``` -![message collecting diagram](/img/message_collecting_diagram.png) +![message collecting diagram](/diagrams/img/message_collecting_diagram.png) ## Exposed Pod with 3 Replicas on Kubernetes @@ -143,7 +143,7 @@ with Diagram("Exposed Pod with 3 Replicas", show=False): ``` -![exposed pod with 3 replicas diagram](/img/exposed_pod_with_3_replicas_diagram.png) +![exposed pod with 3 replicas diagram](/diagrams/img/exposed_pod_with_3_replicas_diagram.png) ## Stateful Architecture on Kubernetes @@ -168,7 +168,7 @@ with Diagram("Stateful Architecture", show=False): apps << PV("pv") << StorageClass("sc") ``` -![stateful architecture diagram](/img/stateful_architecture_diagram.png) +![stateful architecture diagram](/diagrams/img/stateful_architecture_diagram.png) ## Advanced Web Service with On-Premise @@ -211,7 +211,7 @@ with Diagram("Advanced Web Service with On-Premise", show=False): ingress >> grpcsvc >> aggregator ``` -![advanced web service with on-premise diagram](/img/advanced_web_service_with_on-premise.png) +![advanced web service with on-premise diagram](/diagrams/img/advanced_web_service_with_on-premise.png) ## Advanced Web Service with On-Premise (with colors and labels) @@ -254,7 +254,7 @@ with Diagram(name="Advanced Web Service with On-Premise (colored)", show=False): ingress >> Edge(color="darkgreen") << grpcsvc >> Edge(color="darkorange") >> aggregator ``` -![advanced web service with on-premise diagram colored](/img/advanced_web_service_with_on-premise_colored.png) +![advanced web service with on-premise diagram colored](/diagrams/img/advanced_web_service_with_on-premise_colored.png) ## RabbitMQ Consumers with Custom Nodes @@ -283,4 +283,4 @@ with Diagram("Broker Consumers", show=False): queue >> consumers >> Aurora("Database") ``` -![rabbitmq consumers diagram](/img/rabbitmq_consumers_diagram.png) +![rabbitmq consumers diagram](/diagrams/img/rabbitmq_consumers_diagram.png) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 90f6be80..5dbb6f59 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -39,7 +39,7 @@ This code generates below diagram. $ python diagram.py ``` -![web service diagram](/img/web_service_diagram.png) +![web service diagram](/diagrams/img/web_service_diagram.png) It will be saved as `web_service.png` on your working directory. diff --git a/docs/guides/cluster.md b/docs/guides/cluster.md index f4b55b2d..5a7189c2 100644 --- a/docs/guides/cluster.md +++ b/docs/guides/cluster.md @@ -29,7 +29,7 @@ with Diagram("Simple Web Service with DB Cluster", show=False): dns >> web >> db_primary ``` -![simple web service with db cluster diagram](/img/simple_web_service_with_db_cluster_diagram.png) +![simple web service with db cluster diagram](/diagrams/img/simple_web_service_with_db_cluster_diagram.png) ## Nested Clusters @@ -66,6 +66,6 @@ with Diagram("Event Processing", show=False): handlers >> dw ``` -![event processing diagram](/img/event_processing_diagram.png) +![event processing diagram](/diagrams/img/event_processing_diagram.png) > There is no depth limit of nesting. Feel free to create nested clusters as deep as you want. diff --git a/docs/guides/edge.md b/docs/guides/edge.md index 622ef950..3cb16705 100644 --- a/docs/guides/edge.md +++ b/docs/guides/edge.md @@ -66,4 +66,4 @@ with Diagram(name="Advanced Web Service with On-Premise (colored)", show=False): >> aggregator ``` -![advanced web service with on-premise diagram colored](/img/advanced_web_service_with_on-premise_colored.png) +![advanced web service with on-premise diagram colored](/diagrams/img/advanced_web_service_with_on-premise_colored.png) diff --git a/docs/guides/node.md b/docs/guides/node.md index f0f524a7..7cd4d3e8 100644 --- a/docs/guides/node.md +++ b/docs/guides/node.md @@ -7,7 +7,7 @@ Node is a second object representing a node or system component. ## Basic -Node is an abstract concept that represents a single system component object. +Node is an abstract concept that represents a single system component object. A node object consists of three parts: **provider**, **resource type** and **name**. You may already have seen each part in the previous example. @@ -42,7 +42,7 @@ from diagrams.alibabacloud.storage import ObjectTableStore # gcp resources from diagrams.gcp.compute import AppEngine, GKE -from diagrams.gcp.ml import AutoML +from diagrams.gcp.ml import AutoML ... # k8s resources @@ -63,7 +63,7 @@ You can find all available nodes list in [Here](https://diagrams.mingrammer.com/ You can represent data flow by connecting the nodes with these operators: `>>`, `<<` and `-`. -* **>>**: Connect nodes in left to right direction. +* **>>**: Connect nodes in left to right direction. * **<<**: Connect nodes in right to left direction. * **-**: Connect nodes in no direction. Undirected. @@ -80,9 +80,9 @@ with Diagram("Web Services", show=False): (ELB("lb") >> EC2("web")) - EC2("web") >> RDS("userdb") ``` -> Be careful when using the `-` and any shift operators together, which could cause unexpected results due to operator precedence. +> Be careful when using the `-` and any shift operators together, which could cause unexpected results due to operator precedence. -![web services diagram](/img/web_services_diagram.png) +![web services diagram](/diagrams/img/web_services_diagram.png) > The order of rendered diagrams is the reverse of the declaration order. @@ -106,7 +106,7 @@ with Diagram("Workers", show=False, direction="TB"): lb >> EC2("worker5") >> db ``` -![workers diagram](/img/workers_diagram.png) +![workers diagram](/diagrams/img/workers_diagram.png) ## Group Data Flow @@ -126,6 +126,6 @@ with Diagram("Grouped Workers", show=False, direction="TB"): EC2("worker5")] >> RDS("events") ``` -![grouped workers diagram](/img/grouped_workers_diagram.png) +![grouped workers diagram](/diagrams/img/grouped_workers_diagram.png) > You can't connect two **lists** directly because shift/arithmetic operations between lists are not allowed in Python. diff --git a/docs/nodes/custom.md b/docs/nodes/custom.md index 904e0e86..c248e22d 100644 --- a/docs/nodes/custom.md +++ b/docs/nodes/custom.md @@ -84,7 +84,7 @@ with Diagram("Custom with remote icons", show=False, filename="custom_remote", d It will generate the following diagram: -![custom local](/img/custom_remote.png) +![custom local](/diagrams/img/custom_remote.png) Another example can be found [Here](https://diagrams.mingrammer.com/docs/getting-started/examples#rabbitmq-consumers-with-custom-nodes). \ No newline at end of file