Skip to content
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

Document existing demos #32

Open
asvetlov opened this issue May 18, 2018 · 4 comments
Open

Document existing demos #32

asvetlov opened this issue May 18, 2018 · 4 comments

Comments

@asvetlov
Copy link
Member

We have 4 demos now but only polls is documented.
It would be nice to have something for others too.

I think new docs should not be as comprehensive as polls, no need to describe boring chapters about preparation and folder structure again and again.
Perhaps a page for demo should be enough.

Mentioning all existing demos in docs increase their visibility and teaching effect.

We need volunteers for the task. Sorry, I personally too busy by aiohttp itself.

@gyermolenko
Copy link
Contributor

Regarding docs themselves: definitely good to have.
Just to mention: polls is intended as aiohttp tutorial. Others can choose much simpler style.

p.s. There is work to be done to make all demos consistent (async factories returning app only; at least a smoke test for each, for deprecation or syntax errors; same configuration principles maybe).

@webknjaz webknjaz added the Hacktoberfest This looks easy to do during Hacktoberfest label Oct 6, 2018
@asvetlov
Copy link
Member Author

I suspect until new demos are mentioned in https://demos.aiohttp.org/en/latest/ somehow they don't exist for the most part of aiohttp users.
People just cannot understand where and what to search.
@jettify @gyermolenko could you put your energy on it?

I think a simple catalog of existing examples is enough. Every project has own README, we can reuse it.

@Arfey
Copy link
Member

Arfey commented Oct 27, 2018

As example, we can do it like this https://reactjs.org/community/examples.html
List of name - short description. (without structure of project, only link to GitHub)

@asvetlov
Copy link
Member Author

Looks good

@gyermolenko gyermolenko removed the Hacktoberfest This looks easy to do during Hacktoberfest label Oct 31, 2018
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

4 participants