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

miles zarathustra commented on HTTPCLIENT-1201:
-----------------------------------------------

On another point: I am fine with putting the example I submitted in the 
'examples' section, but I do not have permission to add files to the 
repository, and the patches (when I run svn diff) do not show them.  

I do believe that at least one full example should be linked from the quick 
start page.  If you disagree with how I am handling exceptions, please feel 
free to correct it.

I can create a preamble for the examples page, once the file is in the 
repository.  (I haven't looked since your last update, as I have been busy with 
other stuff)

Thanks,
  -= 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
>            Priority: Minor
>             Fix For: 4.2.1
>
>         Attachments: GetPostExample.java, site-1.patch, 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]

Reply via email to