ssl-config icon indicating copy to clipboard operation
ssl-config copied to clipboard

Wrong configuration examples in documentation

Open tlipinski opened this issue 8 years ago • 3 comments

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.

tlipinski avatar Aug 11 '17 14:08 tlipinski

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

ktoso avatar Aug 11 '17 14:08 ktoso

@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 avatar Aug 11 '17 18:08 tlipinski

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

tlipinski avatar Aug 16 '17 11:08 tlipinski