add table of content to root readme

Richin · Oct 26, 2022 · 51ffffb · 51ffffb
1 parent d409a5e
commit 51ffffb
Show file tree

Hide file tree

Showing 75 changed files with 549 additions and 228 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/anti-patterns/index.md b/docs/anti-patterns/index.md
diff --git a/docs/architectural-design-principles/design-patterns.md b/docs/architectural-design-principles/design-patterns.md
diff --git a/docs/architectural-design-principles/index.md b/docs/architectural-design-principles/index.md
diff --git a/docs/azure/azure-security/azure-security.md b/docs/azure/azure-security/azure-security.md
diff --git a/docs/cloud-design-patterns/index.md b/docs/cloud-design-patterns/index.md
diff --git a/docs/cloud-native/cloud-native.md → docs/cloud-native.md b/docs/cloud-native/cloud-native.md → docs/cloud-native.md
diff --git a/docs/cloud-native/api-gateway/api-gateway.md b/docs/cloud-native/api-gateway/api-gateway.md
diff --git a/docs/cloud-native/api-gateway/index.md b/docs/cloud-native/api-gateway/index.md
diff --git a/docs/cloud-native/api-gateway/kong.md b/docs/cloud-native/api-gateway/kong.md
diff --git a/docs/cloud-native/api-gateway/ocelot.md b/docs/cloud-native/api-gateway/ocelot.md
diff --git a/docs/cloud-native/devops/kubernetes/deployment-tools/index.md b/docs/cloud-native/devops/kubernetes/deployment-tools/index.md
diff --git a/docs/cloud-native/devops/kubernetes/ingress-controller/index.md b/docs/cloud-native/devops/kubernetes/ingress-controller/index.md
diff --git a/docs/cloud-native/devops/kubernetes/other-tools/index.md b/docs/cloud-native/devops/kubernetes/other-tools/index.md
diff --git a/docs/cloud-native/index.md b/docs/cloud-native/index.md
diff --git a/docs/cloud-native/reverse-proxy-lb/index.md b/docs/cloud-native/reverse-proxy-lb/index.md
diff --git a/docs/cloud-native/service-discovery/index.md b/docs/cloud-native/service-discovery/index.md
diff --git a/docs/cloud-native/service-mesh/index.md b/docs/cloud-native/service-mesh/index.md
diff --git a/docs/design-best-practices/index.md b/docs/design-best-practices/index.md
diff --git a/docs/design-patterns/index.md b/docs/design-patterns/index.md
diff --git a/...cloud-native/devops/ci-cd/azure-devops.md → docs/devops/ci-cd/azure-devops.md b/...cloud-native/devops/ci-cd/azure-devops.md → docs/devops/ci-cd/azure-devops.md
diff --git a/...oud-native/devops/ci-cd/github-actions.md → docs/devops/ci-cd/github-actions.md b/...oud-native/devops/ci-cd/github-actions.md → docs/devops/ci-cd/github-actions.md
diff --git a/docs/cloud-native/devops/ci-cd/jenkins.md → docs/devops/ci-cd/jenkins.md b/docs/cloud-native/devops/ci-cd/jenkins.md → docs/devops/ci-cd/jenkins.md
diff --git a/docs/cloud-native/devops/containerd.md → docs/devops/containerd.md b/docs/cloud-native/devops/containerd.md → docs/devops/containerd.md
diff --git a/...ud-native/devops/docker/docker-compose.md → docs/devops/docker/docker-compose.md b/...ud-native/devops/docker/docker-compose.md → docs/devops/docker/docker-compose.md
diff --git a/docs/cloud-native/devops/docker/docker.md → docs/devops/docker/docker.md b/docs/cloud-native/devops/docker/docker.md → docs/devops/docker/docker.md
diff --git a/...evops/kubernetes/deployment-strategies.md → ...evops/kubernetes/deployment-strategies.md b/...evops/kubernetes/deployment-strategies.md → ...evops/kubernetes/deployment-strategies.md
diff --git a/...ps/kubernetes/deployment-tools/argo-cd.md → ...ps/kubernetes/deployment-tools/argo-cd.md b/...ps/kubernetes/deployment-tools/argo-cd.md → ...ps/kubernetes/deployment-tools/argo-cd.md
diff --git a/...evops/kubernetes/deployment-tools/flux.md → ...evops/kubernetes/deployment-tools/flux.md b/...evops/kubernetes/deployment-tools/flux.md → ...evops/kubernetes/deployment-tools/flux.md
diff --git a/...evops/kubernetes/deployment-tools/helm.md → ...evops/kubernetes/deployment-tools/helm.md b/...evops/kubernetes/deployment-tools/helm.md → ...evops/kubernetes/deployment-tools/helm.md
diff --git a/...ps/kubernetes/deployment-tools/jenkins.md → ...ps/kubernetes/deployment-tools/jenkins.md b/...ps/kubernetes/deployment-tools/jenkins.md → ...ps/kubernetes/deployment-tools/jenkins.md
diff --git a/...s/deployment-tools/kubernetes-operator.md → ...s/deployment-tools/kubernetes-operator.md b/...s/deployment-tools/kubernetes-operator.md → ...s/deployment-tools/kubernetes-operator.md
diff --git a/.../kubernetes/deployment-tools/kustomize.md → .../kubernetes/deployment-tools/kustomize.md b/.../kubernetes/deployment-tools/kustomize.md → .../kubernetes/deployment-tools/kustomize.md
diff --git a/docs/cloud-native/devops/kubernetes/index.md → docs/devops/kubernetes/index.md b/docs/cloud-native/devops/kubernetes/index.md → docs/devops/kubernetes/index.md
diff --git a/.../ingress-controller/ingress-controller.md → .../ingress-controller/ingress-controller.md b/.../ingress-controller/ingress-controller.md → .../ingress-controller/ingress-controller.md
diff --git a/...netes/ingress-controller/nginx-ingress.md → ...netes/ingress-controller/nginx-ingress.md b/...netes/ingress-controller/nginx-ingress.md → ...netes/ingress-controller/nginx-ingress.md
diff --git a/...tes/ingress-controller/traefik-ingress.md → ...tes/ingress-controller/traefik-ingress.md b/...tes/ingress-controller/traefik-ingress.md → ...tes/ingress-controller/traefik-ingress.md
diff --git a/...ud-native/devops/kubernetes/kubernetes.md → docs/devops/kubernetes/kubernetes.md b/...ud-native/devops/kubernetes/kubernetes.md → docs/devops/kubernetes/kubernetes.md
diff --git a/...tive/devops/kubernetes/other-tools/k3s.md → docs/devops/kubernetes/other-tools/k3s.md b/...tive/devops/kubernetes/other-tools/k3s.md → docs/devops/kubernetes/other-tools/k3s.md
diff --git a/...ive/devops/kubernetes/other-tools/kind.md → docs/devops/kubernetes/other-tools/kind.md b/...ive/devops/kubernetes/other-tools/kind.md → docs/devops/kubernetes/other-tools/kind.md
diff --git a/...ive/devops/kubernetes/other-tools/tilt.md → docs/devops/kubernetes/other-tools/tilt.md b/...ive/devops/kubernetes/other-tools/tilt.md → docs/devops/kubernetes/other-tools/tilt.md
diff --git a/...loud-native/devops/kubernetes/services.md → docs/devops/kubernetes/services.md b/...loud-native/devops/kubernetes/services.md → docs/devops/kubernetes/services.md
diff --git a/docs/domain-driven-design/domain.md b/docs/domain-driven-design/domain.md
@@ -1,4 +1,4 @@
-# Domain
+# Domain Model
 
 ## 📕 Articles
 

diff --git a/docs/domain-driven-design/index.md b/docs/domain-driven-design/index.md
diff --git a/docs/cloud-native/iaas/iaas.md → docs/iaas/iaas.md b/docs/cloud-native/iaas/iaas.md → docs/iaas/iaas.md
diff --git a/docs/cloud-native/iaas/nomad.md → docs/iaas/nomad.md b/docs/cloud-native/iaas/nomad.md → docs/iaas/nomad.md
diff --git a/docs/cloud-native/iaas/pulumi.md → docs/iaas/pulumi.md b/docs/cloud-native/iaas/pulumi.md → docs/iaas/pulumi.md
diff --git a/docs/cloud-native/iaas/terraform.md → docs/iaas/terraform.md b/docs/cloud-native/iaas/terraform.md → docs/iaas/terraform.md
diff --git a/docs/messaging/index.md b/docs/messaging/index.md
diff --git a/docs/cloud-native/api-gateway/ambassador.md → docs/microservices/api-gateway/ambassador.md b/docs/cloud-native/api-gateway/ambassador.md → docs/microservices/api-gateway/ambassador.md
diff --git a/docs/microservices/security/index.md b/docs/microservices/security/index.md
diff --git a/docs/microservices/services-boundries.md b/docs/microservices/services-boundries.md
@@ -1,4 +1,4 @@
-# Services Boundries
+# Services Boundaries
 
 ## 📘 Resources
 - [ddd-crew/ddd-starter-modelling-process](https://github.com/ddd-crew/ddd-starter-modelling-process) 

diff --git a/docs/modeling/index.md b/docs/modeling/index.md
@@ -1,4 +1,4 @@
-- [Modeling](modeling.md)
+ [Modeling](modeling.md)
   - [Architecture Diagram](architecture-diagram.md)
   - [Class Diagram](class-diagram.md)
   - [Component Diagram](component-diagram.md)

diff --git a/docs/nosql/postgresql.md b/docs/nosql/postgresql.md
diff --git a/docs/cloud-native/paas/heroku.md → docs/paas/heroku.md b/docs/cloud-native/paas/heroku.md → docs/paas/heroku.md
diff --git a/docs/cloud-native/paas/netlify.md → docs/paas/netlify.md b/docs/cloud-native/paas/netlify.md → docs/paas/netlify.md
diff --git a/docs/cloud-native/paas/openshift.md → docs/paas/openshift.md b/docs/cloud-native/paas/openshift.md → docs/paas/openshift.md
diff --git a/docs/cloud-native/paas/rancher.md → docs/paas/rancher.md b/docs/cloud-native/paas/rancher.md → docs/paas/rancher.md
diff --git a/docs/cloud-native/reverse-proxy-lb/envoy.md → docs/reverse-proxy-lb/envoy.md b/docs/cloud-native/reverse-proxy-lb/envoy.md → docs/reverse-proxy-lb/envoy.md
diff --git a/docs/cloud-native/reverse-proxy-lb/fabio.md → docs/reverse-proxy-lb/fabio.md b/docs/cloud-native/reverse-proxy-lb/fabio.md → docs/reverse-proxy-lb/fabio.md
diff --git a/.../cloud-native/reverse-proxy-lb/haproxy.md → docs/reverse-proxy-lb/haproxy.md b/.../cloud-native/reverse-proxy-lb/haproxy.md → docs/reverse-proxy-lb/haproxy.md
diff --git a/...native/reverse-proxy-lb/load-balancing.md → docs/reverse-proxy-lb/load-balancing.md b/...native/reverse-proxy-lb/load-balancing.md → docs/reverse-proxy-lb/load-balancing.md
diff --git a/.../cloud-native/reverse-proxy-lb/metallb.md → docs/reverse-proxy-lb/metallb.md b/.../cloud-native/reverse-proxy-lb/metallb.md → docs/reverse-proxy-lb/metallb.md
diff --git a/docs/cloud-native/reverse-proxy-lb/nginx.md → docs/reverse-proxy-lb/nginx.md b/docs/cloud-native/reverse-proxy-lb/nginx.md → docs/reverse-proxy-lb/nginx.md
diff --git a/...-native/reverse-proxy-lb/reverse-proxy.md → docs/reverse-proxy-lb/reverse-proxy.md b/...-native/reverse-proxy-lb/reverse-proxy.md → docs/reverse-proxy-lb/reverse-proxy.md
diff --git a/.../cloud-native/reverse-proxy-lb/traefik.md → docs/reverse-proxy-lb/traefik.md b/.../cloud-native/reverse-proxy-lb/traefik.md → docs/reverse-proxy-lb/traefik.md
diff --git a/docs/cloud-native/reverse-proxy-lb/yarp.md → docs/reverse-proxy-lb/yarp.md b/docs/cloud-native/reverse-proxy-lb/yarp.md → docs/reverse-proxy-lb/yarp.md
diff --git a/.../cloud-native/service-discovery/consul.md → docs/service-discovery/consul.md b/.../cloud-native/service-discovery/consul.md → docs/service-discovery/consul.md
diff --git a/.../cloud-native/service-discovery/eureka.md → docs/service-discovery/eureka.md b/.../cloud-native/service-discovery/eureka.md → docs/service-discovery/eureka.md
diff --git a/...ve/service-discovery/service-discovery.md → docs/service-discovery/service-discovery.md b/...ve/service-discovery/service-discovery.md → docs/service-discovery/service-discovery.md
@@ -1,4 +1,4 @@
-# Service Disvocery
+# Service Discovery
 
 ## 📕 Articles
 

diff --git a/docs/cloud-native/service-mesh/istio.md → docs/service-mesh/istio.md b/docs/cloud-native/service-mesh/istio.md → docs/service-mesh/istio.md
diff --git a/docs/cloud-native/service-mesh/linkerd.md → docs/service-mesh/linkerd.md b/docs/cloud-native/service-mesh/linkerd.md → docs/service-mesh/linkerd.md
diff --git a/docs/cloud-native/service-mesh/maesh.md → docs/service-mesh/maesh.md b/docs/cloud-native/service-mesh/maesh.md → docs/service-mesh/maesh.md
diff --git a/...cloud-native/service-mesh/service-mesh.md → docs/service-mesh/service-mesh.md b/...cloud-native/service-mesh/service-mesh.md → docs/service-mesh/service-mesh.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -109,7 +109,12 @@ nav:
   - Resiliency:
     - Resiliency: microservices/resiliency/resiliency.md        
     - High Availibility: microservices/resiliency/high-availibility.md   
-    - Idempotency: microservices/resiliency/idempotency.md      
+    - Idempotency: microservices/resiliency/idempotency.md    
+  - API Gateway: 
+    - API Gateway: microservices/api-gateway/api-gateway.md
+    - Ambassador: microservices/api-gateway/ambassador.md
+    - Kong: microservices/api-gateway/kong.md
+    - Ocelot: microservices/api-gateway/ocelot.md  
   - Scaling: microservices/scaling.md
   - Testing: microservices/testing.md
   - Tools: 
@@ -178,67 +183,62 @@ nav:
   - Backends for Frontends: cloud-design-patterns/bff.md
 - Cloud Best Practices: cloud-best-practices.md
 - Cloud Native:
-  - API Gateway: 
-    - API Gateway: cloud-native/api-gateway/api-gateway.md
-    - Ambassador: cloud-native/api-gateway/ambassador.md
-    - Kong: cloud-native/api-gateway/kong.md
-    - Ocelot: cloud-native/api-gateway/ocelot.md
-  - Platform as a Service:
-    - Rancher: cloud-native/paas/rancher.md
-    - OpenShift: cloud-native/paas/openshift.md
-    - Heroku: cloud-native/paas/heroku.md
-    - Netlify: cloud-native/paas/netlify.md
-  - Infrastructure as a Service:
-    - Infrastructure as a Service: cloud-native/iaas/iaas.md
-    - Terraform: cloud-native/iaas/terraform.md
-    - Pulumi: cloud-native/iaas/pulumi.md
-    - Nomad: cloud-native/iaas/nomad.md
-  - DevOps:
-    - Docker: 
-      - Docker: cloud-native/devops/docker/docker.md
-      - Docker Compose: cloud-native/devops/docker/docker-compose.md
-    - Containerd: cloud-native/devops/containerd.md
-    - Kubernetes: 
-      - Kubernetes: cloud-native/devops/kubernetes/kubernetes.md
-      - Deployment Strategies: cloud-native/devops/kubernetes/deployment-strategies.md
-      - Deployment Tools: 
-          - Argo-CD: cloud-native/devops/kubernetes/deployment-tools/argo-cd.md
-          - Helm: cloud-native/devops/kubernetes/deployment-tools/helm.md
-          - Kustomize: cloud-native/devops/kubernetes/deployment-tools/kustomize.md
-          - Kubernetes Operator: cloud-native/devops/kubernetes/deployment-tools/kubernetes-operator.md
-          - Jenkins: cloud-native/devops/kubernetes/deployment-tools/jenkins.md
-      - Ingress Controller: 
-          - Ingress Controller: cloud-native/devops/kubernetes/ingress-controller.md
-          - Nginx Ingress: cloud-native/devops/kubernetes/nginx-ingress.md
-          - Traefik Ingress: cloud-native/devops/kubernetes/traefik-ingress.md
-      - Other Tools: 
-          - k3s: cloud-native/devops/kubernetes/other-tools/k3s.md
-          - kind: cloud-native/devops/kubernetes/other-tools/kind.md
-          - tilt: cloud-native/devops/kubernetes/other-tools/tilt.md
-    - CI/CD:
-      - Azure DevOps: cloud-native/devops/ci-cd/azure-devops.md
-      - Github Actions: cloud-native/devops/ci-cd/github-actions.md
-      - Jenkins: cloud-native/devops/ci-cd/jenkins.md
-  - Reverse Proxy & Load Balancing:
-    - Reverse Proxy: cloud-native/reverse-proxy-lb/reverse-proxy.md
-    - Load Balancing: cloud-native/reverse-proxy-lb/load-balancing.md
-    - Envoy: cloud-native/reverse-proxy-lb/envoy.md
-    - YARP: cloud-native/reverse-proxy-lb/yarp.md
-    - HAProxy: cloud-native/reverse-proxy-lb/haproxy.md
-    - Fabio: cloud-native/reverse-proxy-lb/fabio.md
-    - MetalLB: cloud-native/reverse-proxy-lb/metallb.md
-    - Nginx: cloud-native/reverse-proxy-lb/nginx.md
-    - Traefik: cloud-native/reverse-proxy-lb/traefik.md
-  - Service Discovery & Registry: 
-    - Service Discovery & Registry: cloud-native/service-discovery/service-discovery.md
-    - Consul: cloud-native/service-discovery/consul.md
-    - Eureka: cloud-native/service-discovery/eureka.md
-  - Service Mesh: 
-    - Service Mesh: cloud-native/service-mesh/service-mesh.md
-    - Istio: cloud-native/service-mesh/istio.md
-    - Consul & Consul Connect: cloud-native/service-discovery/consul.md
-    - Maesh: cloud-native/service-mesh/maesh.md
-    - Linkerd: cloud-native/service-mesh/linkerd.md
+- Platform as a Service:
+  - Rancher: paas/rancher.md
+  - OpenShift: paas/openshift.md
+  - Heroku: paas/heroku.md
+  - Netlify: paas/netlify.md
+- Infrastructure as a Service:
+  - Infrastructure as a Service: iaas/iaas.md
+  - Terraform: iaas/terraform.md
+  - Pulumi: iaas/pulumi.md
+  - Nomad: iaas/nomad.md
+- DevOps:
+  - Docker: 
+    - Docker: devops/docker/docker.md
+    - Docker Compose: devops/docker/docker-compose.md
+  - Containerd: devops/containerd.md
+  - Kubernetes: 
+    - Kubernetes: devops/kubernetes/kubernetes.md
+    - Deployment Strategies: devops/kubernetes/deployment-strategies.md
+    - Deployment Tools: 
+        - Argo-CD: devops/kubernetes/deployment-tools/argo-cd.md
+        - Helm: devops/kubernetes/deployment-tools/helm.md
+        - Kustomize: devops/kubernetes/deployment-tools/kustomize.md
+        - Kubernetes Operator: devops/kubernetes/deployment-tools/kubernetes-operator.md
+        - Jenkins: devops/kubernetes/deployment-tools/jenkins.md
+    - Ingress Controller: 
+        - Ingress Controller: devops/kubernetes/ingress-controller.md
+        - Nginx Ingress: devops/kubernetes/nginx-ingress.md
+        - Traefik Ingress: devops/kubernetes/traefik-ingress.md
+    - Other Tools: 
+        - k3s: devops/kubernetes/other-tools/k3s.md
+        - kind: devops/kubernetes/other-tools/kind.md
+        - tilt: devops/kubernetes/other-tools/tilt.md
+  - CI/CD:
+    - Azure DevOps: devops/ci-cd/azure-devops.md
+    - Github Actions: devops/ci-cd/github-actions.md
+    - Jenkins: devops/ci-cd/jenkins.md
+- Reverse Proxy & Load Balancing:
+    - Reverse Proxy: reverse-proxy-lb/reverse-proxy.md
+    - Load Balancing: reverse-proxy-lb/load-balancing.md
+    - Envoy: reverse-proxy-lb/envoy.md
+    - YARP: reverse-proxy-lb/yarp.md
+    - HAProxy: reverse-proxy-lb/haproxy.md
+    - Fabio: reverse-proxy-lb/fabio.md
+    - MetalLB: reverse-proxy-lb/metallb.md
+    - Nginx: reverse-proxy-lb/nginx.md
+    - Traefik: reverse-proxy-lb/traefik.md
+- Service Discovery & Registry: 
+    - Service Discovery & Registry: service-discovery/service-discovery.md
+    - Consul: service-discovery/consul.md
+    - Eureka: service-discovery/eureka.md
+- Service Mesh: 
+  - Service Mesh: service-mesh/service-mesh.md
+  - Istio: service-mesh/istio.md
+  - Consul & Consul Connect: service-discovery/consul.md
+  - Maesh: service-mesh/maesh.md
+  - Linkerd: service-mesh/linkerd.md
 - Object Oriented Design: object-oriented-design.md
 - Systems Design: 
   - Systems Design: systems-design/systems-design.md
@@ -308,7 +308,6 @@ nav:
     - Azure Web Pub/Sub: azure/messaging/azure-web-pub-sub.md
   - Azure Resource Manager (ARM): azure/azure-resource-manager.md
   - Azure Sequrity: 
-    - Azure Sequrity: azure/azure-security/azure-security.md
     - Azure Active Directory (Azure AD): azure/azure-active-directory.md
     - Azure Key Vault: azure/azure-key-vault.md
   - Azure SQL: azure/azure-sql.md