hc-dev mailing list archives

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

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

miles zarathustra commented on HTTPCLIENT-1201:

The menu on the LHS is pretty cryptic (and tiny).  Maybe I'm simple minded, but when I'm looking
for documentation I focus on the big section title that says "DOCUMENTATION."

When I go to http://hc.apache.org/httpcomponents-client-ga/ there is a big section called
"Documentation."  Nowhere in that section can I find basic POST and GET examples.   All you
need to do is add a link to the WIKI example from that section entitled "Documentation."

Most people will probably not care about the material in the tutorial.

The tutorial does not (that I can see) include a basic simple, complete example of a post
with parameters. Even in the fundamentals section. That should be the FIRST (or second) example,
since it is one of the most common operations.  

All I'm asking is that you put a link to a basic, complete example of both POST and GET at
the top of the Documentation section.  This should be a no-brainer that takes about 5 minutes.
What would it hurt to do this?

Once again, here is the basic example.

I request that you put this at the top, since it precedes most anything else you might want
to do.

Sorry for being repetitious, but I thought what I was saying would be obvious, and apparently
it's not.

  -= miles =-
> 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