From 21722fdfa56127649dc80e172ddd54265cb46d5a Mon Sep 17 00:00:00 2001 From: Kurt Griffiths Date: Thu, 26 Jan 2017 10:36:43 -0700 Subject: [PATCH] doc: Link to wiki in a few locations, and move community section up (#982) --- README.rst | 46 +++++++++++++++++++++--------------------- docs/conf.py | 10 +++++---- docs/user/tutorial.rst | 11 ++++++---- 3 files changed, 36 insertions(+), 31 deletions(-) diff --git a/README.rst b/README.rst index 678f4a5..e20f831 100644 --- a/README.rst +++ b/README.rst @@ -76,9 +76,29 @@ If you are using the Falcon framework for a community or commercial project, please consider adding your information to our wiki under `Who's Using Falcon? `_ -You might also like to view our -`Add-on Catalog `_, -where you can find a list of add-ons maintained by the community. +Community +--------- + +A number of Falcon add-ons, templates, and complimentary packages are +available for use in your projects. We've listed several of these on the +`Falcon wiki `_ as a starting +point, but you may also wish to search PyPI for additional resources. + +The Falcon community maintains a discussion group that you can use to +share your ideas and ask questions about the framework. To join the +discussion, please visit https://groups.google.com/d/forum/falconframework. + +Per our +`Code of Conduct `_, +we expect everyone who participates in community discussions to act +professionally, and lead by example in encouraging constructive +discussions. Each individual in the community is responsible for +creating a positive, constructive, and productive culture. + +We also hang out in +`#falconframework `_ +on freenode, where everyone is always welcome to ask questions and share +ideas. Installation ------------ @@ -518,26 +538,6 @@ bodies. httpd = simple_server.make_server('127.0.0.1', 8000, app) httpd.serve_forever() - -Community ---------- - -The Falcon community maintains a discussion group that you can use to -share your ideas and ask questions about the framework. To join the -discussion, please visit https://groups.google.com/d/forum/falconframework. - -Per our -`Code of Conduct `_, -we expect everyone who participates in community discussions to act -professionally, and lead by example in encouraging constructive -discussions. Each individual in the community is responsible for -creating a positive, constructive, and productive culture. - -We also hang out in -`#falconframework `_ -on freenode, where everyone is always welcome to ask questions and share -ideas. - Contributing ------------ diff --git a/docs/conf.py b/docs/conf.py index 059a916..1c6b995 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,6 +12,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. +from collections import OrderedDict import sys import os @@ -154,10 +155,11 @@ html_theme_options = { 'github_banner': True, 'fixed_sidebar': False, 'show_powered_by': False, - 'extra_nav_links': { - 'Falcon Home': 'http://falconframework.org/', - 'Get Help': 'community/help.html', - }, + 'extra_nav_links': OrderedDict([ + ('Falcon Home', 'http://falconframework.org/'), + ('Falcon Wiki', 'https://github.com/falconry/falcon/wiki'), + ('Get Help', 'community/help.html'), + ]), } # The name for this set of Sphinx documents. If None, it defaults to diff --git a/docs/user/tutorial.rst b/docs/user/tutorial.rst index 4ede89a..63e4ec6 100644 --- a/docs/user/tutorial.rst +++ b/docs/user/tutorial.rst @@ -89,7 +89,7 @@ let's use something that you would actually deploy in production. $ pip install gunicorn $ gunicorn app:api - + Gunicorn has still limitation that is not working on Windows. If you are Windows user you can use Waitress server instead Gunicorn .. code:: bash @@ -659,7 +659,10 @@ such as `IPython `_ or Also, don't be shy about pulling up Falcon's source code on GitHub or in your favorite text editor. The team has tried to make the code as straightforward -and readable as possible; where other documentation may fall short, the code basically -"can't be wrong." - +and readable as possible; where other documentation may fall short, the code +basically "can't be wrong." +A number of Falcon add-ons, templates, and complimentary packages are +available for use in your projects. We've listed several of these on the +`Falcon wiki `_ as a starting +point, but you may also wish to search PyPI for additional resources.