Assemblies

.github/styles/config/vocabularies/Decidim/accept.txt

@@ -3,6 +3,7 @@ CSV
 [Dd]ecidim
 [Ee]mail
 [Ff]aq
+Mautic
 [Mm]oderations
 [Nn]ickame
 [Oo]fficialization

docs/en/modules/ROOT/nav.adoc

@@ -64,6 +64,8 @@
 **** xref:admin:spaces/processes/groups.adoc[Process Groups]
 **** xref:admin:spaces/processes/types.adoc[Process Types]
 *** xref:admin:spaces/assemblies.adoc[Assemblies]
+**** xref:admin:spaces/assemblies/types.adoc[Assembly types]
+**** xref:admin:spaces/assemblies/assembly_creation.adoc[Assembly creation]
 **** xref:admin:spaces/assemblies/components.adoc[Components]
 **** xref:admin:spaces/assemblies/categories.adoc[Categories]
 **** xref:admin:spaces/assemblies/attachments.adoc[Attachments]

docs/en/modules/admin/pages/spaces/assemblies.adoc

@@ -1,308 +1,115 @@
 = Assemblies
 
+== Understand the basics
+
 An assembly is a group of members of an organization who meet periodically to make decisions about a specific area or
 scope of the organization.
 
-Assemblies hold meetings, some are private and some are open. If they are open, it is possible to participate in them
-(for example: attending if the capacity allows it, adding points to the agenda, or commenting on the proposals and decisions taken by this organ).
+Assemblies can hold meetings, consult their members, can be private or open to everyone. 
 
-Examples: A general assembly (which meets once a year to define the organisation's main lines of action as well as its
-executive bodies by vote), an equality advisory council (which meets every two months to make proposals on how to improve
-gender relations in the organisation), an evaluation commission (which meets every month to monitor a process) or a guarantee
-body (which collects incidents, abuses or proposals to improve decision-making procedures) are all examples of assemblies.
+Examples of assemblies are: a general assembly meeting once a year to define the organisation's main lines of action as well as its
+executive bodies by vote, an equality advisory council meeting regularly to make proposals on how to improve
+gender relations in the organisation, an evaluation commission meeting every month to monitor a process, or a guarantee
+body collecting incidents, abuses, or proposals to improve decision-making procedures.
 
-The main difference between xref:admin:spaces/processes.adoc[participatory processes] and assemblies is that assemblies don't
+NOTE: The main difference between xref:admin:spaces/processes.adoc[participatory processes] and assemblies is that assemblies don't
 have phases, meaning that they don't have timelines.
 
-You can see a real world usage of assemblies in https://www.decidim.barcelona/assemblies[Decidim Barcelona], where you
-can see the different Participation Organs, that are the regular spaces where the City Council meets with citizens and organizations
-to get feedback.
-
-In this section, we'll explain how we can configure an Assembly in Decidim.
-
-== List
-
-To configure assemblies on the Decidim platform, click on btn:[Assemblies] in the admin sidebar menu. A list
-will appear with the existing assemblies if there are any:
-
-image:assemblies_list.png[Assemblies list]
-
-You can filter by the ones that are:
-
-* Published / Unpublished
-* Public / Private
-
-image:assemblies_list_filter.png[Assemblies list filtered]
-
-You can also search by title and control how many elements are in the list.
+In this documentation section, you can find how to configure and manage all of those items: 
 
-You have 4 possible actions in this list after an Assembly is created:
+* xref:admin:spaces/assemblies/types.adoc[Assembly types]
+* xref:admin:spaces/assemblies/assembly_creation.adoc[Assembly creation]
+* xref:admin:spaces/assemblies/components.adoc[Components]
+* xref:admin:spaces/assemblies/categories.adoc[Categories]
+* xref:admin:spaces/assemblies/attachments.adoc[Attachments]
+* xref:admin:spaces/assemblies/members.adoc[Members]
+* xref:admin:spaces/assemblies/admins.adoc[Assembly admins]
+* xref:admin:spaces/assemblies/private_participants.adoc[Private participants]
+* xref:admin:spaces/assemblies/moderations.adoc[Moderations]
 
-. Export: send by email the configuration for a given assembly. Can be imported in other Decidim installation.
-. Duplicate: to duplicate this assembly.
-. Configure: to edit the metadata and configuration for a assembly.
-. Assemblies: to manage all the children assemblies for a assembly.
-. Preview: how it will look once published.
+== How to find it?
 
-== New assembly form
+To access the Assemblies panel, go in the administration panel and click the "Assemblies" item in the administration 
+navigation bar. 
 
-image:assemblies_new_form.png[New assembly form]
+image::spaces/assemblies/assemblies_menu.png[Pages: Access assemblies panel]
 
-.New assembly form: General information
-|===
-|Field |Type |Description
-
-|Title
-|Required
-|Title of the assembly. For instance, "General Committee".
-
-|Subtitle
-|Required
-|Subtitle. For instance, "Let's decide our priorities together"
-
-|Order position
-|Required
-|Which order will it have in relation with the other assemblies. Having a lower number means a higher priority. For instance,
-if you have two assemblies, "Assembly a" with weight "10" and "Assembly b" with weight "0", then "Assembly b" will be first when ordering.
-
-|URL slug
-|Required
-|URL slugs are used to generate the URLs that point to this assembly. Only accepts letters, numbers and dashes, and must
-start with a letter. Example: if your domain is 'example.org' and your slug 'general-committee' then your URL will
-be https://example.org/assemblies/general-committee
+There, you are able to manage assemblies and assemblies types. 
 
-|Hashtag
-|Optional
-|Hashtag for Twitter
+== Manage assemblies
 
-|Short description
-|Required
-|A short explanation of what's your participatory process about.
+image::spaces/assemblies/assemblies_list.png[Assemblies list]
 
-|Description
-|Required
-|A long explanation of what's your assembly about.
+On this page, you are able to manage assemblies and xref:admin:spaces/processes/groups.adoc[assemblies types].
+You can find all the assemblies on the list in the administration panel, with:
 
-|Purpose of action
-|Optional
-|Internal field that doesn't get shown publicly. To be removed in a future version.
+* *Title*: title of the assembly. 
+* *Created at*: date of creation of the assembly. 
+* *Private*: if the assembly is opened to all participants or to only certain participants. 
+* *Published*: if the assembly is published or no. 
 
-|Composition
-|Optional
-|Internal field that doesn't get shown publicly. To be removed in a future version.
+You can filter and sort this list by clicking the "Filter" button and the columns headers. 
+You can also search for assemblies by their title in the search bar.
 
-|Internal organisation
-|Optional
-|Internal field that doesn't get shown publicly. To be removed in a future version.
+image::spaces/assemblies/assemblies_list_filter.png[Assemblies list filtered]
 
-|Announcement
-|Optional
-|The text you enter here will be shown to the user right below the assembly information.
+== Actions
 
 |===
+|Icon |Name |Definition
 
-.New assembly form: Duration
-|===
-|Field |Type |Description
+|image:icons/action_edit.png[Configure assembly icon]
+|Configure
+|To edit the configuration and components for an assembly.
 
-|Date created
-|Optional
-|Information that's displayed in the assembly metadata sidebar. Expected format: dd/mm/yyyy
+|image:icons/action_assemblies.png[Children assemblies icon]
+|Assemblies
+|To manage all the children assemblies for an assembly.
 
-|Included at
-|Optional
-|Information that's displayed in the assembly metadata sidebar. The date when this assembly was added to Decidim. It does
-not necessarily have to be the same as the creation date. Expected format: dd/mm/yyyy
+|image:icons/action_duplicate.png[Duplicate assembly icon]
+|Duplicate
+|To duplicate this assembly.
 
-|Duration
-|Optional
-|Information that's displayed in the assembly metadata sidebar. If the duration of this assembly is limited, select the
-end date. Otherwise, it will appear as indefinite. Expected format: dd/mm/yyyy
+|image:icons/action_export.png[Export assembly icon]
+|Export all
+|Send the assembly configuration JSON file by email. Then it can be imported in other Decidim installation.
 
-|Closing date
-|Optional
-|Information that's displayed in the assembly metadata sidebar. When this assembly closed. Expected format: dd/mm/yyyy
+|image:icons/action_preview.png[Preview assembly icon]
+|Preview
+|Preview of how the assembly looks in the user interface.
 
-|Closing date reason
-|Optional
-|Information that's displayed in the assembly metadata sidebar. Why this assembly closed.
+|image:icons/action_moderate.png[Moderate assembly icon]
+|Moderate
+|To access the assembly moderation panel. 
 
 |===
 
-.New assembly form: Images
-|===
-|Field |Type |Description
+You can also click the "Manage" button at the top right of the page, to be able to import a process or 
+configure Assemblies Types. 
 
-|Home image
-|Optional
-|Image that will be used in presentation cards of this assembly. Guidance for file: Has to be an image or a document.
-For images, use preferably landscape images that does not have any text, the service crops the image. Maximum file size: 10MB
-Allowed file extensions: jpeg jpg png
+=== Import an assembly
 
-|Banner image
-|Optional
-|Image that will be used inside of the assembly. Guidance for file: Has to be an image or a document.
-For images, use preferably landscape images that does not have any text, the service crops the image. Maximum file size: 10MB
-Allowed file extensions: jpeg jpg png
+To import an assembly, click the "Manage" button at the top right of the page. 
 
-|===
+image::spaces/assemblies/import_menu.png[Assemblies import menu]
 
-.New assembly form: Filters
-|===
-|Field |Type |Description
-
-|Scopes enabled
-|Optional
-|Check if you want to have Scopes filtering in this assembly.
-
-|Scope
-|Optional
-|Which xref:admin:scopes.adoc[Scope] does this assembly belongs to.
-
-|Area
-|Optional
-|Which xref:admin:areas.adoc[Area] does this assembly belongs to.
-
-|===
-
-.New assembly form: Metadata
-|===
-|Field |Type |Description
-
-|What is decided
-|Optional
-|Information that's displayed in the assembly metadata sidebar.
-
-|How is it decided
-|Optional
-|Information that's displayed in the assembly metadata sidebar.
-
-|Scope metadata
-|Optional
-|Information that's displayed in the assembly metadata sidebar.
-
-|Promoter group
-|Optional
-|Information that's displayed in the assembly metadata sidebar.
-
-|Organization area
-|Optional
-|Information that's displayed in the assembly metadata sidebar.
-
-|Who participates
-|Optional
-|Information that's displayed in the assembly metadata sidebar.
-
-|===
-
-.New assembly form: Visibility
-|===
-|Field |Type |Description
+You are redirected to the import page, where you need to fill in those fields: 
 
-|Parent assembly
-|Optional
-|What is the assembly that this assembly belongs to. For instance in Metadecidim, the https://meta.decidim.org/assemblies/coordination-committee[Coordination Committee]
-has the parent assembly of the https://meta.decidim.org/assemblies/general-assembly-association[General%20Assembly%20of%20the%20Decidim%20Association].
+* Title : The title you wish to give to the assembly.
+* URL identifier: The ‘slug’ for the assembly.
+* Add a document: Here you need to load the assembly JSON file obtained by email when exporting.
 
-|Highlighted
-|Optional
-|Check if you want the assembly to have more visibility in the Assemblies public list. It'll also be visible in the
-Assembly Content Block in the xref:admin:homepage.adoc[Homepage] configuration.
-
-|Private space
-|Optional
-|Check if this assembly should only be accessible by xref:admin:spaces/assemblies/private_participants.adoc[Private Participants]
-
-|Is transparent
-|Optional
-|Check if this assembly is private but should be visible to all the rest of participants. This means that other participants
-or visitors will see it but they won't be able to interact with it.
-
-|===
-
-.New assembly form: Other
-|===
-|Field |Type |Description
-
-|Created by
-|Optional
-|Choose one of "City Council", "Public" or "Other". If it's Other, you can specify the name of the organization that created
-this assembly.
-
-|Assembly type
-|Optional
-|Which xref:_assemblies_types[assembly type] is this assembly.
-
-|Related processes
-|Optional
-|Select other participatory processes that are related to this assembly.
-
-|Social
-|Optional
-|Which social networks profile does this assembly has. Can be Twitter, Facebook, Instagram, YouTube and/or GitHub. It's
-displayed in the assembly metadata sidebar.
-
-|Show statistics
-|Optional
-|Check if you want to show the Statistics section.
-
-|===
-
-After you've initially created your assembly you have a submenu where you need to keep configuring more information
-about your assembly.
-
-image:assembly_submenu.png[Assembly submenu in admin]
-
-Here you can keep configuring your process:
-
-. Info: the same form that we explained in this page.
-. xref:admin:spaces/assemblies/components.adoc[Components]
-. xref:admin:spaces/assemblies/categories.adoc[Categories]
-. xref:admin:spaces/assemblies/attachments.adoc[Attachments]
-. xref:admin:spaces/assemblies/members.adoc[Members]
-. xref:admin:spaces/assemblies/admins.adoc[Assembly admins]
-. xref:admin:spaces/assemblies/private_participants.adoc[Private participants]
-. xref:admin:spaces/assemblies/moderations.adoc[Moderations]
-
-== Assemblies types
-
-For clasyfing the assemblies in different kinds, you can define Assembly types. These types can be filtered in the public
-assemblies page.
-
-image:assemblies_type_filters.png[Filter by assembly type]
-
-image:assemblies_new_type_form.png[New assembly type form]
-
-.New assembly type form
-|===
-|Field |Type |Description
-
-|Title
-|Required
-|Title of the this assembly type. For instance, "Consultative".
-
-|===
-
-== Settings
-
-At the moment there's only a setting for configuring the general behaviour of assemblies.
-
-image:assemblies_settings.png[Assemblies settings]
-
-.Settings for assemblies form
-|===
-|Field |Type |Description
-
-|Enable organization chart
-|Checkbox
-|Whether you want to show the organization chart in the assemblies list.
-
-|===
+You can then select the type of data you want to import from the file. 
 
-The organization chart is shown in the bottotm of the assemblies page.
+* Import categories: Imports all the categories present in the original file. 
+* Import attachments : Import attachments of the original assembly. 
+* Import components : Imports all the components and their configuration from the original file, without importing their content. 
 
-image:assemblies_organization_chart.png[Assemblies organization chart]
+== Examples
 
-It allows a navigation in the assemblies tree, with the possibility to see the sub-assemblies that belongs to a parent assembly.
+Below, you can find some links to example assemblies: 
 
-image:assemblies_organization_chart_filtered.png[Assemblies organization chart filtered]
+* https://www.decidim.barcelona/assemblies[Decidim Barcelona neighborhood assemblies]
+* https://meta.decidim.org/assemblies/general-assembly-association[Decidim association general assembly]
+* https://jeparticipe.metropole.toulouse.fr/assemblies/capitole-arnaud-bernard-carmes[Toulouse neighborhood assembly]
+* https://community.mautic.org/assemblies/ux-ui-tiger-team[Mautic open source project working group]