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

Add example projects page #3367

Closed
wants to merge 3 commits into from
Closed

Add example projects page #3367

wants to merge 3 commits into from

Conversation

jettify
Copy link
Member

@jettify jettify commented Oct 27, 2018

What do these changes do?

As discussed in aio-libs/aiohttp-demos#32 I am adding page with list of example projects to Misc subsection.

Are there changes in behavior for the user?

Related issue number

aio-libs/aiohttp-demos#32

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@jettify jettify added the documentation Improvements or additions to documentation label Oct 27, 2018
- `polls <https://github.com/aio-libs/aiohttp-demos/tree/master/demos/chat>`_
Simple *polls* application with PostgreSQL storage.

- `Blog <https://github.com/aio-libs/aiohttp-demos/tree/master/demos/chat>`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This thing is titlecased, which others ain't. Maybe it's worth keeping the same style

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

.. _aiohttp-examples:

================
Example Projects
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Demo projects maybe?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

@codecov-io
Copy link

Codecov Report

Merging #3367 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3367      +/-   ##
==========================================
- Coverage   97.93%   97.93%   -0.01%     
==========================================
  Files          44       44              
  Lines        8482     8517      +35     
  Branches     1378     1394      +16     
==========================================
+ Hits         8307     8341      +34     
  Misses         75       75              
- Partials      100      101       +1
Impacted Files Coverage Δ
aiohttp/formdata.py 98.38% <0%> (-0.49%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3ccf93c...9b87f49. Read the comment docs.

@asvetlov
Copy link
Member

I think better to keep the list in aiohttp-demos documentation and add a link to demos page into aiohttp docs.

@jettify
Copy link
Member Author

jettify commented Oct 27, 2018

Ok, not sure about the place where to put it, we already have a link in README.

@jettify jettify closed this Oct 27, 2018
@jettify jettify deleted the add-example-projects-page branch October 27, 2018 21:52
.. _aiohttp-examples:

================
Example Projects
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

- `chat <https://github.com/aio-libs/aiohttp-demos/tree/master/demos/chat>`_
Simple chat using websockets.

- `polls <https://github.com/aio-libs/aiohttp-demos/tree/master/demos/chat>`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replace link to https://github.com/aio-libs/aiohttp-demos/tree/master/demos/polls

- `polls <https://github.com/aio-libs/aiohttp-demos/tree/master/demos/chat>`_
Simple *polls* application with PostgreSQL storage.

- `blog <https://github.com/aio-libs/aiohttp-demos/tree/master/demos/chat>`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/aio-libs/aiohttp-demos/tree/master/demos/blog

@asvetlov
Copy link
Member

What's about https://demos.aiohttp.org/en/latest/ ?

@Arfey
Copy link
Member

Arfey commented Oct 27, 2018

@asvetlov 10 min 😀

@lock
Copy link

lock bot commented Oct 28, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a [new issue] for related bugs.
If you feel like there's important points made in this discussion, please include those exceprts into that [new issue].
[new issue]: https://github.com/aio-libs/aiohttp/issues/new

@lock lock bot added the outdated label Oct 28, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Oct 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation outdated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants