From c79a3c699a9952cf376fc4c1b52336df92a86f44 Mon Sep 17 00:00:00 2001
From: Leandro Damascena <leandro.damascena@gmail.com>
Date: Fri, 5 Jun 2020 12:08:12 +0100
Subject: [PATCH] Improved contributing guide and fix generic resources to use
 uppercase

---
 CONTRIBUTING.md             | 23 +++++++++++++++++++++++
 config.py                   |  2 +-
 diagrams/generic/compute.py |  2 +-
 diagrams/generic/os.py      |  2 +-
 docs/nodes/generic.md       |  4 ++--
 5 files changed, 28 insertions(+), 5 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 22aa1475..668be817 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -50,6 +50,29 @@ Then just run the `./autogen.sh` to generate the added or updated aliases.
 > [inkscape][inkscape] command lines that are used for clearning the image
 > resource filenames.
 
+### Uppercase Words
+
+Resources with 2 to 4 characters words must be configured to use Uppercase. For example `sdk`, `ios`, `xen`, `ec2`, and others.
+
+So, update the `UPPER_WORDS` in [config.py](config.py).
+
+Example:
+```shell
+UPPER_WORDS = {
+    "aws": ("aws", "api", "ebs", "ec2", "efs", "emr", "rds", "ml", "mq", "nat", "vpc", "waf", "sdk"),
+    "azure": ("ad", "b2c", "ai", "api", "cdn", "ddos", "dns", "fxt", "hana", "hd", "id", "sap", "sql", "vm"),
+    "gcp": ("gcp", "ai", "api", "cdn", "dns", "gke", "gpu", "iap", "ml", "nat", "os", "sdk", "sql", "tpu", "vpn"),
+    "firebase": ("ab", "fcm", "ml"),
+    "k8s": (
+        "api", "cm", "ccm", "crb", "crd", "ds", "etcd", "hpa", "k8s", "ns", "psp", "pv", "pvc", "rb", "rs",
+        "sa", "sc", "sts", "svc",
+    ),
+    "oci": ("oci",),
+    "elastic": ("apm", "siem", "ece", "eck"),
+    "generic": ("vpn","ios","xen","suse","rack"),
+}
+```
+
 ## Run Tests
 
 ```shell
diff --git a/config.py b/config.py
index 2c7a72d8..d75defab 100644
--- a/config.py
+++ b/config.py
@@ -62,7 +62,7 @@ UPPER_WORDS = {
     ),
     "oci": ("oci",),
     "elastic": ("apm", "siem", "ece", "eck"),
-    "generic": ("vpn","ios","xen"),
+    "generic": ("vpn","ios","xen","suse","rack"),
 }
 
 TITLE_WORDS = {
diff --git a/diagrams/generic/compute.py b/diagrams/generic/compute.py
index 436c641e..49164e02 100644
--- a/diagrams/generic/compute.py
+++ b/diagrams/generic/compute.py
@@ -8,7 +8,7 @@ class _Compute(_Generic):
     _icon_dir = "resources/generic/compute"
 
 
-class Rack(_Compute):
+class RACK(_Compute):
     _icon = "rack.png"
 
 
diff --git a/diagrams/generic/os.py b/diagrams/generic/os.py
index 695f2954..5c0b5e39 100644
--- a/diagrams/generic/os.py
+++ b/diagrams/generic/os.py
@@ -24,7 +24,7 @@ class LinuxGeneral(_Os):
     _icon = "linux-general.png"
 
 
-class Suse(_Os):
+class SUSE(_Os):
     _icon = "suse.png"
 
 
diff --git a/docs/nodes/generic.md b/docs/nodes/generic.md
index ce9a5f2d..ce306871 100644
--- a/docs/nodes/generic.md
+++ b/docs/nodes/generic.md
@@ -11,7 +11,7 @@ Node classes list of generic provider.
 
 ## generic.compute
 
-- **diagrams.generic.compute.Rack**
+- **diagrams.generic.compute.RACK**
 
 ## generic.device
 
@@ -31,7 +31,7 @@ Node classes list of generic provider.
 - **diagrams.generic.os.Centos**
 - **diagrams.generic.os.IOS**
 - **diagrams.generic.os.LinuxGeneral**
-- **diagrams.generic.os.Suse**
+- **diagrams.generic.os.SUSE**
 - **diagrams.generic.os.Ubuntu**
 - **diagrams.generic.os.Windows**