From 9ba30479570ca50773bc1c7afa94aaae5b447af6 Mon Sep 17 00:00:00 2001 From: Arko Dasgupta Date: Sat, 9 Mar 2024 17:23:05 -0800 Subject: [PATCH 1/2] docs: move Design docs under "Get Involved" * design docs are more relevant to internal contributors than external users Signed-off-by: Arko Dasgupta --- site/content/en/latest/{ => contributions}/design/_index.md | 0 site/content/en/latest/{ => contributions}/design/accesslog.md | 0 .../latest/{ => contributions}/design/backend-traffic-policy.md | 0 site/content/en/latest/{ => contributions}/design/bootstrap.md | 0 .../en/latest/{ => contributions}/design/client-traffic-policy.md | 0 site/content/en/latest/{ => contributions}/design/config-api.md | 0 site/content/en/latest/{ => contributions}/design/eg-metrics.md | 0 site/content/en/latest/{ => contributions}/design/egctl.md | 0 .../en/latest/{ => contributions}/design/envoy-patch-policy.md | 0 .../latest/{ => contributions}/design/extending-envoy-gateway.md | 0 .../en/latest/{ => contributions}/design/gatewayapi-translator.md | 0 site/content/en/latest/{ => contributions}/design/goals.md | 0 .../en/latest/{ => contributions}/design/local-envoy-gateway.md | 0 site/content/en/latest/{ => contributions}/design/metrics.md | 0 site/content/en/latest/{ => contributions}/design/pprof.md | 0 site/content/en/latest/{ => contributions}/design/rate-limit.md | 0 .../en/latest/{ => contributions}/design/security-policy.md | 0 .../content/en/latest/{ => contributions}/design/system-design.md | 0 .../en/latest/{ => contributions}/design/tcp-udp-design.md | 0 site/content/en/latest/{ => contributions}/design/tracing.md | 0 site/content/en/latest/{ => contributions}/design/watching.md | 0 21 files changed, 0 insertions(+), 0 deletions(-) rename site/content/en/latest/{ => contributions}/design/_index.md (100%) rename site/content/en/latest/{ => contributions}/design/accesslog.md (100%) rename site/content/en/latest/{ => contributions}/design/backend-traffic-policy.md (100%) rename site/content/en/latest/{ => contributions}/design/bootstrap.md (100%) rename site/content/en/latest/{ => contributions}/design/client-traffic-policy.md (100%) rename site/content/en/latest/{ => contributions}/design/config-api.md (100%) rename site/content/en/latest/{ => contributions}/design/eg-metrics.md (100%) rename site/content/en/latest/{ => contributions}/design/egctl.md (100%) rename site/content/en/latest/{ => contributions}/design/envoy-patch-policy.md (100%) rename site/content/en/latest/{ => contributions}/design/extending-envoy-gateway.md (100%) rename site/content/en/latest/{ => contributions}/design/gatewayapi-translator.md (100%) rename site/content/en/latest/{ => contributions}/design/goals.md (100%) rename site/content/en/latest/{ => contributions}/design/local-envoy-gateway.md (100%) rename site/content/en/latest/{ => contributions}/design/metrics.md (100%) rename site/content/en/latest/{ => contributions}/design/pprof.md (100%) rename site/content/en/latest/{ => contributions}/design/rate-limit.md (100%) rename site/content/en/latest/{ => contributions}/design/security-policy.md (100%) rename site/content/en/latest/{ => contributions}/design/system-design.md (100%) rename site/content/en/latest/{ => contributions}/design/tcp-udp-design.md (100%) rename site/content/en/latest/{ => contributions}/design/tracing.md (100%) rename site/content/en/latest/{ => contributions}/design/watching.md (100%) diff --git a/site/content/en/latest/design/_index.md b/site/content/en/latest/contributions/design/_index.md similarity index 100% rename from site/content/en/latest/design/_index.md rename to site/content/en/latest/contributions/design/_index.md diff --git a/site/content/en/latest/design/accesslog.md b/site/content/en/latest/contributions/design/accesslog.md similarity index 100% rename from site/content/en/latest/design/accesslog.md rename to site/content/en/latest/contributions/design/accesslog.md diff --git a/site/content/en/latest/design/backend-traffic-policy.md b/site/content/en/latest/contributions/design/backend-traffic-policy.md similarity index 100% rename from site/content/en/latest/design/backend-traffic-policy.md rename to site/content/en/latest/contributions/design/backend-traffic-policy.md diff --git a/site/content/en/latest/design/bootstrap.md b/site/content/en/latest/contributions/design/bootstrap.md similarity index 100% rename from site/content/en/latest/design/bootstrap.md rename to site/content/en/latest/contributions/design/bootstrap.md diff --git a/site/content/en/latest/design/client-traffic-policy.md b/site/content/en/latest/contributions/design/client-traffic-policy.md similarity index 100% rename from site/content/en/latest/design/client-traffic-policy.md rename to site/content/en/latest/contributions/design/client-traffic-policy.md diff --git a/site/content/en/latest/design/config-api.md b/site/content/en/latest/contributions/design/config-api.md similarity index 100% rename from site/content/en/latest/design/config-api.md rename to site/content/en/latest/contributions/design/config-api.md diff --git a/site/content/en/latest/design/eg-metrics.md b/site/content/en/latest/contributions/design/eg-metrics.md similarity index 100% rename from site/content/en/latest/design/eg-metrics.md rename to site/content/en/latest/contributions/design/eg-metrics.md diff --git a/site/content/en/latest/design/egctl.md b/site/content/en/latest/contributions/design/egctl.md similarity index 100% rename from site/content/en/latest/design/egctl.md rename to site/content/en/latest/contributions/design/egctl.md diff --git a/site/content/en/latest/design/envoy-patch-policy.md b/site/content/en/latest/contributions/design/envoy-patch-policy.md similarity index 100% rename from site/content/en/latest/design/envoy-patch-policy.md rename to site/content/en/latest/contributions/design/envoy-patch-policy.md diff --git a/site/content/en/latest/design/extending-envoy-gateway.md b/site/content/en/latest/contributions/design/extending-envoy-gateway.md similarity index 100% rename from site/content/en/latest/design/extending-envoy-gateway.md rename to site/content/en/latest/contributions/design/extending-envoy-gateway.md diff --git a/site/content/en/latest/design/gatewayapi-translator.md b/site/content/en/latest/contributions/design/gatewayapi-translator.md similarity index 100% rename from site/content/en/latest/design/gatewayapi-translator.md rename to site/content/en/latest/contributions/design/gatewayapi-translator.md diff --git a/site/content/en/latest/design/goals.md b/site/content/en/latest/contributions/design/goals.md similarity index 100% rename from site/content/en/latest/design/goals.md rename to site/content/en/latest/contributions/design/goals.md diff --git a/site/content/en/latest/design/local-envoy-gateway.md b/site/content/en/latest/contributions/design/local-envoy-gateway.md similarity index 100% rename from site/content/en/latest/design/local-envoy-gateway.md rename to site/content/en/latest/contributions/design/local-envoy-gateway.md diff --git a/site/content/en/latest/design/metrics.md b/site/content/en/latest/contributions/design/metrics.md similarity index 100% rename from site/content/en/latest/design/metrics.md rename to site/content/en/latest/contributions/design/metrics.md diff --git a/site/content/en/latest/design/pprof.md b/site/content/en/latest/contributions/design/pprof.md similarity index 100% rename from site/content/en/latest/design/pprof.md rename to site/content/en/latest/contributions/design/pprof.md diff --git a/site/content/en/latest/design/rate-limit.md b/site/content/en/latest/contributions/design/rate-limit.md similarity index 100% rename from site/content/en/latest/design/rate-limit.md rename to site/content/en/latest/contributions/design/rate-limit.md diff --git a/site/content/en/latest/design/security-policy.md b/site/content/en/latest/contributions/design/security-policy.md similarity index 100% rename from site/content/en/latest/design/security-policy.md rename to site/content/en/latest/contributions/design/security-policy.md diff --git a/site/content/en/latest/design/system-design.md b/site/content/en/latest/contributions/design/system-design.md similarity index 100% rename from site/content/en/latest/design/system-design.md rename to site/content/en/latest/contributions/design/system-design.md diff --git a/site/content/en/latest/design/tcp-udp-design.md b/site/content/en/latest/contributions/design/tcp-udp-design.md similarity index 100% rename from site/content/en/latest/design/tcp-udp-design.md rename to site/content/en/latest/contributions/design/tcp-udp-design.md diff --git a/site/content/en/latest/design/tracing.md b/site/content/en/latest/contributions/design/tracing.md similarity index 100% rename from site/content/en/latest/design/tracing.md rename to site/content/en/latest/contributions/design/tracing.md diff --git a/site/content/en/latest/design/watching.md b/site/content/en/latest/contributions/design/watching.md similarity index 100% rename from site/content/en/latest/design/watching.md rename to site/content/en/latest/contributions/design/watching.md From 0418f25af9b779ec322dd22a87c05d85e93586de Mon Sep 17 00:00:00 2001 From: Arko Dasgupta Date: Sun, 10 Mar 2024 15:02:32 -0700 Subject: [PATCH 2/2] fix links Signed-off-by: Arko Dasgupta --- site/content/en/latest/user/security/basic-auth.md | 2 +- site/content/en/latest/user/security/cors.md | 2 +- site/content/en/latest/user/security/jwt-authentication.md | 2 +- site/content/en/latest/user/security/oidc.md | 2 +- site/content/en/latest/user/traffic/gatewayapi-support.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/site/content/en/latest/user/security/basic-auth.md b/site/content/en/latest/user/security/basic-auth.md index be165d2e0e2..a45de6fe2c5 100644 --- a/site/content/en/latest/user/security/basic-auth.md +++ b/site/content/en/latest/user/security/basic-auth.md @@ -190,7 +190,7 @@ kubectl delete secret/example-cert Checkout the [Developer Guide](../../../contributions/develop/) to get involved in the project. -[SecurityPolicy]: ../../../design/security-policy/ +[SecurityPolicy]: ../../contributions/design/security-policy/ [http Basic authentication]: https://tools.ietf.org/html/rfc2617 [Gateway]: https://gateway-api.sigs.k8s.io/api-types/gateway [HTTPRoute]: https://gateway-api.sigs.k8s.io/api-types/httproute diff --git a/site/content/en/latest/user/security/cors.md b/site/content/en/latest/user/security/cors.md index 184b566afd1..dea4f04361d 100644 --- a/site/content/en/latest/user/security/cors.md +++ b/site/content/en/latest/user/security/cors.md @@ -134,7 +134,7 @@ kubectl delete securitypolicy/cors-example Checkout the [Developer Guide](../../../contributions/develop/) to get involved in the project. -[SecurityPolicy]: ../../../design/security-policy/ +[SecurityPolicy]: ../../contributions/design/security-policy/ [cors]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS [Gateway]: https://gateway-api.sigs.k8s.io/api-types/gateway [HTTPRoute]: https://gateway-api.sigs.k8s.io/api-types/httproute diff --git a/site/content/en/latest/user/security/jwt-authentication.md b/site/content/en/latest/user/security/jwt-authentication.md index a4897302979..ad2ef5ab092 100644 --- a/site/content/en/latest/user/security/jwt-authentication.md +++ b/site/content/en/latest/user/security/jwt-authentication.md @@ -162,7 +162,7 @@ kubectl delete securitypolicy/jwt-example Checkout the [Developer Guide](../../../contributions/develop/) to get involved in the project. -[SecurityPolicy]: ../../../design/security-policy/ +[SecurityPolicy]: ../../contributions/design/security-policy/ [jwt]: https://tools.ietf.org/html/rfc7519 [jwks]: https://tools.ietf.org/html/rfc7517 [Gateway]: https://gateway-api.sigs.k8s.io/api-types/gateway diff --git a/site/content/en/latest/user/security/oidc.md b/site/content/en/latest/user/security/oidc.md index adf85206006..a2af2583c6a 100644 --- a/site/content/en/latest/user/security/oidc.md +++ b/site/content/en/latest/user/security/oidc.md @@ -125,6 +125,6 @@ Checkout the [Developer Guide](../../../contributions/develop/) to get involved [oidc]: https://openid.net/connect/ [google-oidc]: https://developers.google.com/identity/protocols/oauth2/openid-connect -[SecurityPolicy]: ../../../design/security-policy/ +[SecurityPolicy]: ../../contributions/design/security-policy/ [Gateway]: https://gateway-api.sigs.k8s.io/api-types/gateway [HTTPRoute]: https://gateway-api.sigs.k8s.io/api-types/httproute diff --git a/site/content/en/latest/user/traffic/gatewayapi-support.md b/site/content/en/latest/user/traffic/gatewayapi-support.md index e8d34d43b17..66a32b11ea1 100644 --- a/site/content/en/latest/user/traffic/gatewayapi-support.md +++ b/site/content/en/latest/user/traffic/gatewayapi-support.md @@ -94,7 +94,7 @@ these types of cross-namespace references. Envoy Gateway supports the following namespace. - Allowing a Gateway's [SecretObjectReference][] to reference a secret in a different namespace. -[system design]: ../../../design/system-design/ +[system design]: ../../contributions/design/system-design/ [Gateway API]: https://gateway-api.sigs.k8s.io/ [GatewayClass]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass [parameters reference]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.ParametersReference