hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Eric Hubert (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HTTPCLIENT-1201) provide basic documentation in an obvious place
Date Fri, 01 Jun 2012 21:39:23 GMT

    [ https://issues.apache.org/jira/browse/HTTPCLIENT-1201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13287696#comment-13287696

Eric Hubert commented on HTTPCLIENT-1201:

I'm very much impressed how kind and polite the replies of all the voluntary http client developers
and maintainers are, who invest remarkable effort and time in not only providing an excellent
library free of charge, giving great user support but also providing concise and correct documentation,
almost independent of the way end users present their personal feedback (including most inappropriate
phrases like "esoteric arcane junk"). 
I for one do like the very structured tutorial starting from the very basics (fundamentals)
including some of the required http background knowledge ensuring that end users do not run
into common pitfalls and misconceptions and do not end up using some sample code fragments
which may work perfectly fine, but which they do not understand at all. It of course also
covers more advanced topics which not everyone (maybe including you) might need.

As Oleg already pointed out, one of the first things the tutorial explains in the fundamentals
chapter is the production of entity content including submission of html forms with parameters
(1.1.7). It is quite easy to find. Equally easy as the use of the fluent API (additional module)
which may also be a viable choice for simple use cases. 
So you may want to have a look at: http://hc.apache.org/httpcomponents-client-ga/tutorial/html/fluent.html#d5e1259
as well also containing sample code to submit an html form which you may even like more (depending
on your actual use case).

I tend to agree that the http client project may not provide the kind of quickstart information
some type of developers may look for at first, but I have to strongly disagree with your comments
about the usefulness and quality of the tutorial. HttpComponent guys, please keep up your
good work and friendly nature as well!

Just wanted to let all of you know that there are quite different users and views out there.
> provide basic documentation in an obvious place
> -----------------------------------------------
>                 Key: HTTPCLIENT-1201
>                 URL: https://issues.apache.org/jira/browse/HTTPCLIENT-1201
>             Project: HttpComponents HttpClient
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 4.2 Final
>            Reporter: miles zarathustra
> The only documentation obviously linked from the main HttpClient page is the "tutorial."
 This "tutorial" talks about a lot of esoteric arcane junk I don't care about, but gives no
clue on how to send parameters via a basic post.  For that, I have to go here: 
> http://wiki.apache.org/HttpComponents/QuickStart
> It's very difficult to find, and it's a lot easier to google examples that don't work.
 I wound up trying 4 different purported solutions before I found this one that works. If
you look around the web you'll notice that people generally find the httpclient documentation
frustrating.  I have colleagues who argue that it would be easier to just write the post logic
from scratch than figure out how the silly apache stuff works, and it's difficult for me to
contradict them.
> It would be SO easy to improve the situation by making links to already available examples
of the basic operations in an obvious place.
> The FAQ that explains some things about WHY the posts work in the totally non-intuitive
way that they do would be nice also.
> Thanks.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org

View raw message