Absence of detailed walk through other than readme and non-functional guidelinks

armor009 commented 4 years ago

Please help. New user here

There is no detailed walkthrough beyond the readme

The below guidelinks are non-functional.

https://jfarcand.wordpress.com/2010/12/21/going-asynchronous-using-asynchttpclient-the-basic/
https://jfarcand.wordpress.com/2011/01/04/going-asynchronous-using-asynchttpclient-the-complex/
https://jfarcand.wordpress.com/2011/12/21/writing-websocket-clients-using-asynchttpclient/

TomGranot commented 4 years ago

@mayank-mundhra-2012 I've opened a PR to remedy this:

https://github.com/AsyncHttpClient/async-http-client/pull/1738

It has archived links to these resources:

I applied for maintainership of the repo (waiting for a talk with @slandelle, who's head over heels releasing the very awesome Gatling Academy), and one of the first points I want to address is a proper guide of exactly what's going on in the repo, as well as a few other niceties that a repo as useful as this should have.

What could be quite helpful is a paragraph or two of what a good walkthrough will look like from your perspective.

It would be helpful to know if you (and other folks) are looking for a more contributor-oriented walkthrough that ensures you can get up and running quickly with a local dev environment, or for a more a product-oriented one where we talk about great use cases and give code samples for various fun stuff you can do with the library?

armor009 commented 4 years ago

A product oriented walkthrough would be great,

Thank you in advance.

TomGranot commented 4 years ago

@mayank-mundhra-2012 So the guidelinks have been fixed - see https://github.com/AsyncHttpClient/async-http-client/pull/1738. :)

TomGranot commented 3 years ago

@mayank-mundhra-2012 Just to update, the current (immediae) roadmap for the repo is as follows:

Migrate CI from Travis --> GitHub Actions, since Travis is phasing out open source credits
Clean up all issues & PRs
Docs - I think the first thing I intend to write is this exact walkthrough.

armor009 commented 3 years ago

Thank you :)

On Sun, Dec 13, 2020 at 4:01 PM Tom Granot notifications@github.com wrote:

@mayank-mundhra-2012 https://github.com/mayank-mundhra-2012 Just to update, the current (immediae) roadmap for the repo is as follows:

Migrate CI from Travis --> GitHub Actions, since Travis is phasing out open source credits

Clean up all issues & PRs

Docs - I think the first thing I intend to write is this exact walkthrough.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/AsyncHttpClient/async-http-client/issues/1741#issuecomment-743985223, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB2AE7A4HVASZEPTPEAAVGLSUSJXXANCNFSM4TA7VL2A .

TomGranot commented 3 years ago

@mayank-mundhra-2012 Can confirm I finished a (very rough) first draft here: https://github.com/AsyncHttpClient/async-http-client/pull/1768

Please note that there are still a lot of TODOs left. It's a start:)

AsyncHttpClient / async-http-client

Absence of detailed walk through other than readme and non-functional guidelinks #1741