Merge pull request #1023 from mingrammer/1020-fix-the-spelling-typo-o…

…nprem-=-on-premises-not-premise fix: Refactor on-premises service names for consistency
mingrammer · Oct 15, 2024 · 978d774 · 978d774
2 parents 2aed805 + 360c6bc
commit 978d774
Show file tree

Hide file tree

Showing 12 changed files with 31 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -394,3 +394,17 @@ The following import changes:
 ### Added
 
 - Support kubernetes diagrams: [3eda1cb](https://github.com/mingrammer/diagrams/commit/3eda1cb6bca8be8a55773d90b93483a8fab3e0f1)
+
+
+## v0.23.5
+
+### Breaking Changes
+
+The following import changes:
+
+#### OCI
+
+| Old import path                                                    | New import path                                               |
+| -------------------------------------------------------------------| --------------------------------------------------------------|
+| `from diagrams.oci.connectivity import CustomerPremiseWhite`       | `from diagrams.oci.connectivity import CustomerPremisesWhite` |
+| `from diagrams.oci.connectivity import CustomerPremises`           | `from diagrams.oci.connectivity import CustomerPremises`      |
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -77,11 +77,11 @@ Node classes list of the oci provider.
 <img width="30" src="/img/resources/oci/connectivity/customer-datacntr-white.png" alt="CustomerDatacntrWhite" style="float: left; padding-right: 5px;" >
 **diagrams.oci.connectivity.CustomerDatacntrWhite**
 
-<img width="30" src="/img/resources/oci/connectivity/customer-premise-white.png" alt="CustomerPremiseWhite" style="float: left; padding-right: 5px;" >
-**diagrams.oci.connectivity.CustomerPremiseWhite**
+<img width="30" src="/img/resources/oci/connectivity/customer-premises-white.png" alt="CustomerPremisesWhite" style="float: left; padding-right: 5px;" >
+**diagrams.oci.connectivity.CustomerPremisesWhite**
 
-<img width="30" src="/img/resources/oci/connectivity/customer-premise.png" alt="CustomerPremise" style="float: left; padding-right: 5px;" >
-**diagrams.oci.connectivity.CustomerPremise**
+<img width="30" src="/img/resources/oci/connectivity/customer-premises.png" alt="CustomerPremises" style="float: left; padding-right: 5px;" >
+**diagrams.oci.connectivity.CustomerPremises**
 
 <img width="30" src="/img/resources/oci/connectivity/disconnected-regions-white.png" alt="DisconnectedRegionsWhite" style="float: left; padding-right: 5px;" >
 **diagrams.oci.connectivity.DisconnectedRegionsWhite**

diff --git a/...i/connectivity/customer-premise-white.png → .../connectivity/customer-premises-white.png b/...i/connectivity/customer-premise-white.png → .../connectivity/customer-premises-white.png
diff --git a/...ces/oci/connectivity/customer-premise.png → ...es/oci/connectivity/customer-premises.png b/...ces/oci/connectivity/customer-premise.png → ...es/oci/connectivity/customer-premises.png
diff --git 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.
         </MarkdownBlock>
         <MarkdownBlock>
-            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.
         </MarkdownBlock>
         <MarkdownBlock>
             `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/.../advanced_web_service_with_on-premise.png → ...advanced_web_service_with_on-premises.png b/.../advanced_web_service_with_on-premise.png → ...advanced_web_service_with_on-premises.png
diff --git a/...d_web_service_with_on-premise_colored.png → ..._web_service_with_on-premises_colored.png b/...d_web_service_with_on-premise_colored.png → ..._web_service_with_on-premises_colored.png