зеркало из https://github.com/mozilla/kitsune.git
Fixes references
This commit is contained in:
Родитель
9bf78aadb7
Коммит
251162c73e
|
@ -60,8 +60,8 @@ Celery
|
|||
Installing
|
||||
----------
|
||||
|
||||
Celery (and Django-Celery) is part of our `vendor library <vendor.rst>`_. You
|
||||
shouldn't need to do any manual installation.
|
||||
Celery (and Django-Celery) is part of our :ref:`vendor library
|
||||
<vendor-chapter>`. You shouldn't need to do any manual installation.
|
||||
|
||||
|
||||
Configuring and Running
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _email-chapter:
|
||||
|
||||
==================
|
||||
Email from Kitsune
|
||||
==================
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _installation-chapter:
|
||||
|
||||
============
|
||||
Installation
|
||||
============
|
||||
|
@ -58,8 +60,8 @@ it's more like our production environment) you'll also need:
|
|||
|
||||
* ``mod_wsgi``
|
||||
|
||||
See the documentation on `WSGI <wsgi.rst>`_ for more information and
|
||||
instructions.
|
||||
See the documentation on :ref:`WSGI <wsgi-chapter>` for more
|
||||
information and instructions.
|
||||
|
||||
|
||||
Getting the Source
|
||||
|
@ -176,7 +178,7 @@ Finally, you'll probably want to create a superuser. Just use Django's
|
|||
And follow the prompts. After logging in, you can create a profile for the
|
||||
user by going to ``/users/edit`` in your browser.
|
||||
|
||||
See also the `important wiki documents <wikidocs.rst>`_ documentation.
|
||||
See also the :ref:`important wiki documents <wiki-chapter>` documentation.
|
||||
|
||||
|
||||
Product Details Initialization
|
||||
|
@ -254,11 +256,11 @@ Running the test suite is easy::
|
|||
|
||||
./manage.py test -s --noinput --logging-clear-handlers
|
||||
|
||||
For more information, see the `test documentation <tests.rst>`_.
|
||||
For more information, see the :ref:`test documentation <tests-chapter>`.
|
||||
|
||||
|
||||
Setting Up Search
|
||||
=================
|
||||
|
||||
See the `search documentation <search.rst>`_ for steps to get Sphinx search
|
||||
working.
|
||||
See the :ref:`search documentation <search-chapter>` for steps to get
|
||||
Sphinx search working.
|
||||
|
|
|
@ -14,7 +14,7 @@ fairly straight-forward workflow in git for submitting patches. This is
|
|||
outlined below.
|
||||
|
||||
You should run the tests before submitting a pull request. You can find help
|
||||
for getting set up in the `installation docs <installation.rst>`_.
|
||||
for getting set up in the :ref:`installation docs <installation-chapter>`.
|
||||
|
||||
If you ever find yourself stuck, come look for us in `#sumodev
|
||||
<ircs://irc.mozilla.org/sumodev>`_ on Mozilla's IRC network. We're happy to
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _search-chapter:
|
||||
|
||||
======
|
||||
Search
|
||||
======
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _tests-chapter:
|
||||
|
||||
======================
|
||||
The Kitsune Test Suite
|
||||
======================
|
||||
|
@ -10,8 +12,9 @@ behavior--and new code should come with tests.
|
|||
Running the Test Suite
|
||||
======================
|
||||
|
||||
If you followed the steps in `the installation docs <installation.rst>`_, then
|
||||
all you should need to do to run the test suite is::
|
||||
If you followed the steps in :ref:`the installation docs
|
||||
<installation-chapter>`, then all you should need to do to run the
|
||||
test suite is::
|
||||
|
||||
./manage.py test
|
||||
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _vendor-chapter:
|
||||
|
||||
==============
|
||||
Vendor Library
|
||||
==============
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _wiki-chapter:
|
||||
|
||||
========================
|
||||
Important Wiki Documents
|
||||
========================
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _wsgi-chapter:
|
||||
|
||||
=============================
|
||||
Running Kitsune with mod_wsgi
|
||||
=============================
|
||||
|
@ -6,7 +8,7 @@ Running Kitsune with mod_wsgi
|
|||
Requirements
|
||||
============
|
||||
|
||||
* See `the installation docs <installation.rst>`_.
|
||||
* See :ref:`the installation docs <installation-chapter>`.
|
||||
* `Apache HTTP server <http://httpd.apache.org/>`_
|
||||
* mod_rewrite
|
||||
* mod_headers
|
||||
|
@ -20,7 +22,7 @@ Overview
|
|||
|
||||
Setting up Kitsune to run as a WSGI application is fairly straightforward. You
|
||||
will need to install the requirements and clone the vendor repo as described in
|
||||
`installation.rst <installation.rst>`_.
|
||||
:ref:`the installation chapter <installation-chapter>`.
|
||||
|
||||
There are 3 steps once Kitsune is installed:
|
||||
|
||||
|
@ -85,10 +87,10 @@ Apache, reducing the load on Django.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Most of our ``settings.py`` is under version control, but can be overridden
|
||||
in a file called ``settings_local.py`` in the base of the app (the same
|
||||
place as ``settings.py``). You can see example settings in
|
||||
`docs/settings/settings_local.prod.py <settings/settings_local.prod.py>`_:
|
||||
Most of our ``settings.py`` is under version control, but can be
|
||||
overridden in a file called ``settings_local.py`` in the base of the
|
||||
app (the same place as ``settings.py``). You can see example settings
|
||||
in ``settings/settings_local.prod.py>``:
|
||||
|
||||
.. literalinclude:: settings/settings_local.prod.py
|
||||
|
||||
|
@ -146,11 +148,11 @@ to find stack traces):
|
|||
Apache Error Page
|
||||
-----------------
|
||||
|
||||
So you've got a really bad error and you aren't even seeing the Kitsune error
|
||||
page! This is usually caused by an uncaught exception during the WSGI
|
||||
application start-up. Our `WSGI script <../wsgi/kitsune.wsgi>`_ tries to run
|
||||
all the initial validation that the dev server runs, to catch these errors
|
||||
early.
|
||||
So you've got a really bad error and you aren't even seeing the
|
||||
Kitsune error page! This is usually caused by an uncaught exception
|
||||
during the WSGI application start-up. Our WSGI script, located in
|
||||
``wsgi/kitsune.wsgi``, tries to run all the initial validation that
|
||||
the dev server runs, to catch these errors early.
|
||||
|
||||
So where *is* the stack trace? You'll need to look in your Apache error logs.
|
||||
Where these are is OS-dependent, but a good place to look is
|
||||
|
@ -176,8 +178,8 @@ Error message. You can still get stack traces, though, by setting the
|
|||
('me', 'my@email.address'),
|
||||
)
|
||||
|
||||
Django will email you the stack trace. Provided you've set up `email
|
||||
<email.rst>`_.
|
||||
Django will email you the stack trace. Provided you've set up
|
||||
:ref:`email <email-chapter>`.
|
||||
|
||||
|
||||
Reloading WSGI
|
||||
|
|
Загрузка…
Ссылка в новой задаче