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.

Sign up for GitHub

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

Jump to bottom

docker-compose examples #4642

Merged
merged 3 commits into from Mar 22, 2019
Merged

docker-compose examples #4642

merged 3 commits into from Mar 22, 2019

Conversation

karnthis
Copy link
Contributor

What does this PR do?

I have updated all the occurrences of image: traefik to use the Alpha tag image: traefik:v2.0. I also corrected the command from --docker to --providers.docker. Lastly, I renamed Getting Started > Configuration Overview to Configuration Introduction. This is because there is also Configuration Discovery > Overview, and as both have a large identical image occupying the bulk of the opening page they are easy to confuse I feel. This last change is more of a proposal/suggestion.

Motivation

This PR came to life because I was discovering challenges with converting my Traefik v1 docker-compose files to v2. This turned out to be because the v2 Alpha docs appeared to still be using sample docker-compose code from v1.

CHANGES

  • Replaced all documentation occurrences of image: traefik (4) with image: traefik:v2.0
  • Replaced all documentation occurrences of --docker (1) with --providers.docker
  • Renamed page under Getting Started from Configuration Overview to Configuration Introduction for clarity

Additional Notes

I am very excited about the new changes, and I am looking forward to have time to dig in deeper, learn the changes, and maybe update some more documentation.

@karnthis
Copy link
Contributor Author

I think I tried to merge this into the wrong branch. I thought I was merging back into what I branched from but it looks like I did not.

@karnthis karnthis changed the base branch from master to v2.0 March 21, 2019 03:58
@karnthis
Copy link
Contributor Author

It looks like I forked from the release tag v2.0.0-alpha2, and because it is a tag not a branch I can't merge back to it. How should I proceed?

@ldez ldez added this to the 2.0 milestone Mar 21, 2019
ldez
ldez requested changes Mar 21, 2019
View reviewed changes
Copy link
Member

@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.

Thanks, could you rebase?

docs/content/getting-started/quick-start.md Outdated Show resolved Hide resolved
docs/content/providers/docker.md Outdated Show resolved Hide resolved
docs/content/routing/entrypoints.md Outdated Show resolved Hide resolved
docs/content/routing/entrypoints.md Outdated Show resolved Hide resolved
@karnthis
Copy link
Contributor Author

Thanks, could you rebase?

Could you clarify your requests? Removing Alpha is fine, but I do not understand why command: --api --docker should be removed.

My understanding is:

  • --docker is required for traefik to have access to the docker daemon.
  • --api is what enables the Traefik API, which is what the quick start uses to showcase operation.

@ldez
Copy link
Member

ldez commented Mar 21, 2019 •
edited

could you update your PR (rebase or merge like you want) to get changes from the v2.0 branch.

@ldez
Copy link
Member

ldez commented Mar 21, 2019 •
edited

Could you clarify your requests? Removing Alpha is fine, but I do not understand why command: --api --docker should be removed.

It's just the diff in Github 😄

https://github.com/containous/traefik/pull/4642/files

@karnthis
Copy link
Contributor Author

Ok great thanks for the clarification. I will rebase tonight and post again here.

@karnthis
Copy link
Contributor Author

Changes requested has been made. It looks like there is a conflict with the Quick Start sample code.

@ldez ldez added this to In review in v2 via automation Mar 22, 2019
ldez
ldez approved these changes Mar 22, 2019
View reviewed changes
Copy link
Member

@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.

LGTM

jbdoumenjou
jbdoumenjou approved these changes Mar 22, 2019
View reviewed changes
Copy link
Member

@jbdoumenjou jbdoumenjou left a comment

Choose a reason for hiding this comment

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

LGTM

geraldcroes
geraldcroes approved these changes Mar 22, 2019
View reviewed changes
Copy link
Contributor

@geraldcroes geraldcroes left a comment

Choose a reason for hiding this comment

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

🎈 LGTM 🎈
Thank you for your feedback!

SantoDE
SantoDE approved these changes Mar 22, 2019
View reviewed changes
Copy link
Collaborator

@SantoDE SantoDE left a comment

Choose a reason for hiding this comment

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

LGTM 👼

@traefiker traefiker merged commit 119d013 into traefik:v2.0 Mar 22, 2019
@ldez ldez moved this from In review to Done in v2 Mar 23, 2019
@ldez ldez changed the title Documentation Updates: docker-compose examples docker-compose examples Mar 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@geraldcroes geraldcroes geraldcroes approved these changes

@jbdoumenjou jbdoumenjou jbdoumenjou approved these changes

@SantoDE SantoDE SantoDE approved these changes

@ldez ldez ldez approved these changes

Assignees
No one assigned
Labels
area/documentation area/provider/docker size/L
Projects
No open projects
v2
Done
Milestone
2.0
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@karnthis @ldez @geraldcroes @jbdoumenjou @SantoDE @traefiker