~homeworkprod/byceps

2f1535d7dc4cd92885d2bc46fb06d347b08718ea — Jochen Kupperschmidt 2 years ago 2f1655c
Update docs regarding the introduction of the 'site' scope
1 files changed, 36 insertions(+), 13 deletions(-)

M docs/concepts/scopes.rst
M docs/concepts/scopes.rst => docs/concepts/scopes.rst +36 -13
@@ 1,27 1,35 @@
Scopes
======

BYCEPS distinguishes three scopes:
BYCEPS distinguishes four scopes:

* :ref:`global <scope-global>`
* :ref:`brand <scope-brand>`
* :ref:`party <scope-party>`
* :ref:`site <scope-site>`

.. graph:: unnamed

   color=lightgray
   fillcolor=lightgray
   fillcolor=white
   labeljust="l"
   style=filled

   subgraph cluster_global {
     label = "global"
     label="global"

     subgraph cluster_brand {
       fillcolor=white
       label = "brand"
       label="brand"

       node [color=lightgray, shape=box, style=filled] party;
       subgraph cluster_party {
         label="party"

         subgraph cluster_party {
           label="site"

           node [color=transparent] "";
         }
       }
     }
   }



@@ 35,8 43,9 @@ Global

The global scope is the outermost one.

Entities that belong to the global scope include users and
:ref:`brands <scope-brand>`.
Entities that belong to the global scope include users, roles,
permissions, user badges, :ref:`brands <scope-brand>`, and optionally
snippets.


.. _scope-brand:


@@ 48,8 57,9 @@ A brand is the identity of a series of parties.

Each brand is part of the :ref:`global <scope-global>` scope.

Entities that belong to the brand scope include news posts, boards, and,
of course, :ref:`parties <scope-party>`.
Entities that belong to the brand scope include orga flags, terms of
service versions, news channels, boards, :ref:`parties <scope-party>`,
and optionally snippets.


.. _scope-party:


@@ 57,9 67,22 @@ of course, :ref:`parties <scope-party>`.
Party
-----

The party scope is the innermost one.
The party scope is for entities that belong to a single party (and are
not better situated in the :ref:`site scope <scope-site>`).

Each party belongs to a :ref:`brand <scope-brand>`.

Entities that belong to the party scope include seating areas and
tickets.
Entities that belong to the party scope include orga teams, shops,
tickets, seating areas, and :ref:`sites <scope-site>`.


.. _scope-site:

Site
----

The site scope is the innermost one.

Each site belongs to a :ref:`party <scope-party>`.

Entities that *can* belong to the site scope include snippets.