Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
armor009 opened this issue Oct 27, 2020 · 6 comments
Assignees

Comments

@armor009
Copy link

armor009 commented Oct 27, 2020

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/
@armor009 armor009 changed the title Absence of detailed walk through and non-functional guidelinks Absence of detailed walk through other than readme and non-functional guidelinks Oct 27, 2020
@TomGranot
Copy link
Contributor

TomGranot commented Oct 28, 2020

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

#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
Copy link
Author

armor009 commented Nov 5, 2020

A product oriented walkthrough would be great,

Thank you in advance.

@TomGranot
Copy link
Contributor

@mayank-mundhra-2012 So the guidelinks have been fixed - see #1738. :)

@TomGranot
Copy link
Contributor

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

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

@armor009
Copy link
Author

armor009 commented Dec 15, 2020 via email

@TomGranot
Copy link
Contributor

@mayank-mundhra-2012 Can confirm I finished a (very rough) first draft here:
#1768

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants