From 274cab4bb34a7115f27e5f93b38ac6330c993fd3 Mon Sep 17 00:00:00 2001 From: Romain Date: Wed, 23 Sep 2020 09:26:04 +0200 Subject: [PATCH] chore: apply new documentation style. Co-authored-by: jbdoumenjou --- .github/CODEOWNERS | 24 -------------- .travis.yml | 8 ----- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 2 +- README.md | 32 +++++++++---------- cmd/traefik/traefik.go | 4 +-- contrib/systemd/traefik.service | 2 +- docs/CNAME | 1 - docs/configuration/backends/docker.md | 2 +- docs/index.md | 2 +- examples/quickstart/README.md | 6 ++-- mkdocs.yml | 6 ++-- script/docs-verify-docker-image/validate.sh | 4 +-- .../components/header/header.component.html | 2 +- 14 files changed, 32 insertions(+), 65 deletions(-) delete mode 100644 .github/CODEOWNERS delete mode 100644 docs/CNAME diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index f6315449b..000000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,24 +0,0 @@ -provider/kubernetes/** @containous/kubernetes -provider/rancher/** @containous/rancher -provider/marathon/** @containous/marathon -provider/docker/** @containous/docker - -docs/user-guide/kubernetes.md @containous/kubernetes -docs/user-guide/marathon.md @containous/marathon -docs/user-guide/swarm.md @containous/docker -docs/user-guide/swarm-mode.md @containous/docker - -docs/configuration/backends/docker.md @containous/docker -docs/configuration/backends/kubernetes.md @containous/kubernetes -docs/configuration/backends/marathon.md @containous/marathon -docs/configuration/backends/rancher.md @containous/rancher - -examples/k8s/ @containous/kubernetes -examples/compose-k8s.yaml @containous/kubernetes -examples/k8s.namespace.yaml @containous/kubernetes -examples/compose-rancher.yml @containous/rancher -examples/compose-marathon.yml @containous/marathon - -vendor/github.com/gambol99/go-marathon @containous/marathon -vendor/github.com/rancher @containous/rancher -vendor/k8s.io/ @containous/kubernetes diff --git a/.travis.yml b/.travis.yml index 2a56f2491..471f14064 100644 --- a/.travis.yml +++ b/.travis.yml @@ -51,11 +51,3 @@ deploy: on: repo: traefik/traefik tags: true - - provider: pages - edge: false - github_token: ${GITHUB_TOKEN} - local_dir: site - skip_cleanup: true - on: - repo: traefik/traefik - all_branches: true diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 718bc13fa..83e87924f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at contact@containo.us +reported by contacting the project team at contact@traefik.io All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 419b85a54..4f41c3578 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -158,7 +158,7 @@ Integration tests must be run from the `integration/` directory and require the ## Documentation -The [documentation site](https://docs.traefik.io/v1.7/) is built with [mkdocs](https://mkdocs.org/) +The [documentation site](https://doc.traefik.io/traefik/v1.7/) is built with [mkdocs](https://mkdocs.org/) ### Building Documentation diff --git a/README.md b/README.md index aa147e52e..50b76776f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

[![Build Status SemaphoreCI](https://semaphoreci.com/api/v1/containous/traefik/branches/master/shields_badge.svg)](https://semaphoreci.com/containous/traefik) -[![Docs](https://img.shields.io/badge/docs-current-brightgreen.svg)](https://docs.traefik.io/v1.7) +[![Docs](https://img.shields.io/badge/docs-current-brightgreen.svg)](https://doc.traefik.io/traefik/v1.7) [![Go Report Card](https://goreportcard.com/badge/traefik/traefik)](http://goreportcard.com/report/traefik/traefik) [![](https://images.microbadger.com/badges/image/traefik.svg)](https://microbadger.com/images/traefik) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/traefik/traefik/blob/master/LICENSE.md) @@ -70,22 +70,22 @@ _(But if you'd rather configure some of your routes manually, Traefik supports t ## Supported Backends -- [Docker](https://docs.traefik.io/v1.7/configuration/backends/docker) / [Swarm mode](https://docs.traefik.io/v1.7/configuration/backends/docker#docker-swarm-mode) -- [Kubernetes](https://docs.traefik.io/v1.7/configuration/backends/kubernetes) -- [Mesos](https://docs.traefik.io/v1.7/configuration/backends/mesos) / [Marathon](https://docs.traefik.io/v1.7/configuration/backends/marathon) -- [Rancher](https://docs.traefik.io/v1.7/configuration/backends/rancher) (API, Metadata) -- [Azure Service Fabric](https://docs.traefik.io/v1.7/configuration/backends/servicefabric) -- [Consul Catalog](https://docs.traefik.io/v1.7/configuration/backends/consulcatalog) -- [Consul](https://docs.traefik.io/v1.7/configuration/backends/consul) / [Etcd](https://docs.traefik.io/v1.7/configuration/backends/etcd) / [Zookeeper](https://docs.traefik.io/v1.7/configuration/backends/zookeeper) / [BoltDB](https://docs.traefik.io/v1.7/configuration/backends/boltdb) -- [Eureka](https://docs.traefik.io/v1.7/configuration/backends/eureka) -- [Amazon ECS](https://docs.traefik.io/v1.7/configuration/backends/ecs) -- [Amazon DynamoDB](https://docs.traefik.io/v1.7/configuration/backends/dynamodb) -- [File](https://docs.traefik.io/v1.7/configuration/backends/file) -- [Rest](https://docs.traefik.io/v1.7/configuration/backends/rest) +- [Docker](https://doc.traefik.io/traefik/v1.7/configuration/backends/docker) / [Swarm mode](https://doc.traefik.io/traefik/v1.7/configuration/backends/docker#docker-swarm-mode) +- [Kubernetes](https://doc.traefik.io/traefik/v1.7/configuration/backends/kubernetes) +- [Mesos](https://doc.traefik.io/traefik/v1.7/configuration/backends/mesos) / [Marathon](https://doc.traefik.io/traefik/v1.7/configuration/backends/marathon) +- [Rancher](https://doc.traefik.io/traefik/v1.7/configuration/backends/rancher) (API, Metadata) +- [Azure Service Fabric](https://doc.traefik.io/traefik/v1.7/configuration/backends/servicefabric) +- [Consul Catalog](https://doc.traefik.io/traefik/v1.7/configuration/backends/consulcatalog) +- [Consul](https://doc.traefik.io/traefik/v1.7/configuration/backends/consul) / [Etcd](https://doc.traefik.io/traefik/v1.7/configuration/backends/etcd) / [Zookeeper](https://doc.traefik.io/traefik/v1.7/configuration/backends/zookeeper) / [BoltDB](https://doc.traefik.io/traefik/v1.7/configuration/backends/boltdb) +- [Eureka](https://doc.traefik.io/traefik/v1.7/configuration/backends/eureka) +- [Amazon ECS](https://doc.traefik.io/traefik/v1.7/configuration/backends/ecs) +- [Amazon DynamoDB](https://doc.traefik.io/traefik/v1.7/configuration/backends/dynamodb) +- [File](https://doc.traefik.io/traefik/v1.7/configuration/backends/file) +- [Rest](https://doc.traefik.io/traefik/v1.7/configuration/backends/rest) ## Quickstart -To get your hands on Traefik, you can use the [5-Minute Quickstart](http://docs.traefik.io/v1.7/#the-traefik-quickstart-using-docker) in our documentation (you will need Docker). +To get your hands on Traefik, you can use the [5-Minute Quickstart](http://doc.traefik.io/traefik/v1.7/#the-traefik-quickstart-using-docker) in our documentation (you will need Docker). Alternatively, if you don't want to install anything on your computer, you can try Traefik online in this great [Katacoda tutorial](https://www.katacoda.com/courses/traefik/deploy-load-balancer) that shows how to load balance requests between multiple Docker containers. @@ -100,7 +100,7 @@ You can access the simple HTML frontend of Traefik. ## Documentation -You can find the complete documentation at [https://docs.traefik.io/v1.7](https://docs.traefik.io/v1.7). +You can find the complete documentation at [https://doc.traefik.io/traefik/v1.7](https://doc.traefik.io/traefik/v1.7). A collection of contributions around Traefik can be found at [https://awesome.traefik.io](https://awesome.traefik.io). ## Support @@ -109,7 +109,7 @@ To get community support, you can: - join the Traefik community Slack channel: [![Join the chat at https://slack.traefik.io](https://img.shields.io/badge/style-register-green.svg?style=social&label=Slack)](https://slack.traefik.io) - use [Stack Overflow](https://stackoverflow.com/questions/tagged/traefik) (using the `traefik` tag) -If you need commercial support, please contact [Containo.us](https://containo.us) by mail: . +If you need commercial support, please contact [Traefik.io](https://traefik.io) by mail: . ## Download diff --git a/cmd/traefik/traefik.go b/cmd/traefik/traefik.go index 2f1975d76..46f5d14cb 100644 --- a/cmd/traefik/traefik.go +++ b/cmd/traefik/traefik.go @@ -352,14 +352,14 @@ func stats(globalConfiguration *configuration.GlobalConfiguration) { Stats collection is enabled. Many thanks for contributing to Traefik's improvement by allowing us to receive anonymous information from your configuration. Help us improve Traefik by leaving this feature on :) -More details on: https://docs.traefik.io/v1.7/basics/#collected-data +More details on: https://doc.traefik.io/traefik/v1.7/basics/#collected-data `) collect(globalConfiguration) } else { log.Info(` Stats collection is disabled. Help us improve Traefik by turning this feature on :) -More details on: https://docs.traefik.io/v1.7/basics/#collected-data +More details on: https://doc.traefik.io/traefik/v1.7/basics/#collected-data `) } } diff --git a/contrib/systemd/traefik.service b/contrib/systemd/traefik.service index 3cf42efb6..9768c9fe3 100644 --- a/contrib/systemd/traefik.service +++ b/contrib/systemd/traefik.service @@ -1,6 +1,6 @@ [Unit] Description=Traefik -Documentation=https://docs.traefik.io/v1.7 +Documentation=https://doc.traefik.io/traefik/v1.7 #After=network-online.target #AssertFileIsExecutable=/usr/bin/traefik #AssertPathExists=/etc/traefik/traefik.toml diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index f4446d431..000000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -docs.traefik.io \ No newline at end of file diff --git a/docs/configuration/backends/docker.md b/docs/configuration/backends/docker.md index 0c94694c3..2dfc96640 100644 --- a/docs/configuration/backends/docker.md +++ b/docs/configuration/backends/docker.md @@ -217,7 +217,7 @@ More information about Docker's security: !!! note "Improved Security" - [TraefikEE](https://containo.us/traefikee) solves this problem by separating the control plane (connected to Docker) and the data plane (handling the requests). + [Traefik Enterprise](https://traefik.io/traefik-enterprise/) solves this problem by separating the control plane (connected to Docker) and the data plane (handling the requests). Another possible workaround is to expose the Docker socket over TCP, instead of the default Unix socket file. It allows different implementation levels of the [AAA (Authentication, Authorization, Accounting) concepts](https://en.wikipedia.org/wiki/AAA_(computer_security)), depending on your security assessment: diff --git a/docs/index.md b/docs/index.md index f4928a9f0..9b726bfdc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ [![Docs](https://img.shields.io/badge/docs-current-brightgreen.svg)](/) [![Go Report Card](https://goreportcard.com/badge/github.com/traefik/traefik)](https://goreportcard.com/report/github.com/traefik/traefik) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/traefik/traefik/blob/master/LICENSE.md) -[![Join the community support forum at https://community.containo.us/](https://img.shields.io/badge/style-register-green.svg?style=social&label=Discourse)](https://community.containo.us/) +[![Join the community support forum at https://community.traefik.io/](https://img.shields.io/badge/style-register-green.svg?style=social&label=Discourse)](https://community.traefik.io/) [![Twitter](https://img.shields.io/twitter/follow/traefik.svg?style=social)](https://twitter.com/intent/follow?screen_name=traefik) diff --git a/examples/quickstart/README.md b/examples/quickstart/README.md index a6dbaf52a..0fe190656 100644 --- a/examples/quickstart/README.md +++ b/examples/quickstart/README.md @@ -101,7 +101,7 @@ IP: 172.27.0.4 ### 4 — Enjoy Traefik's Magic -Now that you have a basic understanding of how Traefik can automatically create the routes to your services and load balance them, it might be time to dive into [the documentation](https://docs.traefik.io/v1.7/) and let Traefik work for you! -Whatever your infrastructure is, there is probably [an available Traefik backend](https://docs.traefik.io/v1.7/#supported-backends) that will do the job. +Now that you have a basic understanding of how Traefik can automatically create the routes to your services and load balance them, it might be time to dive into [the documentation](https://doc.traefik.io/traefik/v1.7/) and let Traefik work for you! +Whatever your infrastructure is, there is probably [an available Traefik backend](https://doc.traefik.io/traefik/v1.7/#supported-backends) that will do the job. -Our recommendation would be to see for yourself how simple it is to enable HTTPS with [Traefik's let's encrypt integration](https://docs.traefik.io/v1.7/user-guide/examples/#lets-encrypt-support) using the dedicated [user guide](https://docs.traefik.io/v1.7/user-guide/docker-and-lets-encrypt/). +Our recommendation would be to see for yourself how simple it is to enable HTTPS with [Traefik's let's encrypt integration](https://doc.traefik.io/traefik/v1.7/user-guide/examples/#lets-encrypt-support) using the dedicated [user guide](https://doc.traefik.io/traefik/v1.7/user-guide/docker-and-lets-encrypt/). diff --git a/mkdocs.yml b/mkdocs.yml index 2b44db720..008c3ea0e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: Traefik site_description: Traefik Documentation -site_author: containo.us -site_url: https://docs.traefik.io +site_author: traefik.io +site_url: https://doc.traefik.io/traefik dev_addr: 0.0.0.0:8000 repo_name: 'GitHub' @@ -31,7 +31,7 @@ copyright: "Copyright © 2016-2019 Containous; 2020 Traefik Labs" # only to force the use of the analytics partials google_analytics: - 'UA-51880359-3' - - 'docs.traefik.io' + - 'doc.traefik.io' # Options # Comment because the call of the CDN is very slow. diff --git a/script/docs-verify-docker-image/validate.sh b/script/docs-verify-docker-image/validate.sh index 2a2d98da6..97d80a125 100644 --- a/script/docs-verify-docker-image/validate.sh +++ b/script/docs-verify-docker-image/validate.sh @@ -19,9 +19,9 @@ find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \ htmlproofer \ --check-html \ --check_external_hash \ - --alt_ignore="/traefik.logo.png/" \ + --alt_ignore="/traefikproxy-vertical-logo-color.svg/" \ --http_status_ignore="0,500,501,503" \ - --url-ignore "/https://groups.google.com/a/traefik.io/forum/#!forum/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/github.com\/containous\/traefik\/*edit*/,/github.com\/containous\/traefik\/,/github.com\/traefik\/traefik\/*edit*/,/github.com\/traefik\/traefik\/$/" \ + --url-ignore "/https://groups.google.com/a/traefik.io/forum/#!forum/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/doc.traefik.io\/traefik/,/traefik.io/,/github.com\/traefik\/traefik\/*edit*/,/github.com\/traefik\/traefik\/$/" \ '{}' ## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration diff --git a/webui/src/app/components/header/header.component.html b/webui/src/app/components/header/header.component.html index 7311c71a8..8e7610858 100644 --- a/webui/src/app/components/header/header.component.html +++ b/webui/src/app/components/header/header.component.html @@ -25,7 +25,7 @@ {{ version }} / {{ codename }} - + Documentation