Improved contributing guide and fix generic resources to use uppercase

pull/190/head
Leandro Damascena 5 years ago
parent cc771d5808
commit c79a3c699a

@ -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

@ -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 = {

@ -8,7 +8,7 @@ class _Compute(_Generic):
_icon_dir = "resources/generic/compute"
class Rack(_Compute):
class RACK(_Compute):
_icon = "rack.png"

@ -24,7 +24,7 @@ class LinuxGeneral(_Os):
_icon = "linux-general.png"
class Suse(_Os):
class SUSE(_Os):
_icon = "suse.png"

@ -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**

Loading…
Cancel
Save