Falcon: [Umbrella] Better Docs!

[kgriffs]

• More Tutorials/Guides/Recipes
  
  
  
  • Integration guide for SQLAlchemy, perhaps also marshmallow?
  
  
  • https://github.com/wileykestner/falcon-sqlalchemy-demo
  
  
  • https://gitlab.com/skosh/falcon-helpers/blob/master/falcon_helpers/sqla/db.py
  
  
  • https://gitlab.com/skosh/falcon-helpers/blob/master/falcon_helpers/middlewares/sqla.py
  
  
  • https://github.com/vytas7/falcon-sqla :arrow_left: could be moved under the Falconry umbrella once docs have been improved
  
  
  • Integration guide for 2-3 popular configuration frameworks
  
  
  • Integration guide for templating libraries?
  
  
  • Lifecycle management
  
  
  • implementing close() when assigning to resp.stream
  
  
  • Logging: logging requests/responses, error logging, contextual logging of other information
  
  
  • ASGI tutorial to highlight features Done! https://falcon.readthedocs.io/en/latest/user/tutorial-asgi.html
  
  
• Fast prototyping / evaluation
  
  
  
  • Read-made docker containers, orchestration templates, and/or cloud images
  
  
  • Recipes (combine with above idea for containers/templates, and/or command-line skeleton app generator
  
  
• Additional Deployment guides / production concerns (e.g., integration with prometheus)
  
  
  
  • https://github.com/jmvrbanac/falcon-example
  
  
• Best practices summary for best performance
  
  
  
  • (Some of these may also go in the deployment guides)
  
  
  • PyPy
  
  
  • Using an alternative JSON library, or even MessagePack
  
  
• Better description of benchmarks (and better benchmarks to begin with)
• Tutorial or guide for how to write Cython in your app to use with Falcon
• Guide to using CFFI for native extensions in C/Rust
• What else?

[vytas7]

Maybe ready-made Docker containers, orchestration templates, cloud images, VM appliances to allow people evaluating / prototyping even quicker?

Where the said ready-made containers would illustrate some of the points above.

[kgriffs]

(See also: https://github.com/falconry/falcon/issues/1391)

[kgriffs]

Maybe ready-made Docker containers, orchestration templates, cloud images, VM appliances to allow people evaluating / prototyping even quicker?

Thanks! Added to the list.

[bhargavrpatel]

@kgriffs I have been using Falcon at work in Production and love it! I was currently working on a library and stumbled upon the Issues page, and eventually here. Please let me know how I can contribute. Since the list is large, should we go ahead and start taski-fying these?

[kgriffs]

@bhargavrpatel Welcome! For now we are still brainstorming a bit while we finalize the 2.0 release and wait for development to open on the 3.0 branch. That being said, I think we can start breaking down these ideas into issues soon and sussing out what should go in 3.0 vs. 3.1.

[vytas7]

As mentioned by @amitvadhel on Gitter, another popular way to quickstart development that people turn to is Cookiecutter [1].

There is a Falcon recipe to it [2], but it is fairly outdated, we could consider submitting a new one (idea falls under _Fast prototyping_).

1. https://github.com/audreyr/cookiecutter
2. https://github.com/dgarana/cookiecutter-falcon