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

docs(tutorial): port the ASGI tutorial #1737

Merged
merged 38 commits into from
Dec 22, 2020
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
0c5f61e
docs(tutorial): start porting the ASGI tutorial (work-in-progress)
vytas7 Jul 5, 2020
daa6102
chore(tools): fix a PEP8 import order violation in check_copy_paste.py
vytas7 Jul 5, 2020
d522851
Merge branch 'master' into port-asgi-tutorial
vytas7 Aug 7, 2020
8a7f891
docs(tutorial): make further progress porting the ASGI tutorial
vytas7 Aug 13, 2020
02d1810
Merge branch 'master' into port-asgi-tutorial
vytas7 Aug 30, 2020
ab27063
Merge branch 'master' into port-asgi-tutorial
vytas7 Nov 16, 2020
4a01a7e
docs(ASGI tutorial): copy-paste the testing part
vytas7 Nov 21, 2020
0a7aa53
Merge branch 'master' into port-asgi-tutorial
vytas7 Nov 22, 2020
754523c
WiP: port tests and set up running them in our CI
vytas7 Nov 22, 2020
0920092
WiP: kindly ask Git not to ignore asgilook coverage config
vytas7 Nov 22, 2020
fda8554
Merge branch 'master' into port-asgi-tutorial
vytas7 Nov 29, 2020
e3078f8
Move Redis configuration to a more fitting place in the text.
vytas7 Nov 29, 2020
ce694cf
docs(asgilook): swap out the sadly unmaintained `birdisle` to `fakere…
vytas7 Nov 30, 2020
d9e6ad5
Merge branch 'master' into port-asgi-tutorial
vytas7 Nov 30, 2020
04af430
docs(asgilook): rework the storage path fixture injection
vytas7 Nov 30, 2020
d03895a
Merge branch 'port-asgi-tutorial' of github.com:vytas7/falcon into po…
vytas7 Nov 30, 2020
c6b89f3
Merge branch 'master' into port-asgi-tutorial
vytas7 Nov 30, 2020
f31cf62
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 6, 2020
d944fb4
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 12, 2020
46d2550
docs(tutorial): get ready for review...
vytas7 Dec 12, 2020
7765f91
docs(ASGI tutorial): address a portion of review comments
vytas7 Dec 12, 2020
2f976cf
Merge remote-tracking branch 'upstream/master' into port-asgi-tutorial
vytas7 Dec 12, 2020
a567a49
docs(asgilook): embrace pathlib.Path as per review suggestion
vytas7 Dec 13, 2020
7c38910
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 13, 2020
c7f797b
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 13, 2020
9ca311b
test(asgilook): assert that thumbnails are not corrupted by caching
vytas7 Dec 14, 2020
e6f00d3
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 14, 2020
0bd5ab7
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 16, 2020
003b750
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 16, 2020
dc81d00
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 17, 2020
58f65a2
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 18, 2020
d99a5e6
docs(tutorial): address a batch of kgriffs' comments
vytas7 Dec 18, 2020
fc120f2
docs(tutorial): write a couple of paragraphs on field converters
vytas7 Dec 19, 2020
58dc08e
docs(tutorial): add a paragraph on 404 & 405
vytas7 Dec 19, 2020
24f32ec
docs(tutorial): misc improvements
vytas7 Dec 19, 2020
3f56dd1
Merge branch 'master' into port-asgi-tutorial
vytas7 Dec 19, 2020
f21950c
docs(ASGI tutorial): clean up and flesh out the testing section
vytas7 Dec 19, 2020
7d347e3
docs(ASGI tutorial): clarify the possibility of matching a sink prefix
vytas7 Dec 19, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ jobs:
- "py38_smoke_cython"
- "docs"
- "look"
- "asgilook"
- "check_vendored"
- "twine_check"
- "daphne"
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ pip-log.txt
htmlcov
nosetests.xml

# ASGI tutorial
!examples/asgilook/.coveragerc

# Docs
docs/_build
dash
Expand Down
6 changes: 6 additions & 0 deletions docs/user/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,8 @@ same resource class:
app.add_route('/resources/{id}', resource)
app.add_route('/resources', resource, suffix='collection')

.. _recommended-route-layout:

What is the recommended way to map related routes to resource classes?
----------------------------------------------------------------------

Expand Down Expand Up @@ -908,6 +910,8 @@ Furthermore, the HTTP2 standard also mandates that header field names MUST be
converted to lowercase (see `RFC 7540, Section 8.1.2
<https://httpwg.org/specs/rfc7540.html#rfc.section.8.1.2>`_).

.. _faq_static_files:

Can Falcon serve static files?
------------------------------

Expand Down Expand Up @@ -971,6 +975,8 @@ use cases that may not be supported by your client library, simply encapsulate
the client library within a management class that handles all the tricky bits,
and pass that around instead.

.. _configuration-approaches:

What is the recommended approach for making configuration variables available to multiple resource classes?
-----------------------------------------------------------------------------------------------------------

Expand Down
1 change: 1 addition & 0 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ User Guide
install
quickstart
tutorial
tutorial-asgi
recipes/index
faq
Loading