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

Enhance documentation readability. #2095

Merged
merged 2 commits into from
Sep 11, 2017
Merged

Conversation

ldez
Copy link
Contributor

@ldez ldez commented Sep 9, 2017

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 force-pushed the refactor/doc-review branch 4 times, most recently from 6f20487 to 77c0c30 Compare September 11, 2017 01:45
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.

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

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

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

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 📚 👏

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

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.

5 participants