From 7c4bf602f048e35ac69de4140f6e3f9ea919a781 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Fri, 15 Apr 2022 15:44:08 +0200 Subject: [PATCH] Add title and description metadata to documentation pages --- docs/.markdownlint.json | 1 + docs/content/contributing/advocating.md | 5 +++++ docs/content/contributing/building-testing.md | 5 +++++ docs/content/contributing/data-collection.md | 5 +++++ docs/content/contributing/documentation.md | 5 +++++ docs/content/contributing/maintainers-guidelines.md | 5 +++++ docs/content/contributing/maintainers.md | 5 +++++ docs/content/contributing/submitting-issues.md | 5 +++++ docs/content/contributing/submitting-pull-requests.md | 5 +++++ docs/content/contributing/submitting-security-issues.md | 5 +++++ docs/content/contributing/thank-you.md | 5 +++++ docs/content/getting-started/concepts.md | 5 +++++ docs/content/getting-started/configuration-overview.md | 5 +++++ docs/content/getting-started/faq.md | 5 +++++ docs/content/getting-started/install-traefik.md | 5 +++++ docs/content/getting-started/quick-start.md | 5 +++++ docs/content/https/acme.md | 5 +++++ docs/content/https/overview.md | 5 +++++ docs/content/https/tls.md | 5 +++++ docs/content/index.md | 4 ++++ docs/content/middlewares/http/addprefix.md | 5 +++++ docs/content/middlewares/http/basicauth.md | 5 +++++ docs/content/middlewares/http/buffering.md | 5 +++++ docs/content/middlewares/http/chain.md | 5 +++++ docs/content/middlewares/http/circuitbreaker.md | 5 +++++ docs/content/middlewares/http/compress.md | 7 ++++++- docs/content/middlewares/http/contenttype.md | 5 +++++ docs/content/middlewares/http/digestauth.md | 5 +++++ docs/content/middlewares/http/errorpages.md | 5 +++++ docs/content/middlewares/http/forwardauth.md | 5 +++++ docs/content/middlewares/http/headers.md | 5 +++++ docs/content/middlewares/http/inflightreq.md | 5 +++++ docs/content/middlewares/http/ipwhitelist.md | 5 +++++ docs/content/middlewares/http/overview.md | 5 +++++ docs/content/middlewares/http/passtlsclientcert.md | 5 +++++ docs/content/middlewares/http/ratelimit.md | 5 +++++ docs/content/middlewares/http/redirectregex.md | 5 +++++ docs/content/middlewares/http/redirectscheme.md | 5 +++++ docs/content/middlewares/http/replacepath.md | 5 +++++ docs/content/middlewares/http/replacepathregex.md | 5 +++++ docs/content/middlewares/http/retry.md | 5 +++++ docs/content/middlewares/http/stripprefix.md | 5 +++++ docs/content/middlewares/http/stripprefixregex.md | 5 +++++ docs/content/middlewares/overview.md | 5 +++++ docs/content/middlewares/tcp/ipwhitelist.md | 5 +++++ docs/content/middlewares/tcp/overview.md | 5 +++++ docs/content/migration/v1-to-v2.md | 5 +++++ docs/content/migration/v2.md | 5 +++++ docs/content/observability/access-logs.md | 5 +++++ docs/content/observability/logs.md | 5 +++++ docs/content/observability/metrics/datadog.md | 5 +++++ docs/content/observability/metrics/influxdb.md | 5 +++++ docs/content/observability/metrics/overview.md | 5 +++++ docs/content/observability/metrics/prometheus.md | 5 +++++ docs/content/observability/metrics/statsd.md | 5 +++++ docs/content/observability/tracing/datadog.md | 5 +++++ docs/content/observability/tracing/elastic.md | 5 +++++ docs/content/observability/tracing/haystack.md | 5 +++++ docs/content/observability/tracing/instana.md | 5 +++++ docs/content/observability/tracing/jaeger.md | 5 +++++ docs/content/observability/tracing/overview.md | 5 +++++ docs/content/observability/tracing/zipkin.md | 5 +++++ docs/content/operations/api.md | 5 +++++ docs/content/operations/cli.md | 5 +++++ docs/content/operations/dashboard.md | 5 +++++ docs/content/operations/ping.md | 5 +++++ docs/content/plugins/index.md | 5 +++++ docs/content/providers/consul-catalog.md | 5 +++++ docs/content/providers/consul.md | 5 +++++ docs/content/providers/docker.md | 5 +++++ docs/content/providers/ecs.md | 5 +++++ docs/content/providers/etcd.md | 5 +++++ docs/content/providers/file.md | 5 +++++ docs/content/providers/http.md | 5 +++++ docs/content/providers/kubernetes-crd.md | 5 +++++ docs/content/providers/kubernetes-gateway.md | 5 +++++ docs/content/providers/kubernetes-ingress.md | 5 +++++ docs/content/providers/marathon.md | 5 +++++ docs/content/providers/overview.md | 5 +++++ docs/content/providers/rancher.md | 5 +++++ docs/content/providers/redis.md | 5 +++++ docs/content/providers/zookeeper.md | 5 +++++ .../reference/dynamic-configuration/consul-catalog.md | 5 +++++ docs/content/reference/dynamic-configuration/docker.md | 5 +++++ docs/content/reference/dynamic-configuration/ecs.md | 5 +++++ docs/content/reference/dynamic-configuration/file.md | 5 +++++ .../reference/dynamic-configuration/kubernetes-crd.md | 5 +++++ .../reference/dynamic-configuration/kubernetes-gateway.md | 5 +++++ docs/content/reference/dynamic-configuration/kv.md | 5 +++++ docs/content/reference/dynamic-configuration/marathon.md | 5 +++++ docs/content/reference/dynamic-configuration/rancher.md | 5 +++++ docs/content/reference/static-configuration/cli.md | 5 +++++ docs/content/reference/static-configuration/env.md | 5 +++++ docs/content/reference/static-configuration/file.md | 5 +++++ docs/content/reference/static-configuration/overview.md | 5 +++++ docs/content/routing/entrypoints.md | 5 +++++ docs/content/routing/overview.md | 5 +++++ docs/content/routing/providers/consul-catalog.md | 5 +++++ docs/content/routing/providers/docker.md | 5 +++++ docs/content/routing/providers/ecs.md | 5 +++++ docs/content/routing/providers/kubernetes-crd.md | 5 +++++ docs/content/routing/providers/kubernetes-gateway.md | 5 +++++ docs/content/routing/providers/kubernetes-ingress.md | 5 +++++ docs/content/routing/providers/kv.md | 5 +++++ docs/content/routing/providers/marathon.md | 5 +++++ docs/content/routing/providers/rancher.md | 5 +++++ docs/content/routing/routers/index.md | 5 +++++ docs/content/routing/services/index.md | 5 +++++ docs/content/user-guides/crd-acme/index.md | 5 +++++ docs/content/user-guides/docker-compose/acme-dns/index.md | 5 +++++ docs/content/user-guides/docker-compose/acme-http/index.md | 7 ++++++- docs/content/user-guides/docker-compose/acme-tls/index.md | 5 +++++ .../user-guides/docker-compose/basic-example/index.md | 5 +++++ docs/content/user-guides/grpc.md | 5 +++++ docs/content/user-guides/marathon.md | 5 +++++ docs/mkdocs.yml | 1 + 116 files changed, 573 insertions(+), 2 deletions(-) diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json index 79b1ce5ec..1ca65f278 100644 --- a/docs/.markdownlint.json +++ b/docs/.markdownlint.json @@ -4,6 +4,7 @@ "MD009": false, "MD013": false, "MD024": false, + "MD025": false, "MD026": false, "MD033": false, "MD034": false, diff --git a/docs/content/contributing/advocating.md b/docs/content/contributing/advocating.md index 22083ee46..94870100e 100644 --- a/docs/content/contributing/advocating.md +++ b/docs/content/contributing/advocating.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Advocation Documentation" +description: "There are many ways to contribute to Traefik Proxy. If you're talking about Traefik, let us know and we'll promote your enthusiasm!" +--- + # Advocating Spread the Love & Tell Us about It diff --git a/docs/content/contributing/building-testing.md b/docs/content/contributing/building-testing.md index 0a3a9bdce..8ad94dcc6 100644 --- a/docs/content/contributing/building-testing.md +++ b/docs/content/contributing/building-testing.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Building & Testing Documentation" +description: "Compile and test your own Traefik Proxy! Learn how to build your own Traefik binary from the sources, and read the technical documentation." +--- + # Building and Testing Compile and Test Your Own Traefik! diff --git a/docs/content/contributing/data-collection.md b/docs/content/contributing/data-collection.md index c230a23e7..cb047d8fe 100644 --- a/docs/content/contributing/data-collection.md +++ b/docs/content/contributing/data-collection.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Data Collection Documentation" +description: "To learn more about how Traefik is being used and improve it, we collect anonymous usage statistics from running instances. Read the technical documentation." +--- + # Data Collection Understanding How Traefik is Being Used diff --git a/docs/content/contributing/documentation.md b/docs/content/contributing/documentation.md index 7b735dd1d..ead44d0b3 100644 --- a/docs/content/contributing/documentation.md +++ b/docs/content/contributing/documentation.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Contribution Documentation" +description: "Found something unclear in the Traefik Proxy documentation and want to give a try at explaining it better? Read the guide to building documentation." +--- + # Documentation Features Are Better When You Know How to Use Them diff --git a/docs/content/contributing/maintainers-guidelines.md b/docs/content/contributing/maintainers-guidelines.md index 671eb11c7..a22991807 100644 --- a/docs/content/contributing/maintainers-guidelines.md +++ b/docs/content/contributing/maintainers-guidelines.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Maintainer's Guidelines Documentation" +description: "Interested in contributing more to the community and becoming a Traefik Proxy maintainer? Read the guide to becoming a part of the core team." +--- + # Maintainer's Guidelines ![Maintainer's Guidelines](../assets/img/maintainers-guidelines.png) diff --git a/docs/content/contributing/maintainers.md b/docs/content/contributing/maintainers.md index 3a595dffe..eee5ec69a 100644 --- a/docs/content/contributing/maintainers.md +++ b/docs/content/contributing/maintainers.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Maintainers Documentation" +description: "Traefik Proxy is an open source software with a thriving community of contributors and maintainers. Read the list of maintainers on this page." +--- + # Maintainers ## The Team diff --git a/docs/content/contributing/submitting-issues.md b/docs/content/contributing/submitting-issues.md index 8b8b6b20f..6bcb42679 100644 --- a/docs/content/contributing/submitting-issues.md +++ b/docs/content/contributing/submitting-issues.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Submitting Issues Documentation" +description: "Help us help you! Learn how to submit an issue, following the guidelines, so the Traefik Proxy team can help. Read the technical documentation." +--- + # Submitting Issues Help Us Help You! diff --git a/docs/content/contributing/submitting-pull-requests.md b/docs/content/contributing/submitting-pull-requests.md index 4bec80a78..835482189 100644 --- a/docs/content/contributing/submitting-pull-requests.md +++ b/docs/content/contributing/submitting-pull-requests.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Pull Requests Documentation" +description: "Looking to contribute to Traefik Proxy? This guide will show you the guidelines for submitting a PR in our contributors guide repository." +--- + # Submitting Pull Requests A Quick Guide for Efficient Contributions diff --git a/docs/content/contributing/submitting-security-issues.md b/docs/content/contributing/submitting-security-issues.md index be3187ed1..71bbd7724 100644 --- a/docs/content/contributing/submitting-security-issues.md +++ b/docs/content/contributing/submitting-security-issues.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Security Documentation" +description: "Security is a key part of Traefik Proxy. Read the technical documentation to learn about security advisories, CVE, and how to report a vulnerability." +--- + # Security ## Security Advisories diff --git a/docs/content/contributing/thank-you.md b/docs/content/contributing/thank-you.md index 55411ef4f..e5d7dda61 100644 --- a/docs/content/contributing/thank-you.md +++ b/docs/content/contributing/thank-you.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Contribution Documentation" +description: "Thank you to all those who have contributed! Traefik Proxy is an open-source project that thrives with the support of our passionate community." +--- + # Thank You! _You_ Made It diff --git a/docs/content/getting-started/concepts.md b/docs/content/getting-started/concepts.md index 94baed8e5..fb5066927 100644 --- a/docs/content/getting-started/concepts.md +++ b/docs/content/getting-started/concepts.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Concepts Documentation" +description: "Get started with Traefik Proxy. Read the technical documentation for an introduction into the key concepts behind our open source edge router." +--- + # Concepts Everything You Need to Know diff --git a/docs/content/getting-started/configuration-overview.md b/docs/content/getting-started/configuration-overview.md index a44c9a396..4f68bc9f8 100644 --- a/docs/content/getting-started/configuration-overview.md +++ b/docs/content/getting-started/configuration-overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Configuration Documentation" +description: "Get started with Traefik Proxy. This page will introduce you to the dynamic routing and startup configurations. Read the technical documentation." +--- + # Configuration Introduction How the Magic Happens diff --git a/docs/content/getting-started/faq.md b/docs/content/getting-started/faq.md index 4bb9b2fec..087504452 100644 --- a/docs/content/getting-started/faq.md +++ b/docs/content/getting-started/faq.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Getting Started FAQ" +description: "Check out our FAQ page for answers to commonly asked questions on getting started with Traefik Proxy. Read the technical documentation." +--- + # FAQ ## Why is Traefik Answering `XXX` HTTP Response Status Code? diff --git a/docs/content/getting-started/install-traefik.md b/docs/content/getting-started/install-traefik.md index 6a55f5d48..63791b002 100644 --- a/docs/content/getting-started/install-traefik.md +++ b/docs/content/getting-started/install-traefik.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Installation Documentation" +description: "There are several flavors to choose from when installing Traefik Proxy. Get started with Traefik Proxy, and read the technical documentation." +--- + # Install Traefik You can install Traefik with the following flavors: diff --git a/docs/content/getting-started/quick-start.md b/docs/content/getting-started/quick-start.md index 61fe21299..b003f93fc 100644 --- a/docs/content/getting-started/quick-start.md +++ b/docs/content/getting-started/quick-start.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Getting Started Quickly" +description: "Looking to get started with Traefik Proxy quickly? Read the technical documentation to learn a simple use case that leverages Docker." +--- + # Quick Start A Simple Use Case Using Docker diff --git a/docs/content/https/acme.md b/docs/content/https/acme.md index 6cd060aba..15ba25dcb 100644 --- a/docs/content/https/acme.md +++ b/docs/content/https/acme.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Let's Encrypt Documentation" +description: "Learn how to configure Traefik Proxy to use an ACME provider like Let's Encrypt for automatic certificate generation. Read the technical documentation." +--- + # Let's Encrypt Automatic HTTPS diff --git a/docs/content/https/overview.md b/docs/content/https/overview.md index d03950388..26e147ca2 100644 --- a/docs/content/https/overview.md +++ b/docs/content/https/overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Proxy HTTPS & TLS Overview |Traefik Docs" +description: "Traefik supports HTTPS & TLS, which concerns roughly two parts of the configuration: routers, and the TLS connection. Read the documentation to learn more." +--- + # HTTPS & TLS Overview diff --git a/docs/content/https/tls.md b/docs/content/https/tls.md index 43ecbeb06..f49d1f0e9 100644 --- a/docs/content/https/tls.md +++ b/docs/content/https/tls.md @@ -1,3 +1,8 @@ +--- +title: "Traefik TLS Documentation" +description: "Learn how to configure the transport layer security (TLS) connection in Traefik Proxy. Read the technical documentation." +--- + # TLS Transport Layer Security diff --git a/docs/content/index.md b/docs/content/index.md index 112b90df4..e03c5b656 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -1,3 +1,7 @@ +--- +title: "Traefik Proxy Documentation" +description: "Traefik Proxy, an open source Edge Router, auto-discovers configurations and supports major orchestrators, like Kubernetes. Read the technical documentation." +--- # Welcome diff --git a/docs/content/middlewares/http/addprefix.md b/docs/content/middlewares/http/addprefix.md index 5e888785c..9f909aa8f 100644 --- a/docs/content/middlewares/http/addprefix.md +++ b/docs/content/middlewares/http/addprefix.md @@ -1,3 +1,8 @@ +--- +title: "Traefik AddPrefix Documentation" +description: "Learn how to implement the HTTP AddPrefix middleware in Traefik Proxy to updates request paths before being forwarded. Read the technical documentation." +--- + # Add Prefix Prefixing the Path diff --git a/docs/content/middlewares/http/basicauth.md b/docs/content/middlewares/http/basicauth.md index a80886ced..c9ef0e212 100644 --- a/docs/content/middlewares/http/basicauth.md +++ b/docs/content/middlewares/http/basicauth.md @@ -1,3 +1,8 @@ +--- +title: "Traefik BasicAuth Documentation" +description: "The HTTP basic authentication (BasicAuth) middleware in Traefik Proxy restricts access to your Services to known users. Read the technical documentation." +--- + # BasicAuth Adding Basic Authentication diff --git a/docs/content/middlewares/http/buffering.md b/docs/content/middlewares/http/buffering.md index d2e67e24a..7610e2d81 100644 --- a/docs/content/middlewares/http/buffering.md +++ b/docs/content/middlewares/http/buffering.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Buffering Documentation" +description: "The HTTP buffering middleware in Traefik Proxy limits the size of requests that can be forwarded to Services. Read the technical documentation." +--- + # Buffering How to Read the Request before Forwarding It diff --git a/docs/content/middlewares/http/chain.md b/docs/content/middlewares/http/chain.md index ff61d18ee..3fc06d26b 100644 --- a/docs/content/middlewares/http/chain.md +++ b/docs/content/middlewares/http/chain.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Command Line Documentation" +description: "The HTTP chain middleware lets you define reusable combinations of other middleware, to reuse the same groups. Read the technical documentation." +--- + # Chain When One Isn't Enough diff --git a/docs/content/middlewares/http/circuitbreaker.md b/docs/content/middlewares/http/circuitbreaker.md index daa3c5a0c..d7282d672 100644 --- a/docs/content/middlewares/http/circuitbreaker.md +++ b/docs/content/middlewares/http/circuitbreaker.md @@ -1,3 +1,8 @@ +--- +title: "Traefik CircuitBreaker Documentation" +description: "The HTTP circuit breaker in Traefik Proxy prevents stacking requests to unhealthy Services, resulting in cascading failures. Read the technical documentation." +--- + # CircuitBreaker Don't Waste Time Calling Unhealthy Services diff --git a/docs/content/middlewares/http/compress.md b/docs/content/middlewares/http/compress.md index 95e1268b9..53c39ca62 100644 --- a/docs/content/middlewares/http/compress.md +++ b/docs/content/middlewares/http/compress.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Compress Documentation" +description: "Traefik Proxy's HTTP middleware lets you compress responses before sending them to the client. Read the technical documentation." +--- + # Compress Compress Responses before Sending them to the Client @@ -173,4 +178,4 @@ http: [http.middlewares] [http.middlewares.test-compress.compress] minResponseBodyBytes = 1200 -``` \ No newline at end of file +``` diff --git a/docs/content/middlewares/http/contenttype.md b/docs/content/middlewares/http/contenttype.md index 2d738759c..252a3fda6 100644 --- a/docs/content/middlewares/http/contenttype.md +++ b/docs/content/middlewares/http/contenttype.md @@ -1,3 +1,8 @@ +--- +title: "Traefik ContentType Documentation" +description: "Traefik Proxy's HTTP middleware can automatically specify the content-type header if it has not been defined by the backend. Read the technical documentation." +--- + # ContentType Handling Content-Type auto-detection diff --git a/docs/content/middlewares/http/digestauth.md b/docs/content/middlewares/http/digestauth.md index 2a0904724..14e3982b5 100644 --- a/docs/content/middlewares/http/digestauth.md +++ b/docs/content/middlewares/http/digestauth.md @@ -1,3 +1,8 @@ +--- +title: "Traefik DigestAuth Documentation" +description: "Traefik Proxy's HTTP DigestAuth middleware restricts access to your services to known users. Read the technical documentation." +--- + # DigestAuth Adding Digest Authentication diff --git a/docs/content/middlewares/http/errorpages.md b/docs/content/middlewares/http/errorpages.md index b1751ca33..25d3e508d 100644 --- a/docs/content/middlewares/http/errorpages.md +++ b/docs/content/middlewares/http/errorpages.md @@ -1,3 +1,8 @@ +--- +title: "Traefik ErrorPage Documentation" +description: "In Traefik Proxy, the ErrorPage middleware returns custom pages according to configured ranges of HTTP Status codes. Read the technical documentation." +--- + # ErrorPage It Has Never Been Easier to Say That Something Went Wrong diff --git a/docs/content/middlewares/http/forwardauth.md b/docs/content/middlewares/http/forwardauth.md index 6c81076b2..0d2d566f5 100644 --- a/docs/content/middlewares/http/forwardauth.md +++ b/docs/content/middlewares/http/forwardauth.md @@ -1,3 +1,8 @@ +--- +title: "Traefik ForwardAuth Documentation" +description: "In Traefik Proxy, the HTTP ForwardAuth middleware delegates authentication to an external Service. Read the technical documentation." +--- + # ForwardAuth Using an External Service to Forward Authentication diff --git a/docs/content/middlewares/http/headers.md b/docs/content/middlewares/http/headers.md index 7699b33fb..95ea5c3dc 100644 --- a/docs/content/middlewares/http/headers.md +++ b/docs/content/middlewares/http/headers.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Headers Documentation" +description: "In Traefik Proxy, the HTTP headers middleware manages the headers of requests and responses. Read the technical documentation." +--- + # Headers Managing Request/Response headers diff --git a/docs/content/middlewares/http/inflightreq.md b/docs/content/middlewares/http/inflightreq.md index f2f76a3cb..b3712b148 100644 --- a/docs/content/middlewares/http/inflightreq.md +++ b/docs/content/middlewares/http/inflightreq.md @@ -1,3 +1,8 @@ +--- +title: "Traefik InFlightReq Documentation" +description: "Traefik Proxy's HTTP middleware lets you limit the number of simultaneous in-flight requests. Read the technical documentation." +--- + # InFlightReq Limiting the Number of Simultaneous In-Flight Requests diff --git a/docs/content/middlewares/http/ipwhitelist.md b/docs/content/middlewares/http/ipwhitelist.md index 5718a6438..3817b54d5 100644 --- a/docs/content/middlewares/http/ipwhitelist.md +++ b/docs/content/middlewares/http/ipwhitelist.md @@ -1,3 +1,8 @@ +--- +title: "Traefik HTTP Middlewares IPWhiteList" +description: "Learn how to use IPWhiteList in HTTP middleware for limiting clients to specific IPs in Traefik Proxy. Read the technical documentation." +--- + # IPWhiteList Limiting Clients to Specific IPs diff --git a/docs/content/middlewares/http/overview.md b/docs/content/middlewares/http/overview.md index 65350dc3a..cd358371a 100644 --- a/docs/content/middlewares/http/overview.md +++ b/docs/content/middlewares/http/overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Proxy HTTP Middleware Overview" +description: "Read the official Traefik Proxy documentation for an overview of the available HTTP middleware." +--- + # HTTP Middlewares Controlling connections diff --git a/docs/content/middlewares/http/passtlsclientcert.md b/docs/content/middlewares/http/passtlsclientcert.md index 41269f68a..e38391912 100644 --- a/docs/content/middlewares/http/passtlsclientcert.md +++ b/docs/content/middlewares/http/passtlsclientcert.md @@ -1,3 +1,8 @@ +--- +title: "Traefik PassTLSClientCert Documentation" +description: "In Traefik Proxy's HTTP middleware, the PassTLSClientCert adds selected data from passed client TLS certificates to headers. Read the technical documentation." +--- + # PassTLSClientCert Adding Client Certificates in a Header diff --git a/docs/content/middlewares/http/ratelimit.md b/docs/content/middlewares/http/ratelimit.md index 7c8a45906..8d62afd9c 100644 --- a/docs/content/middlewares/http/ratelimit.md +++ b/docs/content/middlewares/http/ratelimit.md @@ -1,3 +1,8 @@ +--- +title: "Traefik RateLimit Documentation" +description: "Traefik Proxy's HTTP RateLimit middleware ensures Services receive fair amounts of requests. Read the technical documentation." +--- + # RateLimit To Control the Number of Requests Going to a Service diff --git a/docs/content/middlewares/http/redirectregex.md b/docs/content/middlewares/http/redirectregex.md index fce7d5f07..97d2d83e6 100644 --- a/docs/content/middlewares/http/redirectregex.md +++ b/docs/content/middlewares/http/redirectregex.md @@ -1,3 +1,8 @@ +--- +title: "Traefik RedirectRegex Documentation" +description: "In Traefik Proxy's HTTP middleware, RedirectRegex redirecting clients to different locations. Read the technical documentation." +--- + # RedirectRegex Redirecting the Client to a Different Location diff --git a/docs/content/middlewares/http/redirectscheme.md b/docs/content/middlewares/http/redirectscheme.md index e53c98fbe..2d4520867 100644 --- a/docs/content/middlewares/http/redirectscheme.md +++ b/docs/content/middlewares/http/redirectscheme.md @@ -1,3 +1,8 @@ +--- +title: "Traefik RedirectScheme Documentation" +description: "In Traefik Proxy's HTTP middleware, RedirectScheme redirects clients to different schemes/ports. Read the technical documentation." +--- + # RedirectScheme Redirecting the Client to a Different Scheme/Port diff --git a/docs/content/middlewares/http/replacepath.md b/docs/content/middlewares/http/replacepath.md index 7da144f1e..0617508e9 100644 --- a/docs/content/middlewares/http/replacepath.md +++ b/docs/content/middlewares/http/replacepath.md @@ -1,3 +1,8 @@ +--- +title: "Traefik ReplacePath Documentation" +description: "In Traefik Proxy's HTTP middleware, ReplacePath updates paths before forwarding requests. Read the technical documentation." +--- + # ReplacePath Updating the Path Before Forwarding the Request diff --git a/docs/content/middlewares/http/replacepathregex.md b/docs/content/middlewares/http/replacepathregex.md index 9862a308b..b729a30ab 100644 --- a/docs/content/middlewares/http/replacepathregex.md +++ b/docs/content/middlewares/http/replacepathregex.md @@ -1,3 +1,8 @@ +--- +title: "Traefik ReplacePathRegex Documentation" +description: "In Traefik Proxy's HTTP middleware, ReplacePathRegex updates paths before forwarding requests, using a regex. Read the technical documentation." +--- + # ReplacePathRegex Updating the Path Before Forwarding the Request (Using a Regex) diff --git a/docs/content/middlewares/http/retry.md b/docs/content/middlewares/http/retry.md index d5ef43c95..956bdc498 100644 --- a/docs/content/middlewares/http/retry.md +++ b/docs/content/middlewares/http/retry.md @@ -1,3 +1,8 @@ +--- +title: "Traefik HTTP Retry Documentation" +description: "Configure Traefik Proxy's HTTP Retry middleware, so you can retry requests to a backend server until it succeeds. Read the technical documentation." +--- + # Retry Retrying until it Succeeds diff --git a/docs/content/middlewares/http/stripprefix.md b/docs/content/middlewares/http/stripprefix.md index fc55fb444..23288008b 100644 --- a/docs/content/middlewares/http/stripprefix.md +++ b/docs/content/middlewares/http/stripprefix.md @@ -1,3 +1,8 @@ +--- +title: "Traefik StripPrefix Documentation" +description: "In Traefik Proxy's HTTP middleware, StripPrefix removes prefixes from paths before forwarding requests. Read the technical documentation." +--- + # StripPrefix Removing Prefixes From the Path Before Forwarding the Request diff --git a/docs/content/middlewares/http/stripprefixregex.md b/docs/content/middlewares/http/stripprefixregex.md index 74bfebba9..d560a5d12 100644 --- a/docs/content/middlewares/http/stripprefixregex.md +++ b/docs/content/middlewares/http/stripprefixregex.md @@ -1,3 +1,8 @@ +--- +title: "Traefik StripPrefixRegex Documentation" +description: "In Traefik Proxy's HTTP middleware, StripPrefixRegex removes prefixes from paths before forwarding requests, using regex. Read the technical documentation." +--- + # StripPrefixRegex Removing Prefixes From the Path Before Forwarding the Request (Using a Regex) diff --git a/docs/content/middlewares/overview.md b/docs/content/middlewares/overview.md index e48e2cfe8..fad2221a6 100644 --- a/docs/content/middlewares/overview.md +++ b/docs/content/middlewares/overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Proxy Middleware Overview" +description: "There are several available middleware in Traefik Proxy used to modify requests or headers, take charge of redirections, add authentication, and so on." +--- + # Middlewares Tweaking the Request diff --git a/docs/content/middlewares/tcp/ipwhitelist.md b/docs/content/middlewares/tcp/ipwhitelist.md index f8a613673..857d72bc7 100644 --- a/docs/content/middlewares/tcp/ipwhitelist.md +++ b/docs/content/middlewares/tcp/ipwhitelist.md @@ -1,3 +1,8 @@ +--- +title: "Traefik TCP Middlewares IPWhiteList" +description: "Learn how to use IPWhiteList in TCP middleware for limiting clients to specific IPs in Traefik Proxy. Read the technical documentation." +--- + # IPWhiteList Limiting Clients to Specific IPs diff --git a/docs/content/middlewares/tcp/overview.md b/docs/content/middlewares/tcp/overview.md index 8fc5f4919..682dbe0f0 100644 --- a/docs/content/middlewares/tcp/overview.md +++ b/docs/content/middlewares/tcp/overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Proxy TCP Middleware Overview" +description: "Read the official Traefik Proxy documentation for an overview of the available TCP middleware." +--- + # TCP Middlewares Controlling connections diff --git a/docs/content/migration/v1-to-v2.md b/docs/content/migration/v1-to-v2.md index db447b055..2109fe8e3 100644 --- a/docs/content/migration/v1-to-v2.md +++ b/docs/content/migration/v1-to-v2.md @@ -1,3 +1,8 @@ +--- +title: "Traefik V2 Migration Documentation" +description: "Migrate from Traefik Proxy v1 to v2 and update all the necessary configurations to take advantage of all the improvements. Read the technical documentation." +--- + # Migration Guide: From v1 to v2 How to Migrate from Traefik v1 to Traefik v2. diff --git a/docs/content/migration/v2.md b/docs/content/migration/v2.md index 95b3b636a..fa5b87112 100644 --- a/docs/content/migration/v2.md +++ b/docs/content/migration/v2.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Migration Documentation" +description: "Learn the steps needed to migrate to new Traefik Proxy v2 versions, i.e. v2.0 to v2.1 or v2.1 to v2.2. Read the technical documentation." +--- + # Migration: Steps needed between the versions ## v2.0 to v2.1 diff --git a/docs/content/observability/access-logs.md b/docs/content/observability/access-logs.md index 56387a30e..243c649d2 100644 --- a/docs/content/observability/access-logs.md +++ b/docs/content/observability/access-logs.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Access Logs Documentation" +description: "Access logs are a key part of observability in Traefik Proxy. Read the technical documentation to learn their configurations, rotations, and time zones." +--- + # Access Logs Who Calls Whom? diff --git a/docs/content/observability/logs.md b/docs/content/observability/logs.md index 2c77dea39..e1beea2a5 100644 --- a/docs/content/observability/logs.md +++ b/docs/content/observability/logs.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Logs Documentation" +description: "Logs are a key part of observability in Traefik Proxy. Read the technical documentation to learn their configurations, rotations, and time zones." +--- + # Logs Reading What's Happening diff --git a/docs/content/observability/metrics/datadog.md b/docs/content/observability/metrics/datadog.md index 326311293..00a5d6c9f 100644 --- a/docs/content/observability/metrics/datadog.md +++ b/docs/content/observability/metrics/datadog.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Datadog Metrics Documentation" +description: "Traefik Proxy supports Datadog for backend metrics. Read the technical documentation to enable Datadog for observability." +--- + # Datadog To enable the Datadog: diff --git a/docs/content/observability/metrics/influxdb.md b/docs/content/observability/metrics/influxdb.md index 1cdc8d89e..0eb05e23c 100644 --- a/docs/content/observability/metrics/influxdb.md +++ b/docs/content/observability/metrics/influxdb.md @@ -1,3 +1,8 @@ +--- +title: "Traefik InfluxDB Documentation" +description: "Traefik supports several metrics backends, including InfluxDB. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation." +--- + # InfluxDB To enable the InfluxDB: diff --git a/docs/content/observability/metrics/overview.md b/docs/content/observability/metrics/overview.md index 0d1eae97a..000adf352 100644 --- a/docs/content/observability/metrics/overview.md +++ b/docs/content/observability/metrics/overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Metrics Overview" +description: "Traefik Proxy supports four metrics backend systems: Datadog, InfluxDB, Prometheus, and StatsD. Read the full documentation to get started." +--- + # Metrics Traefik supports 4 metrics backends: diff --git a/docs/content/observability/metrics/prometheus.md b/docs/content/observability/metrics/prometheus.md index 012f1be9b..da7f73773 100644 --- a/docs/content/observability/metrics/prometheus.md +++ b/docs/content/observability/metrics/prometheus.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Prometheus Documentation" +description: "Traefik supports several metrics backends, including Prometheus. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation." +--- + # Prometheus To enable the Prometheus: diff --git a/docs/content/observability/metrics/statsd.md b/docs/content/observability/metrics/statsd.md index cde0126b2..79472dd06 100644 --- a/docs/content/observability/metrics/statsd.md +++ b/docs/content/observability/metrics/statsd.md @@ -1,3 +1,8 @@ +--- +title: "Traefik StatsD Documentation" +description: "Traefik supports several metrics backends, including StatsD. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation." +--- + # StatsD To enable the Statsd: diff --git a/docs/content/observability/tracing/datadog.md b/docs/content/observability/tracing/datadog.md index e325299d2..4aa448318 100644 --- a/docs/content/observability/tracing/datadog.md +++ b/docs/content/observability/tracing/datadog.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Datadog Tracing Documentation" +description: "Traefik Proxy supports Datadog for tracing. Read the technical documentation to enable Datadog for observability." +--- + # Datadog To enable the Datadog tracer: diff --git a/docs/content/observability/tracing/elastic.md b/docs/content/observability/tracing/elastic.md index ad73b230c..0cb0dccee 100644 --- a/docs/content/observability/tracing/elastic.md +++ b/docs/content/observability/tracing/elastic.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Elastic Documentation" +description: "Traefik supports several tracing backends, including Elastic. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation." +--- + # Elastic To enable the Elastic tracer: diff --git a/docs/content/observability/tracing/haystack.md b/docs/content/observability/tracing/haystack.md index ebbbfa478..af9945ed7 100644 --- a/docs/content/observability/tracing/haystack.md +++ b/docs/content/observability/tracing/haystack.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Haystack Documentation" +description: "Traefik supports several tracing backends, including Haystack. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation." +--- + # Haystack To enable the Haystack tracer: diff --git a/docs/content/observability/tracing/instana.md b/docs/content/observability/tracing/instana.md index f53f64de5..914d9d3f4 100644 --- a/docs/content/observability/tracing/instana.md +++ b/docs/content/observability/tracing/instana.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Instana Documentation" +description: "Traefik supports several tracing backends, including Instana. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation." +--- + # Instana To enable the Instana tracer: diff --git a/docs/content/observability/tracing/jaeger.md b/docs/content/observability/tracing/jaeger.md index 67681f60a..d40ffed6d 100644 --- a/docs/content/observability/tracing/jaeger.md +++ b/docs/content/observability/tracing/jaeger.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Jaeger Documentation" +description: "Traefik supports several tracing backends, including Jaeger. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation." +--- + # Jaeger To enable the Jaeger tracer: diff --git a/docs/content/observability/tracing/overview.md b/docs/content/observability/tracing/overview.md index 17f6a522a..73504a140 100644 --- a/docs/content/observability/tracing/overview.md +++ b/docs/content/observability/tracing/overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Tracing Overview" +description: "The Traefik Proxy tracing system allows developers to visualize call flows in their infrastructure. Read the full documentation." +--- + # Tracing Visualize the Requests Flow diff --git a/docs/content/observability/tracing/zipkin.md b/docs/content/observability/tracing/zipkin.md index 82d8cdfcd..146dae6e1 100644 --- a/docs/content/observability/tracing/zipkin.md +++ b/docs/content/observability/tracing/zipkin.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Zipkin Documentation" +description: "Traefik supports several tracing backends, including Zipkin. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation." +--- + # Zipkin To enable the Zipkin tracer: diff --git a/docs/content/operations/api.md b/docs/content/operations/api.md index bf3872274..3b30993a5 100644 --- a/docs/content/operations/api.md +++ b/docs/content/operations/api.md @@ -1,3 +1,8 @@ +--- +title: "Traefik API Documentation" +description: "Traefik Proxy exposes information through API handlers. Learn about the security, configuration, and endpoints of APIs. Read the technical documentation." +--- + # API Traefik exposes a number of information through an API handler, such as the configuration of all routers, services, middlewares, etc. diff --git a/docs/content/operations/cli.md b/docs/content/operations/cli.md index 35cb3a539..cf4257ae5 100644 --- a/docs/content/operations/cli.md +++ b/docs/content/operations/cli.md @@ -1,3 +1,8 @@ +--- +title: "Traefik CLI Documentation" +description: "Learn the basics of the Traefik Proxy command line interface (CLI). Read the technical documentation." +--- + # CLI The Traefik Command Line diff --git a/docs/content/operations/dashboard.md b/docs/content/operations/dashboard.md index 6ec1df1c4..a0f527c53 100644 --- a/docs/content/operations/dashboard.md +++ b/docs/content/operations/dashboard.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Dashboard Documentation" +description: "The dashboard shows you the current active routes handled by Traefik Proxy in one central place. Read the technical documentation to learn its operations." +--- + # The Dashboard See What's Going On diff --git a/docs/content/operations/ping.md b/docs/content/operations/ping.md index cc187bb9f..3dc1de3d9 100644 --- a/docs/content/operations/ping.md +++ b/docs/content/operations/ping.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Ping Documentation" +description: "In Traefik Proxy, Ping lets you check the health of your Traefik instances. Read the technical documentation for configuration examples and options." +--- + # Ping Checking the Health of Your Traefik Instances diff --git a/docs/content/plugins/index.md b/docs/content/plugins/index.md index ac3330dbe..f5062b21f 100644 --- a/docs/content/plugins/index.md +++ b/docs/content/plugins/index.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Plugins Documentation" +description: "Learn how to connect Traefik Proxy with Pilot, a SaaS platform that offers features for metrics, alerts, and plugins. Read the technical documentation." +--- + # Plugins and Traefik Pilot Traefik Pilot is a software-as-a-service (SaaS) platform that connects to Traefik to extend its capabilities. diff --git a/docs/content/providers/consul-catalog.md b/docs/content/providers/consul-catalog.md index 35d0d600e..420daf790 100644 --- a/docs/content/providers/consul-catalog.md +++ b/docs/content/providers/consul-catalog.md @@ -1,3 +1,8 @@ +--- +title: "Consul Catalog Configuration Discovery" +description: "Learn how to use Consul Catalog as a provider for configuration discovery in Traefik Proxy. Read the technical documentation." +--- + # Traefik & Consul Catalog A Story of Tags, Services & Instances diff --git a/docs/content/providers/consul.md b/docs/content/providers/consul.md index 20dccd0a4..289991062 100644 --- a/docs/content/providers/consul.md +++ b/docs/content/providers/consul.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Consul Documentation" +description: "Use Consul as a provider for configuration discovery in Traefik Proxy. Automate and store your configurations with Consul. Read the technical documentation." +--- + # Traefik & Consul A Story of KV store & Containers diff --git a/docs/content/providers/docker.md b/docs/content/providers/docker.md index c659af73f..9754aab8a 100644 --- a/docs/content/providers/docker.md +++ b/docs/content/providers/docker.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Docker Documentation" +description: "Learn how to achieve configuration discovery in Traefik through Docker. Read the technical documentation." +--- + # Traefik & Docker A Story of Labels & Containers diff --git a/docs/content/providers/ecs.md b/docs/content/providers/ecs.md index 8a0531e31..282da12aa 100644 --- a/docs/content/providers/ecs.md +++ b/docs/content/providers/ecs.md @@ -1,3 +1,8 @@ +--- +title: "Traefik AWS ECS Documentation" +description: "Configuration discovery in Traefik is achieved through Providers. Read the technical documentation for leveraging AWS ECS in Traefik." +--- + # Traefik & AWS ECS A Story of Labels & Elastic Containers diff --git a/docs/content/providers/etcd.md b/docs/content/providers/etcd.md index d7c2e67b2..82909eedd 100644 --- a/docs/content/providers/etcd.md +++ b/docs/content/providers/etcd.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Etcd Documentation" +description: "Use Etcd as a provider for configuration discovery in Traefik Proxy. Automate and store your configurations with Etcd. Read the technical documentation." +--- + # Traefik & Etcd A Story of KV store & Containers diff --git a/docs/content/providers/file.md b/docs/content/providers/file.md index 0d0c704e6..5283cdb25 100644 --- a/docs/content/providers/file.md +++ b/docs/content/providers/file.md @@ -1,3 +1,8 @@ +--- +title: "Traefik File Documentation" +description: "The file provider in Traefik Proxy lets you define the dynamic configuration in a YAML or TOML file. Read the technical documentation." +--- + # Traefik & File Good Old Configuration File diff --git a/docs/content/providers/http.md b/docs/content/providers/http.md index 4f2fd1f47..5868e7a4b 100644 --- a/docs/content/providers/http.md +++ b/docs/content/providers/http.md @@ -1,3 +1,8 @@ +--- +title: "Traefik HTTP Documentation" +description: "Provide your dynamic configuration via an HTTP(S) endpoint and let Traefik Proxy do the rest. Read the technical documentation." +--- + # Traefik & HTTP Provide your [dynamic configuration](./overview.md) via an HTTP(S) endpoint and let Traefik do the rest! diff --git a/docs/content/providers/kubernetes-crd.md b/docs/content/providers/kubernetes-crd.md index 6cf0d55fe..fbe8fcf1d 100644 --- a/docs/content/providers/kubernetes-crd.md +++ b/docs/content/providers/kubernetes-crd.md @@ -1,3 +1,8 @@ +--- +title: "Kubernetes IngressRoute & Traefik CRD" +description: "The Traefik team developed a Custom Resource Definition (CRD) for an IngressRoute type, to provide a better way to configure access to a Kubernetes cluster." +--- + # Traefik & Kubernetes The Kubernetes Ingress Controller, The Custom Resource Way. diff --git a/docs/content/providers/kubernetes-gateway.md b/docs/content/providers/kubernetes-gateway.md index d9cbe1d60..b6e411517 100644 --- a/docs/content/providers/kubernetes-gateway.md +++ b/docs/content/providers/kubernetes-gateway.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Kubernetes Gateway API Documentation" +description: "Learn how to use the Kubernetes Gateway API as a provider for configuration discovery in Traefik Proxy. Read the technical documentation." +--- + # Traefik & Kubernetes with Gateway API The Kubernetes Gateway API, The Experimental Way. diff --git a/docs/content/providers/kubernetes-ingress.md b/docs/content/providers/kubernetes-ingress.md index 45af9bbf7..c490211ec 100644 --- a/docs/content/providers/kubernetes-ingress.md +++ b/docs/content/providers/kubernetes-ingress.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Kubernetes Ingress Documentation" +description: "Understand the requirements, routing configuration, and how to set up Traefik Proxy as your Kubernetes Ingress Controller. Read the technical documentation." +--- + # Traefik & Kubernetes The Kubernetes Ingress Controller. diff --git a/docs/content/providers/marathon.md b/docs/content/providers/marathon.md index 51571ddb2..ec1490e1f 100644 --- a/docs/content/providers/marathon.md +++ b/docs/content/providers/marathon.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Configuration for Marathon" +description: "Traefik Proxy can be configured to use Marathon as a provider. Read the technical documentation to learn how." +--- + # Traefik & Marathon Traefik can be configured to use Marathon as a provider. diff --git a/docs/content/providers/overview.md b/docs/content/providers/overview.md index d5413c8c3..0c6ec0d5d 100644 --- a/docs/content/providers/overview.md +++ b/docs/content/providers/overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Configuration Discovery Overview" +description: "Configuration discovery in Traefik is achieved through Providers. The providers are infrastructure components. Read the documentation to learn more." +--- + # Overview Traefik's Many Friends diff --git a/docs/content/providers/rancher.md b/docs/content/providers/rancher.md index 210e4d9f1..b709a5329 100644 --- a/docs/content/providers/rancher.md +++ b/docs/content/providers/rancher.md @@ -1,3 +1,8 @@ +--- +title: ""Traefik Configuration Discovery: Rancher"" +description: "Read the official Traefik documentation to learn how to expose Rancher services by default in Traefik Proxy." +--- + # Traefik & Rancher A Story of Labels, Services & Containers diff --git a/docs/content/providers/redis.md b/docs/content/providers/redis.md index 46481957b..762d9aab6 100644 --- a/docs/content/providers/redis.md +++ b/docs/content/providers/redis.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Redis Documentation" +description: "For configuration discovery in Traefik Proxy, you can store your configurations in Redis. Read the technical documentation." +--- + # Traefik & Redis A Story of KV store & Containers diff --git a/docs/content/providers/zookeeper.md b/docs/content/providers/zookeeper.md index cd47977de..8ebc94859 100644 --- a/docs/content/providers/zookeeper.md +++ b/docs/content/providers/zookeeper.md @@ -1,3 +1,8 @@ +--- +title: "Traefik ZooKeeper Documentation" +description: "For configuration discovery in Traefik Proxy, you can store your configurations in ZooKeeper. Read the technical documentation." +--- + # Traefik & ZooKeeper A Story of KV Store & Containers diff --git a/docs/content/reference/dynamic-configuration/consul-catalog.md b/docs/content/reference/dynamic-configuration/consul-catalog.md index fd3a41de4..534fd953a 100644 --- a/docs/content/reference/dynamic-configuration/consul-catalog.md +++ b/docs/content/reference/dynamic-configuration/consul-catalog.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Consul Configuration Documentation" +description: "View the reference for performing dynamic configurations with Traefik Proxy and Consul Catalog. Read the technical documentation." +--- + # Consul Catalog Configuration Reference Dynamic configuration with Consul Catalog diff --git a/docs/content/reference/dynamic-configuration/docker.md b/docs/content/reference/dynamic-configuration/docker.md index dd6c4bce1..1d56559bb 100644 --- a/docs/content/reference/dynamic-configuration/docker.md +++ b/docs/content/reference/dynamic-configuration/docker.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Docker Configuration Documentation" +description: "Reference dynamic configuration with Docker labels in Traefik Proxy. Read the technical documentation." +--- + # Docker Configuration Reference Dynamic configuration with Docker Labels diff --git a/docs/content/reference/dynamic-configuration/ecs.md b/docs/content/reference/dynamic-configuration/ecs.md index aac748b75..e32038f5a 100644 --- a/docs/content/reference/dynamic-configuration/ecs.md +++ b/docs/content/reference/dynamic-configuration/ecs.md @@ -1,3 +1,8 @@ +--- +title: "Traefik AWS ECS Configuration Documentation" +description: "Learn how to do dynamic configuration in Traefik Proxy with AWS ECS. Read the technical documentation." +--- + # ECS Configuration Reference Dynamic configuration with ECS provider diff --git a/docs/content/reference/dynamic-configuration/file.md b/docs/content/reference/dynamic-configuration/file.md index 49986c88f..eac9dc9a1 100644 --- a/docs/content/reference/dynamic-configuration/file.md +++ b/docs/content/reference/dynamic-configuration/file.md @@ -1,3 +1,8 @@ +--- +title: "Traefik File Dynamic Configuration" +description: "This guide will provide you with the YAML and TOML files for dynamic configuration in Traefik Proxy. Read the technical documentation." +--- + # File Configuration Reference Dynamic configuration with files diff --git a/docs/content/reference/dynamic-configuration/kubernetes-crd.md b/docs/content/reference/dynamic-configuration/kubernetes-crd.md index ccda41843..42720d17c 100644 --- a/docs/content/reference/dynamic-configuration/kubernetes-crd.md +++ b/docs/content/reference/dynamic-configuration/kubernetes-crd.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Kubernetes CRD Documentation" +description: "Learn about the definitions, resources, and RBAC of dynamic configuration with Kubernetes CRD in Traefik Proxy. Read the technical documentation." +--- + # Kubernetes Configuration Reference Dynamic configuration with Kubernetes Custom Resource diff --git a/docs/content/reference/dynamic-configuration/kubernetes-gateway.md b/docs/content/reference/dynamic-configuration/kubernetes-gateway.md index 8b668b445..1c0d4ce04 100644 --- a/docs/content/reference/dynamic-configuration/kubernetes-gateway.md +++ b/docs/content/reference/dynamic-configuration/kubernetes-gateway.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Kubernetes Routing" +description: "Reference the dynamic configuration with the Kubernetes Gateway provider in Traefik Proxy. Read the technical documentation." +--- + # Kubernetes Configuration Reference Dynamic configuration with Kubernetes Gateway provider. diff --git a/docs/content/reference/dynamic-configuration/kv.md b/docs/content/reference/dynamic-configuration/kv.md index 7c4d9c656..8db8415e5 100644 --- a/docs/content/reference/dynamic-configuration/kv.md +++ b/docs/content/reference/dynamic-configuration/kv.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Dynamic Configuration with KV stores" +description: "Read the technical documentation to learn the Traefik Dynamic Configuration with KV stores." +--- + # KV Configuration Reference Dynamic configuration with KV stores. diff --git a/docs/content/reference/dynamic-configuration/marathon.md b/docs/content/reference/dynamic-configuration/marathon.md index 6d4e17c23..0e20679f8 100644 --- a/docs/content/reference/dynamic-configuration/marathon.md +++ b/docs/content/reference/dynamic-configuration/marathon.md @@ -1,3 +1,8 @@ +--- +title: "Dynamic Configuration with Marathon Labels" +description: "Traefik Proxy can be configured to use Marathon as a provider. Read the technical documentation on the Traefik dynamic configuration with Marathon Labels." +--- + # Marathon Configuration Reference Dynamic configuration with Marathon Labels diff --git a/docs/content/reference/dynamic-configuration/rancher.md b/docs/content/reference/dynamic-configuration/rancher.md index c6cd56736..c2762999d 100644 --- a/docs/content/reference/dynamic-configuration/rancher.md +++ b/docs/content/reference/dynamic-configuration/rancher.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Dynamic Configuration with Rancher" +description: "Read the official Traefik documentation to learn more on dynamic configuration in Traefik Proxy with Rancher Labels." +--- + # Rancher Configuration Reference Dynamic configuration with Rancher Labels diff --git a/docs/content/reference/static-configuration/cli.md b/docs/content/reference/static-configuration/cli.md index 73319a30d..85179eade 100644 --- a/docs/content/reference/static-configuration/cli.md +++ b/docs/content/reference/static-configuration/cli.md @@ -1,3 +1,8 @@ +--- +title: "Traefik CLI Flags Documentation" +description: "Reference the CLI flags for static configuration in Traefik Proxy. Read the technical documentation." +--- + # Static Configuration: CLI --8<-- "content/reference/static-configuration/cli-ref.md" diff --git a/docs/content/reference/static-configuration/env.md b/docs/content/reference/static-configuration/env.md index 0885c93d0..e894850b2 100644 --- a/docs/content/reference/static-configuration/env.md +++ b/docs/content/reference/static-configuration/env.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Environment Variables Documentation" +description: "Reference the environment variables for static configuration in Traefik Proxy. Read the technical documentation." +--- + # Static Configuration: Environment variables --8<-- "content/reference/static-configuration/env-ref.md" diff --git a/docs/content/reference/static-configuration/file.md b/docs/content/reference/static-configuration/file.md index 2ea52b8ae..c2f3174db 100644 --- a/docs/content/reference/static-configuration/file.md +++ b/docs/content/reference/static-configuration/file.md @@ -1,3 +1,8 @@ +--- +title: "Traefik File Static Configuration" +description: "Reference the YAML and TOML files for static configuration in Traefik Proxy. Read the technical documentation." +--- + # Static Configuration: File ```yml tab="YAML" diff --git a/docs/content/reference/static-configuration/overview.md b/docs/content/reference/static-configuration/overview.md index 57bf649d0..853ab0a97 100644 --- a/docs/content/reference/static-configuration/overview.md +++ b/docs/content/reference/static-configuration/overview.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Static Configuration Overview" +description: "Read the official Traefik documentation to get started with static configuration in Traefik Proxy." +--- + # Static Configuration - [File](./file.md) diff --git a/docs/content/routing/entrypoints.md b/docs/content/routing/entrypoints.md index 2aa6b6faf..3ee9f9c6d 100644 --- a/docs/content/routing/entrypoints.md +++ b/docs/content/routing/entrypoints.md @@ -1,3 +1,8 @@ +--- +title: "Traefik EntryPoints Documentation" +description: "For routing and load balancing in Traefik Proxy, EntryPoints define which port will receive packets and whether in UDP or TCP. Read the technical documentation." +--- + # EntryPoints Opening Connections for Incoming Requests diff --git a/docs/content/routing/overview.md b/docs/content/routing/overview.md index 59b3e4a8c..ee3b61b84 100644 --- a/docs/content/routing/overview.md +++ b/docs/content/routing/overview.md @@ -1,3 +1,8 @@ +--- +title: "Routing & Load Balancing Overview |Traefik Docs" +description: "Read the official Traefik documentation to learn more on the Traefik Proxy architecture and the components that enable the routes to be created." +--- + # Overview What's Happening to the Requests? diff --git a/docs/content/routing/providers/consul-catalog.md b/docs/content/routing/providers/consul-catalog.md index 1431ad71c..35d1dffc6 100644 --- a/docs/content/routing/providers/consul-catalog.md +++ b/docs/content/routing/providers/consul-catalog.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Consul Catalog Routing" +description: "Learn how to use Consul Catalog as a provider for routing configurations in Traefik Proxy. Read the technical documentation." +--- + # Traefik & Consul Catalog A Story of Tags, Services & Instances diff --git a/docs/content/routing/providers/docker.md b/docs/content/routing/providers/docker.md index 923c21237..17485c053 100644 --- a/docs/content/routing/providers/docker.md +++ b/docs/content/routing/providers/docker.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Docker Routing Documentation" +description: "This guide will teach you how to attach labels to your containers, to route traffic and load balance with Traefik and Docker." +--- + # Traefik & Docker A Story of Labels & Containers diff --git a/docs/content/routing/providers/ecs.md b/docs/content/routing/providers/ecs.md index cfcb1af8c..3f030768d 100644 --- a/docs/content/routing/providers/ecs.md +++ b/docs/content/routing/providers/ecs.md @@ -1,3 +1,8 @@ +--- +title: "Traefik ECS Documentation" +description: "AWS ECS is a provider for routing and load balancing in Traefik Proxy. Read the technical documentation to get started." +--- + # Traefik & ECS A Story of Labels & Elastic Containers diff --git a/docs/content/routing/providers/kubernetes-crd.md b/docs/content/routing/providers/kubernetes-crd.md index 0eb1552b7..6b6a7b263 100644 --- a/docs/content/routing/providers/kubernetes-crd.md +++ b/docs/content/routing/providers/kubernetes-crd.md @@ -1,3 +1,8 @@ +--- +title: "Routing Configuration for Traefik CRD" +description: "Understand the routing configuration for the Kubernetes IngressRoute & Traefik CRD. Read the technical documentation." +--- + # Traefik & Kubernetes The Kubernetes Ingress Controller, The Custom Resource Way. diff --git a/docs/content/routing/providers/kubernetes-gateway.md b/docs/content/routing/providers/kubernetes-gateway.md index b679ba95b..bd000bbcc 100644 --- a/docs/content/routing/providers/kubernetes-gateway.md +++ b/docs/content/routing/providers/kubernetes-gateway.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Kubernetes Gateway" +description: "The Kubernetes Gateway API can be used as a provider for routing and load balancing in Traefik Proxy. View examples in the technical documentation." +--- + # Traefik & Kubernetes The Kubernetes Gateway API, The Experimental Way. {: .subtitle } diff --git a/docs/content/routing/providers/kubernetes-ingress.md b/docs/content/routing/providers/kubernetes-ingress.md index 2a63dc8f6..39ccf4bb0 100644 --- a/docs/content/routing/providers/kubernetes-ingress.md +++ b/docs/content/routing/providers/kubernetes-ingress.md @@ -1,3 +1,8 @@ +--- +title: "Kubernetes Ingress Routing Configuration" +description: "Understand the routing configuration for the Kubernetes Ingress Controller and Traefik Proxy. Read the technical documentation." +--- + # Traefik & Kubernetes The Kubernetes Ingress Controller. diff --git a/docs/content/routing/providers/kv.md b/docs/content/routing/providers/kv.md index 34ca6d38f..be6c4d837 100644 --- a/docs/content/routing/providers/kv.md +++ b/docs/content/routing/providers/kv.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Routing Configuration with KV stores" +description: "Read the technical documentation to learn the Traefik Routing Configuration with KV stores." +--- + # Traefik & KV Stores A Story of key & values diff --git a/docs/content/routing/providers/marathon.md b/docs/content/routing/providers/marathon.md index 5591981fb..a3b726cb6 100644 --- a/docs/content/routing/providers/marathon.md +++ b/docs/content/routing/providers/marathon.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Routing Configuration for Marathon" +description: "Traefik Proxy can be configured to use Marathon as a provider. Read the technical documentation to understand the Traefik routing configuration for Marathon." +--- + # Traefik & Marathon Traefik can be configured to use Marathon as a provider. diff --git a/docs/content/routing/providers/rancher.md b/docs/content/routing/providers/rancher.md index 1a5aa0444..2ac3b37e8 100644 --- a/docs/content/routing/providers/rancher.md +++ b/docs/content/routing/providers/rancher.md @@ -1,3 +1,8 @@ +--- +title: "Routing & Load Balancing Providers: Rancher" +description: "Traefik Proxy creates a corresponding service and router for each Rancher Service. Read the full documentation to learn more." +--- + # Traefik & Rancher A Story of Labels, Services & Containers diff --git a/docs/content/routing/routers/index.md b/docs/content/routing/routers/index.md index 4abc03a06..5c92fef0f 100644 --- a/docs/content/routing/routers/index.md +++ b/docs/content/routing/routers/index.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Routers Documentation" +description: "In Traefik Proxy, a router is in charge of connecting incoming requests to the Services that can handle them. Read the technical documentation." +--- + # Routers Connecting Requests to Services diff --git a/docs/content/routing/services/index.md b/docs/content/routing/services/index.md index 6b3d35701..168893297 100644 --- a/docs/content/routing/services/index.md +++ b/docs/content/routing/services/index.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Services Documentation" +description: "Learn how to configure routing and load balancing in Traefik Proxy to reach Services, which handle incoming requests. Read the technical documentation." +--- + # Services Configuring How to Reach the Services diff --git a/docs/content/user-guides/crd-acme/index.md b/docs/content/user-guides/crd-acme/index.md index 04e63807b..91079bbd7 100644 --- a/docs/content/user-guides/crd-acme/index.md +++ b/docs/content/user-guides/crd-acme/index.md @@ -1,3 +1,8 @@ +--- +title: "Traefik CRD TLS Documentation" +description: "Learn how to use Traefik Proxy w/ an IngressRoute Custom Resource Definition (CRD) for Kubernetes, and TLS with Let's Encrypt. Read the technical documentation." +--- + # Traefik & CRD & Let's Encrypt Traefik with an IngressRoute Custom Resource Definition for Kubernetes, and TLS Through Let's Encrypt. diff --git a/docs/content/user-guides/docker-compose/acme-dns/index.md b/docs/content/user-guides/docker-compose/acme-dns/index.md index 2383234c2..59872c44e 100644 --- a/docs/content/user-guides/docker-compose/acme-dns/index.md +++ b/docs/content/user-guides/docker-compose/acme-dns/index.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Docker DNS Challenge Documentation" +description: "Learn how to create a certificate with the Let's Encrypt DNS challenge to use HTTPS on a Service exposed with Traefik Proxy. Read the tehnical documentation." +--- + # Docker-compose with let's encrypt: DNS Challenge This guide aim to demonstrate how to create a certificate with the let's encrypt DNS challenge to use https on a simple service exposed with Traefik. diff --git a/docs/content/user-guides/docker-compose/acme-http/index.md b/docs/content/user-guides/docker-compose/acme-http/index.md index 8eb8864d7..7f8a05873 100644 --- a/docs/content/user-guides/docker-compose/acme-http/index.md +++ b/docs/content/user-guides/docker-compose/acme-http/index.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Docker HTTP Challenge Documentation" +description: "Learn how to create a certificate with the Let's Encrypt HTTP challenge to use HTTPS on a Service exposed with Traefik Proxy. Read the technical documentation." +--- + # Docker-compose with let's encrypt : HTTP Challenge This guide aim to demonstrate how to create a certificate with the let's encrypt HTTP challenge to use https on a simple service exposed with Traefik. @@ -80,4 +85,4 @@ command: labels: # Uses the Host rule to define which certificate to issue - "traefik.http.routers.whoami.tls.certresolver=myresolver" -``` \ No newline at end of file +``` diff --git a/docs/content/user-guides/docker-compose/acme-tls/index.md b/docs/content/user-guides/docker-compose/acme-tls/index.md index d7aaecf23..3457b6ae1 100644 --- a/docs/content/user-guides/docker-compose/acme-tls/index.md +++ b/docs/content/user-guides/docker-compose/acme-tls/index.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Docker TLS Challenge Documentation" +description: "Learn how to create a certificate with the Let's Encrypt TLS challenge to use HTTPS on a service exposed with Traefik Proxy. Read the technical documentation." +--- + # Docker-compose with let's encrypt: TLS Challenge This guide aim to demonstrate how to create a certificate with the let's encrypt TLS challenge to use https on a simple service exposed with Traefik. diff --git a/docs/content/user-guides/docker-compose/basic-example/index.md b/docs/content/user-guides/docker-compose/basic-example/index.md index aef9910e5..80f1a6a07 100644 --- a/docs/content/user-guides/docker-compose/basic-example/index.md +++ b/docs/content/user-guides/docker-compose/basic-example/index.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Docker Documentation" +description: "This guide covers a basic docker-compose file exposing a simple service using the docker provider in Traefik Proxy. Read the technical documentation." +--- + # Docker-compose basic example In this section we quickly go over a basic docker-compose file exposing a simple service using the docker provider. diff --git a/docs/content/user-guides/grpc.md b/docs/content/user-guides/grpc.md index e60b3ed19..488008381 100644 --- a/docs/content/user-guides/grpc.md +++ b/docs/content/user-guides/grpc.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Proxy gRPC Examples" +description: "This section of the Traefik Proxy documentation explains how to use Traefik as reverse proxy for gRPC applications." +--- + # gRPC Examples ## With HTTP (h2c) diff --git a/docs/content/user-guides/marathon.md b/docs/content/user-guides/marathon.md index bfd380048..2b374ca24 100644 --- a/docs/content/user-guides/marathon.md +++ b/docs/content/user-guides/marathon.md @@ -1,3 +1,8 @@ +--- +title: "Traefik Proxy and Marathon Integration Guide |Traefik Docs" +description: "This guide explains how to integrate Marathon and operate the cluster in a reliable way from the Traefik Proxy standpoint." +--- + # Marathon This guide explains how to integrate Marathon and operate the cluster in a reliable way from Traefik's standpoint. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index dbf93a009..35a7b017b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -42,6 +42,7 @@ plugins: # https://squidfunk.github.io/mkdocs-material/extensions/admonition/ # https://facelessuser.github.io/pymdown-extensions/ markdown_extensions: + - meta - attr_list - admonition - footnotes