Skip to content

Commit

Permalink
Merge pull request #33 from rdhyee/addons_update
Browse files Browse the repository at this point in the history
added CONFIGS and OWNERS to mandatory settings for addons
  • Loading branch information
icereval committed Nov 17, 2015
2 parents 6a37cd2 + 8f266ee commit 14be0cb
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/osf/addons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,24 @@ Bare minimums

- A list of categories this add-on should be displayed under when
the user is “browsing” add-ons

- SHOULD be one of ``documentation``, ``storage``, ``citations``, ``security``, ``bibliography``, and ``other``

- Additional categories can be added to ``ADDON_CATEGORIES`` in ``website.settings.defaults``

- ``INCLUDE_JS`` and ``INCLUDE_CSS``

- Deprecated field, define as empty dict (``{}``)

- ``OWNERS`` (list of strings)

- Valid options are ``user`` and ``node``

- ``CONFIGS`` (list of strings)

- Valid options are ``accounts`` and ``node``


Optional Fields
***************

Expand Down Expand Up @@ -234,7 +243,7 @@ arguments to it to get a decorator.
The above code snippet will only run the view function if the specified
model as the requested addon.

.. note::
.. note::
Routes whose views are with decorated ``must_have_addon('addon_short_name', 'node')`` MUST start with ``/project/<pid>/...``.

``website.project.decorators.must_have_permission``
Expand Down Expand Up @@ -277,7 +286,7 @@ First make sure your add-on's short name is listed in ``addons.json``.
**addons.json**

.. code-block:: json
{
"addons": [
...
Expand Down

0 comments on commit 14be0cb

Please sign in to comment.