From e6aaeaa4f40283e4be0230b173424e859c6e0506 Mon Sep 17 00:00:00 2001 From: Filipe Oliveira <144428646+filipeaaoliveira@users.noreply.github.com> Date: Mon, 30 Sep 2024 21:50:46 +0100 Subject: [PATCH] fix: Refactor on-premises service names for consistency --- README.md | 6 +++--- diagrams/oci/connectivity.py | 8 ++++---- diagrams/onprem/__init__.py | 2 +- docs/getting-started/examples.md | 4 ++-- docs/guides/edge.md | 4 ++-- docs/nodes/oci.md | 8 ++++---- ...remise-white.png => customer-premises-white.png} | Bin .../{customer-premise.png => customer-premises.png} | Bin website/pages/en/index.js | 2 +- ...ng => advanced_web_service_with_on-premises.png} | Bin ...vanced_web_service_with_on-premises_colored.png} | Bin 11 files changed, 17 insertions(+), 17 deletions(-) rename resources/oci/connectivity/{customer-premise-white.png => customer-premises-white.png} (100%) rename resources/oci/connectivity/{customer-premise.png => customer-premises.png} (100%) rename website/static/img/{advanced_web_service_with_on-premise.png => advanced_web_service_with_on-premises.png} (100%) rename website/static/img/{advanced_web_service_with_on-premise_colored.png => advanced_web_service_with_on-premises_colored.png} (100%) diff --git a/README.md b/README.md index 086a684c..a24d11f0 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ **Diagram as Code**. -Diagrams lets you draw the cloud system architecture **in Python code**. It was born for **prototyping** a new system architecture design without any design tools. You can also describe or visualize the existing system architecture as well. Diagrams currently supports main major providers including: `AWS`, `Azure`, `GCP`, `Kubernetes`, `Alibaba Cloud`, `Oracle Cloud` etc... It also supports `On-Premise` nodes, `SaaS` and major `Programming` frameworks and languages. +Diagrams lets you draw the cloud system architecture **in Python code**. It was born for **prototyping** a new system architecture design without any design tools. You can also describe or visualize the existing system architecture as well. Diagrams currently supports main major providers including: `AWS`, `Azure`, `GCP`, `Kubernetes`, `Alibaba Cloud`, `Oracle Cloud` etc... It also supports `On-Premises` nodes, `SaaS` and major `Programming` frameworks and languages. **Diagram as Code** also allows you to **track** the architecture diagram changes in any **version control** system. @@ -33,7 +33,7 @@ Diagrams lets you draw the cloud system architecture **in Python code**. It was ![digital ocean provider](https://img.shields.io/badge/DigitalOcean-0080ff?logo=digitalocean&color=0080ff) ![elastic provider](https://img.shields.io/badge/Elastic-orange?logo=elastic&color=005571) ![outscale provider](https://img.shields.io/badge/OutScale-orange?color=5f87bf) -![on premise provider](https://img.shields.io/badge/OnPremise-orange?color=5f87bf) +![on premises provider](https://img.shields.io/badge/OnPremises-orange?color=5f87bf) ![generic provider](https://img.shields.io/badge/Generic-orange?color=5f87bf) ![programming provider](https://img.shields.io/badge/Programming-orange?color=5f87bf) ![saas provider](https://img.shields.io/badge/SaaS-orange?color=5f87bf) @@ -64,7 +64,7 @@ You can start with [quick start](https://diagrams.mingrammer.com/docs/getting-st | Event Processing | Stateful Architecture | Advanced Web Service | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| ![event processing](https://diagrams.mingrammer.com/img/event_processing_diagram.png) | ![stateful architecture](https://diagrams.mingrammer.com/img/stateful_architecture_diagram.png) | ![advanced web service with on-premise](https://diagrams.mingrammer.com/img/advanced_web_service_with_on-premise.png) | +| ![event processing](https://diagrams.mingrammer.com/img/event_processing_diagram.png) | ![stateful architecture](https://diagrams.mingrammer.com/img/stateful_architecture_diagram.png) | ![advanced web service with on-premises](https://diagrams.mingrammer.com/img/advanced_web_service_with_on-premises.png) | You can find all the examples on the [examples](https://diagrams.mingrammer.com/docs/getting-started/examples) page. diff --git a/diagrams/oci/connectivity.py b/diagrams/oci/connectivity.py index 8c51f602..658ac0a7 100644 --- a/diagrams/oci/connectivity.py +++ b/diagrams/oci/connectivity.py @@ -32,12 +32,12 @@ class CustomerDatacntrWhite(_Connectivity): _icon = "customer-datacntr-white.png" -class CustomerPremiseWhite(_Connectivity): - _icon = "customer-premise-white.png" +class CustomerPremisesWhite(_Connectivity): + _icon = "customer-premises-white.png" -class CustomerPremise(_Connectivity): - _icon = "customer-premise.png" +class CustomerPremises(_Connectivity): + _icon = "customer-premises.png" class DisconnectedRegionsWhite(_Connectivity): diff --git a/diagrams/onprem/__init__.py b/diagrams/onprem/__init__.py index e0a9596d..73d3e1fb 100644 --- a/diagrams/onprem/__init__.py +++ b/diagrams/onprem/__init__.py @@ -1,5 +1,5 @@ """ -OnPrem provides a set of general on-premise services. +OnPrem provides a set of general on-premises services. """ from diagrams import Node diff --git a/docs/getting-started/examples.md b/docs/getting-started/examples.md index caa51cc7..d2d2f4c7 100644 --- a/docs/getting-started/examples.md +++ b/docs/getting-started/examples.md @@ -170,7 +170,7 @@ with Diagram("Stateful Architecture", show=False): ![stateful architecture diagram](/img/stateful_architecture_diagram.png) -## Advanced Web Service with On-Premise +## Advanced Web Service with On-Premises ```python from diagrams import Cluster, Diagram @@ -183,7 +183,7 @@ from diagrams.onprem.monitoring import Grafana, Prometheus from diagrams.onprem.network import Nginx from diagrams.onprem.queue import Kafka -with Diagram("Advanced Web Service with On-Premise", show=False): +with Diagram("Advanced Web Service with On-Premises", show=False): ingress = Nginx("ingress") metrics = Prometheus("metric") diff --git a/docs/guides/edge.md b/docs/guides/edge.md index d1e8dfef..befee710 100644 --- a/docs/guides/edge.md +++ b/docs/guides/edge.md @@ -22,7 +22,7 @@ from diagrams.onprem.monitoring import Grafana, Prometheus from diagrams.onprem.network import Nginx from diagrams.onprem.queue import Kafka -with Diagram(name="Advanced Web Service with On-Premise (colored)", show=False): +with Diagram(name="Advanced Web Service with On-Premises (colored)", show=False): ingress = Nginx("ingress") metrics = Prometheus("metric") @@ -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-premises diagram colored](/img/advanced_web_service_with_on-premises_colored.png) diff --git a/docs/nodes/oci.md b/docs/nodes/oci.md index d75d92b3..321c6383 100644 --- a/docs/nodes/oci.md +++ b/docs/nodes/oci.md @@ -77,11 +77,11 @@ Node classes list of oci provider. CustomerDatacntrWhite **diagrams.oci.connectivity.CustomerDatacntrWhite** -CustomerPremiseWhite -**diagrams.oci.connectivity.CustomerPremiseWhite** +CustomerPremisesWhite +**diagrams.oci.connectivity.CustomerPremisesWhite** -CustomerPremise -**diagrams.oci.connectivity.CustomerPremise** +CustomerPremises +**diagrams.oci.connectivity.CustomerPremises** DisconnectedRegionsWhite **diagrams.oci.connectivity.DisconnectedRegionsWhite** diff --git a/resources/oci/connectivity/customer-premise-white.png b/resources/oci/connectivity/customer-premises-white.png similarity index 100% rename from resources/oci/connectivity/customer-premise-white.png rename to resources/oci/connectivity/customer-premises-white.png diff --git a/resources/oci/connectivity/customer-premise.png b/resources/oci/connectivity/customer-premises.png similarity index 100% rename from resources/oci/connectivity/customer-premise.png rename to resources/oci/connectivity/customer-premises.png diff --git a/website/pages/en/index.js b/website/pages/en/index.js index 690368a6..34b711a6 100644 --- a/website/pages/en/index.js +++ b/website/pages/en/index.js @@ -106,7 +106,7 @@ class Index extends React.Component { `Diagram as Code` allows you to **track** the architecture diagram changes in any **version control** system. - Diagrams currently supports main major providers including: `AWS`, `Azure`, `GCP`, `Kubernetes`, `Alibaba Cloud`, `Oracle Cloud` etc... It also supports `On-Premise` nodes, `SaaS` and major `Programming` frameworks and languages. + Diagrams currently supports main major providers including: `AWS`, `Azure`, `GCP`, `Kubernetes`, `Alibaba Cloud`, `Oracle Cloud` etc... It also supports `On-Premises` nodes, `SaaS` and major `Programming` frameworks and languages. `NOTE: It does not control any actual cloud resources nor does it generate cloud formation or terraform code. It is just for drawing the cloud system architecture diagrams.` diff --git a/website/static/img/advanced_web_service_with_on-premise.png b/website/static/img/advanced_web_service_with_on-premises.png similarity index 100% rename from website/static/img/advanced_web_service_with_on-premise.png rename to website/static/img/advanced_web_service_with_on-premises.png diff --git a/website/static/img/advanced_web_service_with_on-premise_colored.png b/website/static/img/advanced_web_service_with_on-premises_colored.png similarity index 100% rename from website/static/img/advanced_web_service_with_on-premise_colored.png rename to website/static/img/advanced_web_service_with_on-premises_colored.png