[Http] Request for comments
I just finished an initial version of the documentation and I'd like to receive your feedback on the library design. The documentation is available online at github[1] and it was generated using Quickbook/Boostbook. This initial version contains everything but the reference. The reference documentation is unavailable at the moment because I was unable to convert Doxygen output into Quickbook output smoothly. I'll do the conversion of current documented entities by hand and proceed to complete missing documentation shortly. I'll send another email when this extra piece is complete. Even with this lacking piece, I feel the current documentation is already useful and I might be able to receive useful feedback from interested ones. The latest version of the library itself is also available at github[2]. [1] http://vinipsmaker.github.io/asiohttpserver/ [2] https://github.com/BoostGSoC14/boost.http -- Vinícius dos Santos Oliveira https://about.me/vinipsmaker
On 21 Aug 2014 at 16:12, Vinícius dos Santos Oliveira wrote:
I just finished an initial version of the documentation and I'd like to receive your feedback on the library design. The documentation is available online at github[1] and it was generated using Quickbook/Boostbook.
Firstly, congratulations on a successful GSoC. My first thought when reading your docs is "what does using this library do for me?" I didn't discover the answer by the end of the docs. Niall -- ned Productions Limited Consulting http://www.nedproductions.biz/ http://ie.linkedin.com/in/nialldouglas/
2014-08-21 21:01 GMT-03:00 Niall Douglas
Firstly, congratulations on a successful GSoC.
Thanks. My first thought when reading your docs is "what does using this
library do for me?" I didn't discover the answer by the end of the docs.
Thank you for the time spent and the feedback. I guess I was so worried with rationales and any feature that could be minimally polemic that my docs end up being too abstract. I'll fix this gradually. For a quick start, I've added the following text on the "front page": This library boils down to providing HTTP producers (e.g. HTTP standalone
servers) and concepts to permit user-provided producers to collaborate (i.e. communicate) with any other written HTTP consumer. A few HTTP consumers (e.g. file server) are also provided to increase your productivity. It's fine to use this library to write a web chat application.
I'll evolve it as soon as I finish the current task, which is converting Doxygen -> QuickBook and I'm making progress[1]. I'd like to encourage people to try the library. It's cross-platform and very simple to build it[2]. [1] http://vinipsmaker.github.io/asiohttpserver/reference.html [2] http://vinipsmaker.github.io/asiohttpserver/using.html -- Vinícius dos Santos Oliveira https://about.me/vinipsmaker
On 22 Aug 2014 at 3:05, Vinícius dos Santos Oliveira wrote:
My first thought when reading your docs is "what does using this library do for me?" I didn't discover the answer by the end of the docs.
This library boils down to providing HTTP producers (e.g. HTTP standalone
servers) and concepts to permit user-provided producers to collaborate (i.e. communicate) with any other written HTTP consumer. A few HTTP consumers (e.g. file server) are also provided to increase your productivity. It's fine to use this library to write a web chat application.
You've not convinced me why I should use your library and not write some ad hoc code which would be "good enough". You've not convinced me why I should use your library and not an alternative, including one written in Python or PHP. At the front of your docs, you need to have me convinced by the end of page 2 that there is no better library than yours, including on other languages. Evidence such as an excellent literature review covering alternatives and benchmarks between your code and alternatives are steps in the right direction. Niall -- ned Productions Limited Consulting http://www.nedproductions.biz/ http://ie.linkedin.com/in/nialldouglas/
2014-08-22 9:24 GMT-03:00 Niall Douglas
You've not convinced me why I should use your library and not write some ad hoc code which would be "good enough".
You've not convinced me why I should use your library and not an alternative, including one written in Python or PHP.
At the front of your docs, you need to have me convinced by the end of page 2 that there is no better library than yours, including on other languages. Evidence such as an excellent literature review covering alternatives and benchmarks between your code and alternatives are steps in the right direction.
Sorry for taking 4 days to reply. I was finishing the reference section from the documentation. Now I feel that, except for your concern, documentation is in a pretty good shape. Bjorn Reese helped me to gather a few arguments while I was working on the rest of the documentation. I'll work on your concern now (including benchmarks). And thanks for the continued feedback. Your feedback only help me to make the project better and I appreciate that. -- Vinícius dos Santos Oliveira https://about.me/vinipsmaker
On 26 Aug 2014 at 4:20, Vinícius dos Santos Oliveira wrote:
Bjorn Reese helped me to gather a few arguments while I was working on the rest of the documentation. I'll work on your concern now (including benchmarks).
And thanks for the continued feedback. Your feedback only help me to make the project better and I appreciate that.
Glad I am useful. Some ideas for some worked examples and things to benchmark: * Implementing an ICAP filter for Squid. See http://wiki.squid-cache.org/Features/ICAP. Let's say it prepends to the <title> tag content something funny. * Bjorn has probably also mentioned this, but the world's simplest WebDAV server (https://en.wikipedia.org/wiki/WebDAV) serving a single read-only file called HelloWorld.txt would be great. Being able to mount your HTTP library as a Windows or Linux drive is simply cool. Niall -- ned Productions Limited Consulting http://www.nedproductions.biz/ http://ie.linkedin.com/in/nialldouglas/
participants (2)
-
Niall Douglas -
Vinícius dos Santos Oliveira