Merge pull request #3047 from yurake/2804-update-docs

2804 update docs

.codeclimate.yml

@@ -2,9 +2,13 @@ engines:
   markdownlint:
     enabled: true
     checks:
+      MD002:
+        enabled: false
       MD007:
         enabled: false
       MD009:
         enabled: false
       MD013:
         enabled: false
+      MD030:
+        enabled: false

README.md

@@ -128,18 +128,22 @@ minikube docker-env --shell powershell | Invoke-Expression
 
 `apply.sh` supports `kubectl apply` to k8s clusters.
 
-    ./kubernetes/bin/apply.sh
+```bash
+./kubernetes/bin/apply.sh
+```
 
 ## Web Console Access
 
 ### Add hosts
 
 Add IP, domain in /etc/hosts
 
-    echo `minikube ip` k8s.3tier.webapp api.server.minikube \
-    rabbitmq.management.minikube jenkins.minikube alertmanager.minikube prometheus.minikube \
-    grafana.minikube jupyter.minikube hazelcast.manager.minikube activemq.management.minikube \
-    jaeger.minikube argo.minikube >> /etc/hosts
+```bash
+echo `minikube ip` k8s.3tier.webapp api.server.minikube \
+rabbitmq.management.minikube jenkins.minikube alertmanager.minikube prometheus.minikube \
+grafana.minikube jupyter.minikube hazelcast.manager.minikube activemq.management.minikube \
+jaeger.minikube argo.minikube >> /etc/hosts
+```
 
 ### Web Console list
 
@@ -173,11 +177,11 @@ k8s-3tier-webapp is licensed under the MIT License. See [LICENSE](LICENSE/) for
 
 ## Contribution
 
-1.  [Fork](https://github.com/yurake/k8s-3tier-webapp/fork) this repo
-2.  Create a feature branch named like feature/enhancement from [master](https://github.com/yurake/k8s-3tier-webapp/tree/master) branch
-3.  Commit your changes
-4.  Rebase your local changes against the [master](https://github.com/yurake/k8s-3tier-webapp/tree/master) branch
-5.  Create new Pull Request
+1.  [Fork](https://github.com/yurake/k8s-3tier-webapp/fork) this repo  
+2.  Create a feature branch named like feature/enhancement from [master](https://github.com/yurake/k8s-3tier-webapp/tree/master) branch  
+3.  Commit your changes  
+4.  Rebase your local changes against the [master](https://github.com/yurake/k8s-3tier-webapp/tree/master) branch  
+5.  Create new Pull Request  
 
 ## Security
 

kubernetes/monitoring/README.md

@@ -1,25 +1,29 @@
-## About
+# About
+
 Sample monitoring application based on k8s.
 
 ## Build & Apply
+
 No need to do.
 
 ## Web Console
-* prometheus  
-http://prometheus.minikube/
-* grafana  
-http://grafana.minikube/
-* jenkins  
-http://jenkins.minikube  
-* jaeger  
-http://jaeger.minikube  
-* jupyter notebook  
-http://jupyter.minikube
+
+-   prometheus  
+    <http://prometheus.minikube/>
+-   grafana  
+    <http://grafana.minikube/>
+-   jenkins  
+    <http://jenkins.minikube>  
+-   jaeger  
+    <http://jaeger.minikube>  
+-   jupyter notebook  
+    <http://jupyter.minikube>
 
 ## Optional
 
-### Set up [argo](optional/argo/README.md)  
-* argo dashboard  
-http://argo.minikube
+### Set up [argo](optional/argo/README.md)
+
+-   argo dashboard  
+    <http://argo.minikube>
 
-### Set up [tekton](optional/tekton/README.md)  
+### Set up [tekton](optional/tekton/README.md)

kubernetes/monitoring/grafana/README.md

@@ -1,4 +1,5 @@
-## Grafana dashboard settings
+# Grafana dashboard settings
+
 Choose data source type > Prometheus  
 [HTTP] > [URL] > `http://prometheus:9090`  
 [HTTP] > [Access] > `Server(default)`  
@@ -7,31 +8,34 @@ Choose data source type > Jaeger
 [HTTP] > [URL] > `http://jaeger-query-monitoring`  
 
 ## Recommended grafana dashboards
-https://grafana.com/grafana/dashboards
-* 455  
-Postgres Overview
-* 763  
-Redis Dashboard for Prometheus Redis Exporter 1.x
-* 2583
-MongoDB
-* 3066  
-JVM overview
-* 6239  
-Mysql
-* 8588  
-Kubernetes Deployment Statefulset Daemonset metrics
-* 8685  
-K8s Cluster Summary
-* 9789  
-NGINX Ingress controller
-* 10000  
-Cluster Monitoring for Kubernetes
-* 10001  
-Jaeger
-* 10465  
-ZooKeeper
-* 10991  
-RabbitMQ
+
+<https://grafana.com/grafana/dashboards>
+
+-   455  
+    Postgres Overview
+-   763  
+    Redis Dashboard for Prometheus Redis Exporter 1.x
+-   2583
+    MongoDB
+-   3066  
+    JVM overview
+-   6239  
+    Mysql
+-   8588  
+    Kubernetes Deployment Statefulset Daemonset metrics
+-   8685  
+    K8s Cluster Summary
+-   9789  
+    NGINX Ingress controller
+-   10000  
+    Cluster Monitoring for Kubernetes
+-   10001  
+    Jaeger
+-   10465  
+    ZooKeeper
+-   10991  
+    RabbitMQ
 
 ## Custom dashboards
+
 [dashboards](./dashboard)