[
https://issues.apache.org/jira/browse/HTTPCLIENT-1201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13399805#comment-13399805
]
miles zarathustra commented on HTTPCLIENT-1201:
-----------------------------------------------
Sorry it took so long to get to this, but I got a bit snowed under.
Highlights:
Added the TWIKI QuickStart to the top of the httpclient QuickStart page.
Rearranged the quick start list as a list of links.
The same identical list now appears under the 'documentation' section on
httpclient index (however you call it)
Changed the 'example' link to the 'quick start' link on a few of the other nav
sections. (eg. httpmime). I couldn't test this easily, since it built them in
separate locations and the link is to ../quickstart.html which doesn't exist in
the separated out part.
I hope this may help someone avoid the frustration I encountered.
I didn't touch the tutorial, but I have some ideas to make that section more
coherent without removing anything that's already there. The 'entity' section
would be a good place for the comment that the HTTP spec doesn't refer to POST
parameters. That's surprising, given that most http-monkey API's (e.g. PHP,
JSP) treat GET parameters and POST parameters as identically the same thing.
That impedance gap is worthy of some words on the subject, I think.
Hope this helps,
-= 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
> Attachments: site.patch
>
>
> 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: [email protected]
For additional commands, e-mail: [email protected]
