Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve error message and documentation on the needed link between router and service #10262

Open
wants to merge 6 commits into
base: v2.11
Choose a base branch
from

Conversation

mloiseleur
Copy link
Contributor

What does this PR do?

It improve the situation described in #10258 by:

  1. Provides only complete examples in the doc
  2. Improve wording in the doc on this matter
  3. Improve error message (with the router name when it's possible).

Motivation

Improve UserXP without breaking change, since many users faced it in the last four years. Detailed in #10258.

More

  • Added/updated documentation

Additional Notes

This PR aims to improve User XP with the current behavior of Docker provider.
Introducing a new Convention over configuration (aka magic) way for configuring Traefik Proxy is not the purpose of this PR.
=> This PR does not supersede #10252.
Thanks to @joshka and @bluepuma77 who can be credited for my motivation on this PR.

@traefiker traefiker added this to the 2.10 milestone Nov 24, 2023
@ldez ldez changed the title fix: improve error message and documentation on the needed link between router and service doc: improve error message and documentation on the needed link between router and service Nov 24, 2023
@ldez ldez self-requested a review November 24, 2023 12:41
Copy link
Contributor

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In 90% of the cases, an explicit service label is useless.

It's better to add one example of an explicit definition instead of modifying all the current examples.

docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/routing/providers/docker.md Outdated Show resolved Hide resolved
pkg/provider/configuration.go Outdated Show resolved Hide resolved
@mloiseleur
Copy link
Contributor Author

In 90% of the cases, an explicit service label is useless.

It's better to add one example of an explicit definition instead of modifying all the current examples.

@ldez @bluepuma77 @mmatur With ceed9c5, I tried to improve the wording and keep current "magic" example. I also added a complete example in service definition section.

@kevinpollet
Copy link
Member

Hello @mloiseleur,

Could you please rebase this pull request on branch v2.11?

@kevinpollet kevinpollet added this to the 2.11 milestone Jun 6, 2024
@mloiseleur mloiseleur changed the base branch from v2.10 to v2.11 June 6, 2024 13:40
@mloiseleur
Copy link
Contributor Author

Hello @kevinpollet ,

PR has been rebased.

@rtribotte rtribotte self-assigned this Jun 10, 2024
docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/routing/providers/docker.md Outdated Show resolved Hide resolved
docs/content/routing/providers/docker.md Outdated Show resolved Hide resolved
docs/content/routing/providers/docker.md Outdated Show resolved Hide resolved
pkg/provider/configuration.go Outdated Show resolved Hide resolved
@rtribotte rtribotte changed the title doc: improve error message and documentation on the needed link between router and service Improve error message and documentation on the needed link between router and service Jun 13, 2024
Copy link
Member

@rtribotte rtribotte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rtribotte rtribotte removed their assignment Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants