diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 159c41e5d..a5fbd37d5 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -32,6 +32,9 @@ jobs: - name: Install Structor ${{ env.STRUCTOR_VERSION }} run: curl -sSfL https://raw.githubusercontent.com/traefik/structor/master/godownloader.sh | sh -s -- -b $HOME/bin ${STRUCTOR_VERSION} + - name: Install Seo-doc + run: curl -sSfL https://raw.githubusercontent.com/traefik/seo-doc/master/godownloader.sh | sh -s -- -b "${HOME}/bin" + - name: Install Mixtus ${{ env.MIXTUS_VERSION }} run: curl -sSfL https://raw.githubusercontent.com/traefik/mixtus/master/godownloader.sh | sh -s -- -b $HOME/bin ${MIXTUS_VERSION} @@ -40,6 +43,9 @@ jobs: env: STRUCTOR_LATEST_TAG: ${{ secrets.STRUCTOR_LATEST_TAG }} + - name: Apply seo + run: $HOME/bin/seo -path=./site + - name: Publish documentation run: $HOME/bin/mixtus --dst-doc-path="./traefik" --dst-owner=traefik --dst-repo-name=doc --git-user-email="30906710+traefiker@users.noreply.github.com" --git-user-name=traefiker --src-doc-path="./site" --src-owner=containous --src-repo-name=traefik env: diff --git a/docs/content/providers/kubernetes-gateway.md b/docs/content/providers/kubernetes-gateway.md index 10e382328..761444ae3 100644 --- a/docs/content/providers/kubernetes-gateway.md +++ b/docs/content/providers/kubernetes-gateway.md @@ -6,7 +6,7 @@ The Kubernetes Gateway API, The Experimental Way. Gateway API is the evolution of Kubernetes APIs that relate to `Services`, such as `Ingress`. The Gateway API project is part of Kubernetes, working under SIG-NETWORK. -The Kubernetes Gateway provider is a Traefik implementation of the [Service APIs](https://kubernetes-sigs.github.io/service-apis/) +The Kubernetes Gateway provider is a Traefik implementation of the [Service APIs](https://kubernetes-sigs.github.io/gateway-api/) specifications from the Kubernetes Special Interest Groups (SIGs). This provider is proposed as an experimental feature and partially supports the Service APIs [v0.1.0](https://github.com/kubernetes-sigs/service-apis/releases/tag/v0.1.0) specification. @@ -71,9 +71,9 @@ This provider is proposed as an experimental feature and partially supports the --8<-- "content/reference/dynamic-configuration/kubernetes-gateway-rbac.yml" ``` -The Kubernetes Service APIs project provides several [guides](https://kubernetes-sigs.github.io/service-apis/guides/) on how to use the APIs. +The Kubernetes Service APIs project provides several [guides](https://kubernetes-sigs.github.io/gateway-api/guides/) on how to use the APIs. These guides can help you to go further than the example above. -The [getting started guide](https://kubernetes-sigs.github.io/service-apis/getting-started/) details how to install the CRDs from their repository. +The [getting started guide](https://kubernetes-sigs.github.io/gateway-api/getting-started/) details how to install the CRDs from their repository. !!! note "" @@ -81,9 +81,9 @@ The [getting started guide](https://kubernetes-sigs.github.io/service-apis/getti For now, the Traefik Gateway Provider can be used while following the below guides: -* [Simple Gateway](https://kubernetes-sigs.github.io/service-apis/simple-gateway/) -* [HTTP routing](https://kubernetes-sigs.github.io/service-apis/http-routing/) -* [TLS](https://kubernetes-sigs.github.io/service-apis/tls/) (Partial support: only on listeners with terminate mode) +* [Simple Gateway](https://kubernetes-sigs.github.io/gateway-api/simple-gateway/) +* [HTTP routing](https://kubernetes-sigs.github.io/gateway-api/http-routing/) +* [TLS](https://kubernetes-sigs.github.io/gateway-api/tls/) (Partial support: only on listeners with terminate mode) ## Resource Configuration @@ -91,7 +91,7 @@ When using Kubernetes Gateway API as a provider, Traefik uses Kubernetes [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) to retrieve its routing configuration. -All concepts can be found in the official API concepts [documentation](https://kubernetes-sigs.github.io/service-apis/api-overview/). +All concepts can be found in the official API concepts [documentation](https://kubernetes-sigs.github.io/gateway-api/api-overview/). Traefik implements the following resources: * `GatewayClass` defines a set of Gateways that share a common configuration and behaviour. diff --git a/docs/content/routing/providers/kubernetes-gateway.md b/docs/content/routing/providers/kubernetes-gateway.md index 03d326760..69289a6d7 100644 --- a/docs/content/routing/providers/kubernetes-gateway.md +++ b/docs/content/routing/providers/kubernetes-gateway.md @@ -35,14 +35,14 @@ You can find an excerpt of the supported Kubernetes Gateway API resources in the | Kind | Purpose | Concept Behind | |------------------------------------|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| -| [GatewayClass](#kind-gatewayclass) | Defines a set of Gateways that share a common configuration and behaviour | [GatewayClass](https://kubernetes-sigs.github.io/service-apis/api-overview/#gatewayclass) | -| [Gateway](#kind-gateway) | Describes how traffic can be translated to Services within the cluster | [Gateway](https://kubernetes-sigs.github.io/service-apis/api-overview/#gateway) | -| [HTTPRoute](#kind-httproute) | HTTP rules for mapping requests from a Gateway to Kubernetes Services | [Route](https://kubernetes-sigs.github.io/service-apis/api-overview/#httptcpfooroute) | +| [GatewayClass](#kind-gatewayclass) | Defines a set of Gateways that share a common configuration and behaviour | [GatewayClass](https://kubernetes-sigs.github.io/gateway-api/api-overview/#gatewayclass) | +| [Gateway](#kind-gateway) | Describes how traffic can be translated to Services within the cluster | [Gateway](https://kubernetes-sigs.github.io/gateway-api/api-overview/#gateway) | +| [HTTPRoute](#kind-httproute) | HTTP rules for mapping requests from a Gateway to Kubernetes Services | [Route](https://kubernetes-sigs.github.io/gateway-api/api-overview/#httptcpfooroute) | ### Kind: `GatewayClass` `GatewayClass` is cluster-scoped resource defined by the infrastructure provider. This resource represents a class of Gateways that can be instantiated. -More details on the GatewayClass [official documentation](https://kubernetes-sigs.github.io/service-apis/gatewayclass/). +More details on the GatewayClass [official documentation](https://kubernetes-sigs.github.io/gateway-api/gatewayclass/). The `GatewayClass` should be declared by the infrastructure provider, otherwise please register the `GatewayClass` [definition](../../reference/dynamic-configuration/kubernetes-gateway.md#definitions) in the Kubernetes cluster before @@ -65,7 +65,7 @@ creating `GatewayClass` objects. A `Gateway` is 1:1 with the life cycle of the configuration of infrastructure. When a user creates a Gateway, some load balancing infrastructure is provisioned or configured by the GatewayClass controller. -More details on the Gateway [official documentation](https://kubernetes-sigs.github.io/service-apis/gateway/). +More details on the Gateway [official documentation](https://kubernetes-sigs.github.io/gateway-api/gateway/). Register the `Gateway` [definition](../../reference/dynamic-configuration/kubernetes-gateway.md#definitions) in the Kubernetes cluster before creating `Gateway` objects.