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

Wrong configuration examples in documentation #60

Open
tlipinski opened this issue Aug 11, 2017 · 3 comments
Open

Wrong configuration examples in documentation #60

tlipinski opened this issue Aug 11, 2017 · 3 comments

Comments

@tlipinski
Copy link

Akka HTTP docs regarding HTTPS point to ssl-config documentation where example config is

ssl-config.ssl {
  trustManager = {
    ...
  }
}

The .ssl part is invalid and should not be there. I suspect it was mistakely ported from Play's documentation where config keys were like play.ws.ssl.trustManager. There are lot more bad config examples like this.
On the other hand paradox documentation shows the same example correctly:

ssl-config {
  trustManager = {
    ...
  }
}

This is really confusing so I think either this should be fixed or paradox documentation be publicly available instead of current one.

@ktoso
Copy link
Contributor

ktoso commented Aug 11, 2017

Thanks, could you PR a change to the docs and we'd release that?

@tlipinski
Copy link
Author

@ktoso I've found Sphinx source of http://typesafehub.github.io/ssl-config/index.html in gh-pages branch but are those sources still maintained?
It seems that release.sh script builds documentation using Paradox files from https://github.com/typesafehub/ssl-config/tree/master/documentation. These files are correct, but the thing is that ssl-config's README and Akka HTTP pages are still referencing to Shpinx based page which has invalid content. I believe fixing link in README and making it point to https://jonas.github.io/ssl-config would do the job. Is it correct?

@tlipinski
Copy link
Author

@ktoso I've fixed config keys in txt sources on gh-pages however I have trouble rebuilding html files with Sphinx (missing addons). #61. Would you be able to make use of these changes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants