doc: Link to wiki in a few locations, and move community section up (#982)

This commit is contained in:
Kurt Griffiths
2017-01-26 10:36:43 -07:00
committed by GitHub
parent cc834b7859
commit 21722fdfa5
3 changed files with 36 additions and 31 deletions

View File

@@ -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? <https://github.com/falconry/falcon/wiki/Who's-using-Falcon%3F>`_
You might also like to view our
`Add-on Catalog <https://github.com/falconry/falcon/wiki/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 <https://github.com/falconry/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 <https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md>`_,
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 <https://kiwiirc.com/client/irc.freenode.net/?#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 <https://github.com/falconry/falcon/blob/master/CODEOFCONDUCT.md>`_,
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 <https://kiwiirc.com/client/irc.freenode.net/?#falconframework>`_
on freenode, where everyone is always welcome to ask questions and share
ideas.
Contributing
------------

View File

@@ -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

View File

@@ -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 <http://ipython.org/>`_ 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 <https://github.com/falconry/falcon/wiki>`_ as a starting
point, but you may also wish to search PyPI for additional resources.