<commit_before>**********
Build Trix
**********

.. seealso:: :ref:`vagrant_test_trix`.

    

What is Trix?
=============
Trix is a devilry application that gives students a voluntary "workbench" they
can use to keep track of their progress and coverage in a particular course or
topic. `Read more about Trix <https://github.com/devilry/trix>`_.


Build Trix for production deployment
====================================

Follow the :ref:`devilry deploy guide <deploy>`. When you have Devilry running successfully, follow the steps below.


Update buildout.cfg for Trix
----------------------------
Add the following to your ``buildout.cfg``::

    [buildout]
    ...
    eggs +=
        trix
        trix_simplified
        trix_restful
        trix_extjshelpers

    [devilrydeploy_sources]
    trix = git https://github.com/devilry/trix.git
    trix_simplified = git https://github.com/devilry/trix_simplified.git
    trix_restful = git https://github.com/devilry/trix_restful.git
    trix_extjshelpers = git https://github.com/devilry/trix_extjshelpers.git

You should already have a ``[buildout]``-section, so make sure you do not end
up with two of them.


.. warning:: Make sure you use ``eggs +=`` and NOT ``eggs =``.


Update ``devilry_prod_settings.py`` for Trix
--------------------------------------------
Add the following to your ``devilry_prod_settings.py``::


    INSTALLED_APPS += [
        'trix',
        'trix_extjshelpers',
        'trix_restful',
        'trix_simplified'
    ]

.. warning:: Make sure you use ``INSTALLED_APPS +=`` and NOT ``INSTALLED_APPS =``.


Add custom URLs for Trix
------------------------
Follow the :doc:`custom_root_urls`-guide, and add the following URL for Trix::

    url(r'^trix/', include('trix.urls')),


Update buildout<commit_msg>docs.trix: Completed the Trix guide.<commit_after>**********
Build Trix
**********

.. seealso:: :ref:`vagrant_test_trix`.

    

What is Trix?
=============
Trix is a devilry application that gives students a voluntary "workbench" they
can use to keep track of their progress and coverage in a particular course or
topic. `Read more about Trix <https://github.com/devilry/trix>`_.


Build Trix for production deployment
====================================

Follow the :ref:`devilry deploy guide <deploy>`. When you have Devilry running successfully, follow the steps below.


Update buildout.cfg for Trix
----------------------------
Add the following to your ``buildout.cfg``::

    [buildout]
    ...
    eggs +=
        trix
        trix_simplified
        trix_restful
        trix_extjshelpers

    [devilrydeploy_sources]
    trix = git https://github.com/devilry/trix.git
    trix_simplified = git https://github.com/devilry/trix_simplified.git
    trix_restful = git https://github.com/devilry/trix_restful.git
    trix_extjshelpers = git https://github.com/devilry/trix_extjshelpers.git

You should already have a ``[buildout]``-section, so make sure you do not end
up with two of them.

.. warning:: Make sure you use ``eggs +=`` and NOT ``eggs =``.

After updating the buildout config, your have to run::

    $ cd /path/to/direcetory/containing/buildout.cfg/
    $ bin/buildout



Update ``devilry_prod_settings.py`` for Trix
--------------------------------------------
Add the following to your ``devilry_prod_settings.py``::


    INSTALLED_APPS += [
        'trix',
        'trix_extjshelpers',
        'trix_restful',
        'trix_simplified'
    ]

.. warning:: Make sure you use ``INSTALLED_APPS +=`` and NOT ``INSTALLED_APPS =``.


Add custom URLs for Trix
------------------------
Follow the :doc:`custom_root_urls`-guide, and add the following URL for Trix::

    url(r'^trix/', include('trix.urls')),


Restart supervisord
-------------------
As explained in :doc:`deploy`.
{'fraction_non_alphanumeric': 0.18944591029023747, 'fraction_numerical': 0.0, 'mean_word_length': 2.791, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1307850', 'n_tokens_mistral': 1205, 'n_tokens_neox': 1148, 'n_words': 341}