docs: update configuration kick in tips (#4479)

* docs: update configuration kick in tips Signed-off-by: zirain <[email protected]> * lint Signed-off-by: zirain <[email protected]> * update Signed-off-by: zirain <[email protected]> --------- Signed-off-by: zirain <[email protected]>
envoyproxy · Oct 21, 2024 · 26ec49a · 26ec49a
1 parent 70c568b
commit 26ec49a
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 41 deletions.
diff --git a/site/content/en/latest/boilerplates/rollout-envoy-gateway.md b/site/content/en/latest/boilerplates/rollout-envoy-gateway.md
@@ -0,0 +1,10 @@
+---
+---
+
+> After updating the `ConfigMap`, you will need to wait the configuration kicks in. <br/>
+> You can **force** the configuration to be reloaded by restarting the `envoy-gateway` deployment.
+>
+> ```shell
+> kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
+> ```
+>
diff --git a/site/content/en/latest/tasks/extensibility/envoy-patch-policy.md b/site/content/en/latest/tasks/extensibility/envoy-patch-policy.md
@@ -80,11 +80,7 @@ data:
 {{% /tab %}}
 {{< /tabpane >}}
 
-* After updating the `ConfigMap`, you will need to restart the `envoy-gateway` deployment so the configuration kicks in
-
-```shell
-kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
-```
+{{< boilerplate rollout-envoy-gateway >}}
 
 ## Testing
 

diff --git a/site/content/en/latest/tasks/observability/gateway-observability.md b/site/content/en/latest/tasks/observability/gateway-observability.md
@@ -86,11 +86,7 @@ data:
 {{% /tab %}}
 {{< /tabpane >}}
 
-After updating the `ConfigMap`, you will need to restart the `envoy-gateway` deployment so the configuration kicks in:
-
-```shell
-kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
-```
+{{< boilerplate rollout-envoy-gateway >}}
 
 ### Enable Open Telemetry sink in Envoy Gateway
 
@@ -157,11 +153,7 @@ data:
 {{% /tab %}}
 {{< /tabpane >}}
 
-After updating the `ConfigMap`, you will need to restart the `envoy-gateway` deployment so the configuration kicks in:
-
-```shell
-kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
-```
+{{< boilerplate rollout-envoy-gateway >}}
 
 Verify OTel-Collector metrics:
 

diff --git a/site/content/en/latest/tasks/observability/rate-limit-observability.md b/site/content/en/latest/tasks/observability/rate-limit-observability.md
@@ -91,8 +91,4 @@ data:
 {{% /tab %}}
 {{< /tabpane >}}
 
-After updating the ConfigMap, you will need to restart the envoy-gateway deployment so the configuration kicks in:
-
-```shell
-kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
-```
+{{< boilerplate rollout-envoy-gateway >}}
diff --git a/site/content/en/latest/tasks/security/private-key-provider.md b/site/content/en/latest/tasks/security/private-key-provider.md
@@ -169,11 +169,7 @@ data:
 {{% /tab %}}
 {{< /tabpane >}}
 
-* After updating the `ConfigMap`, you will need to restart the `envoy-gateway` deployment so the configuration kicks in
-
-  ```shell
-  kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
-  ```
+{{< boilerplate rollout-envoy-gateway >}}
 
 ## Create gateway for TLS termination
 

diff --git a/site/content/en/latest/tasks/traffic/backend.md b/site/content/en/latest/tasks/traffic/backend.md
@@ -94,11 +94,7 @@ data:
 {{% /tab %}}
 {{< /tabpane >}}
 
-* After updating the `ConfigMap`, you will need to restart the `envoy-gateway` deployment so the configuration kicks in
-
-```shell
-kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
-```
+{{< boilerplate rollout-envoy-gateway >}}
 
 ## Testing
 

diff --git a/site/content/en/latest/tasks/traffic/global-rate-limit.md b/site/content/en/latest/tasks/traffic/global-rate-limit.md
@@ -214,11 +214,7 @@ data:
 {{% /tab %}}
 {{< /tabpane >}}
 
-* After updating the `ConfigMap`, you will need to restart the `envoy-gateway` deployment so the configuration kicks in
-
-```shell
-kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
-```
+{{< boilerplate rollout-envoy-gateway >}}
 
 ## Rate Limit Specific User 
 
@@ -1287,11 +1283,7 @@ data:
 {{% /tab %}}
 {{< /tabpane >}}
 
-* After updating the `ConfigMap`, you will need to restart the `envoy-gateway` deployment so the configuration kicks in
-
-```shell
-kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system
-```
+{{< boilerplate rollout-envoy-gateway >}}
 
 [Global Rate Limiting]: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/other_features/global_rate_limiting
 [Local rate limiting]: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/other_features/local_rate_limiting

diff --git a/site/layouts/shortcodes/boilerplate.html b/site/layouts/shortcodes/boilerplate.html
@@ -15,7 +15,7 @@
         {{- $pattern := printf "%s*" $name -}}
         {{- $resource := $bundle.Resources.GetMatch $pattern -}}
         {{- with $resource -}}
-            {{- .Content | markdownify -}}
+            {{- .Content -}}
         {{- else -}}
             {{- errorf "Could not find boilerplate '%s' (%s)" $name $position -}}
         {{- end -}}

diff --git a/tools/make/docs.mk b/tools/make/docs.mk
@@ -118,6 +118,9 @@ docs-check-links: # Check for broken links in the docs
 	@$(LOG_TARGET)
 	linkinator site/public/ -r --concurrency 25 --skip $(LINKINATOR_IGNORE)
 
+docs-markdown-lint:
+	markdownlint -c .github/markdown_lint_config.json site/content/*
+
 release-notes-docs: $(tools/release-notes-docs)
 	@$(LOG_TARGET)
 	@for file in $(wildcard release-notes/*.yaml); do \