From 9cfbacf951a021c3274bc00cfcb8acc3acc47c6c Mon Sep 17 00:00:00 2001 From: thredreams <44553414+thredreams@users.noreply.github.com> Date: Fri, 16 Dec 2022 07:09:31 +0800 Subject: [PATCH] fix:solve the warnings in 'make doc' (#806) * fix:solve the warnings in 'make doc' Signed-off-by: thredreams <1220474743@qq.com> * Unified Code Block Language Signed-off-by: thredreams <1220474743@qq.com> --- docs/latest/design/gatewayapi-translator.md | 4 ++-- docs/latest/dev/CODE_OF_CONDUCT.md | 2 +- docs/latest/index.rst | 2 +- docs/latest/user/tls-passthrough.md | 4 ++-- docs/v0.2.0/design/gatewayapi-translator.md | 4 ++-- docs/v0.2.0/dev/CODE_OF_CONDUCT.md | 2 +- docs/v0.2.0/index.rst | 2 +- docs/v0.2.0/user/tls-passthrough.md | 4 ++-- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/latest/design/gatewayapi-translator.md b/docs/latest/design/gatewayapi-translator.md index 1480c5f4257..3cf0da94f5a 100644 --- a/docs/latest/design/gatewayapi-translator.md +++ b/docs/latest/design/gatewayapi-translator.md @@ -48,7 +48,7 @@ spec: allowedRoutes: namespaces: from: All - hostname: *.envoygateway.io + hostname: "*.envoygateway.io" - name: http protocol: HTTP port: 80 @@ -75,7 +75,7 @@ spec: allowedRoutes: namespaces: from: All - hostname: *.envoygateway.io + hostname: "*.envoygateway.io" - name: http protocol: HTTP port: 80 diff --git a/docs/latest/dev/CODE_OF_CONDUCT.md b/docs/latest/dev/CODE_OF_CONDUCT.md index 5071043e94a..a0a295770f3 100644 --- a/docs/latest/dev/CODE_OF_CONDUCT.md +++ b/docs/latest/dev/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ -## Community Code of Conduct +# Community Code of Conduct Gateway follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). diff --git a/docs/latest/index.rst b/docs/latest/index.rst index 39f345fa125..7da20035f47 100644 --- a/docs/latest/index.rst +++ b/docs/latest/index.rst @@ -1,5 +1,5 @@ `Envoy Gateway `_ -============= +==================== Release: |version| diff --git a/docs/latest/user/tls-passthrough.md b/docs/latest/user/tls-passthrough.md index eb830e64dd6..500a38398d9 100644 --- a/docs/latest/user/tls-passthrough.md +++ b/docs/latest/user/tls-passthrough.md @@ -50,8 +50,8 @@ kubectl apply -f https://raw.githubusercontent.com/envoyproxy/gateway/latest/exa Patch the Gateway from the Quickstart guide to include a TLS listener that listens on port `6443` and is configured for TLS mode Passthrough: -```console -$ kubectl patch gateway eg --type=json --patch '[{ +```shell +kubectl patch gateway eg --type=json --patch '[{ "op": "add", "path": "/spec/listeners/-", "value": { diff --git a/docs/v0.2.0/design/gatewayapi-translator.md b/docs/v0.2.0/design/gatewayapi-translator.md index 1480c5f4257..3cf0da94f5a 100644 --- a/docs/v0.2.0/design/gatewayapi-translator.md +++ b/docs/v0.2.0/design/gatewayapi-translator.md @@ -48,7 +48,7 @@ spec: allowedRoutes: namespaces: from: All - hostname: *.envoygateway.io + hostname: "*.envoygateway.io" - name: http protocol: HTTP port: 80 @@ -75,7 +75,7 @@ spec: allowedRoutes: namespaces: from: All - hostname: *.envoygateway.io + hostname: "*.envoygateway.io" - name: http protocol: HTTP port: 80 diff --git a/docs/v0.2.0/dev/CODE_OF_CONDUCT.md b/docs/v0.2.0/dev/CODE_OF_CONDUCT.md index 5071043e94a..a0a295770f3 100644 --- a/docs/v0.2.0/dev/CODE_OF_CONDUCT.md +++ b/docs/v0.2.0/dev/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ -## Community Code of Conduct +# Community Code of Conduct Gateway follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). diff --git a/docs/v0.2.0/index.rst b/docs/v0.2.0/index.rst index 39f345fa125..7da20035f47 100644 --- a/docs/v0.2.0/index.rst +++ b/docs/v0.2.0/index.rst @@ -1,5 +1,5 @@ `Envoy Gateway `_ -============= +==================== Release: |version| diff --git a/docs/v0.2.0/user/tls-passthrough.md b/docs/v0.2.0/user/tls-passthrough.md index 80968169e13..444c43e77dd 100644 --- a/docs/v0.2.0/user/tls-passthrough.md +++ b/docs/v0.2.0/user/tls-passthrough.md @@ -50,8 +50,8 @@ kubectl apply -f https://raw.githubusercontent.com/envoyproxy/gateway/v0.2.0/exa Patch the Gateway from the Quickstart guide to include a TLS listener that listens on port `6443` and is configured for TLS mode Passthrough: -```console -$ kubectl patch gateway eg --type=json --patch '[{ +```shell +kubectl patch gateway eg --type=json --patch '[{ "op": "add", "path": "/spec/listeners/-", "value": {