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

Enhance documentation readability. #2095

Merged
merged 2 commits into from
Sep 11, 2017
Merged

Enhance documentation readability. #2095

merged 2 commits into from
Sep 11, 2017

Conversation

ldez
Copy link
Contributor

@ldez ldez commented Sep 9, 2017 •
edited
Loading

Description

  • extract code comments (in examples) as a real documentation paragraph.
  • fix heading in user guides
  • change readme menu style
  • justify all paragraphs
  • enhance readability (with breaks, paragraphs and tables)
  • use admonition
  • remove hard coded links to https://docs.traefik.io
  • explain auth and /ping ( Separate ping from dashboard? #2094)
  • Eureka default configuration
  • check all configuration options

Fixes #2097

@ldez ldez added this to the 1.4 milestone Sep 9, 2017
@ldez ldez requested review from a team as code owners September 9, 2017 11:40
@ldez ldez removed this from the 1.4 milestone Sep 9, 2017
@traefiker traefiker added this to the 1.4 milestone Sep 9, 2017
@ldez ldez force-pushed the refactor/doc-review branch 5 times, most recently from b95b883 to cb7d84e Compare September 10, 2017 11:46
@ldez ldez force-pushed the refactor/doc-review branch 4 times, most recently from 6f20487 to 77c0c30 Compare September 11, 2017 01:45
nmengin
nmengin requested changes Sep 11, 2017
View reviewed changes
Copy link
Contributor

@nmengin nmengin left a comment

Choose a reason for hiding this comment

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

What a awesome PR!!!
Just a problem with a broken link.

docs/user-guide/examples.md Outdated
DNS challenge needs environment variables to be executed. This variables have to be set on the machine/container which host Traefik.
DNS challenge needs environment variables to be executed.
This variables have to be set on the machine/container which host Traefik.

These variables has described [in this section](toml/#acme-lets-encrypt-configuration).
Copy link
Contributor

@nmengin nmengin Sep 11, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

The link in this section does not see to still working, replace it by configuration/acme/#dnsprovider

juliens
juliens approved these changes Sep 11, 2017
View reviewed changes
Copy link
Member

@juliens juliens left a comment

Choose a reason for hiding this comment

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

LGTM

nmengin
nmengin approved these changes Sep 11, 2017
View reviewed changes
Copy link
Contributor

@nmengin nmengin left a comment

Choose a reason for hiding this comment

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

LGTM 📚 👏

emilevauge
emilevauge approved these changes Sep 11, 2017
View reviewed changes
Copy link
Member

@emilevauge emilevauge left a comment

Choose a reason for hiding this comment

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

1vobbd

LGTM

@traefiker traefiker merged commit c7c9349 into traefik:v1.4 Sep 11, 2017
@traefiker traefiker mentioned this pull request Sep 11, 2017
Closed
@ldez ldez deleted the refactor/doc-review branch September 11, 2017 17:43
@timoreimann timoreimann mentioned this pull request Sep 19, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@juliens juliens juliens approved these changes

@emilevauge emilevauge emilevauge approved these changes

@nmengin nmengin nmengin approved these changes

@traefiker traefiker traefiker approved these changes

Assignees
No one assigned
Labels
area/acme area/documentation area/provider kind/enhancement a new or improved feature. size/L
Projects
None yet
Milestone
1.4
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@ldez @juliens @emilevauge @nmengin @traefiker