diff --git a/.github/styles/config/vocabularies/Decidim/accept.txt b/.github/styles/config/vocabularies/Decidim/accept.txt index 31e7bdab35..491c485ba4 100644 --- a/.github/styles/config/vocabularies/Decidim/accept.txt +++ b/.github/styles/config/vocabularies/Decidim/accept.txt @@ -6,6 +6,7 @@ CSV [Ff]aq [Gg]amification Keka +Mautic [Mm]oderations [Nn]ickame [Oo]fficialization diff --git a/docs/en/modules/ROOT/nav.adoc b/docs/en/modules/ROOT/nav.adoc index c71f04b74d..1e7d1081a5 100644 --- a/docs/en/modules/ROOT/nav.adoc +++ b/docs/en/modules/ROOT/nav.adoc @@ -66,6 +66,8 @@ ***** xref:admin:spaces/processes/private_participants.adoc[Private participants] ***** xref:admin:spaces/processes/moderations.adoc[Moderations] *** 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] diff --git a/docs/en/modules/admin/assets/images/assemblies_list.png b/docs/en/modules/admin/assets/images/assemblies_list.png deleted file mode 100644 index 0f73c4a365..0000000000 Binary files a/docs/en/modules/admin/assets/images/assemblies_list.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assemblies_list_filter.png b/docs/en/modules/admin/assets/images/assemblies_list_filter.png deleted file mode 100644 index b6486cefeb..0000000000 Binary files a/docs/en/modules/admin/assets/images/assemblies_list_filter.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assemblies_new_form.png b/docs/en/modules/admin/assets/images/assemblies_new_form.png deleted file mode 100644 index 53022d3191..0000000000 Binary files a/docs/en/modules/admin/assets/images/assemblies_new_form.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assemblies_new_type_form.png b/docs/en/modules/admin/assets/images/assemblies_new_type_form.png deleted file mode 100644 index 5996f1e8d6..0000000000 Binary files a/docs/en/modules/admin/assets/images/assemblies_new_type_form.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assemblies_organization_chart.png b/docs/en/modules/admin/assets/images/assemblies_organization_chart.png deleted file mode 100644 index 09b71e2c00..0000000000 Binary files a/docs/en/modules/admin/assets/images/assemblies_organization_chart.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assemblies_organization_chart_filtered.png b/docs/en/modules/admin/assets/images/assemblies_organization_chart_filtered.png deleted file mode 100644 index 9af1d3605e..0000000000 Binary files a/docs/en/modules/admin/assets/images/assemblies_organization_chart_filtered.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assemblies_settings.png b/docs/en/modules/admin/assets/images/assemblies_settings.png deleted file mode 100644 index 663c613ef7..0000000000 Binary files a/docs/en/modules/admin/assets/images/assemblies_settings.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assemblies_type_filters.png b/docs/en/modules/admin/assets/images/assemblies_type_filters.png deleted file mode 100644 index 11fcfb8890..0000000000 Binary files a/docs/en/modules/admin/assets/images/assemblies_type_filters.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assembly_members.png b/docs/en/modules/admin/assets/images/assembly_members.png deleted file mode 100644 index dd9e9b7b7c..0000000000 Binary files a/docs/en/modules/admin/assets/images/assembly_members.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/assembly_submenu.png b/docs/en/modules/admin/assets/images/assembly_submenu.png deleted file mode 100644 index 48428bf278..0000000000 Binary files a/docs/en/modules/admin/assets/images/assembly_submenu.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/icons/action_assemblies.png b/docs/en/modules/admin/assets/images/icons/action_assemblies.png new file mode 100644 index 0000000000..9759727a8d Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_assemblies.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_list.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_list.png new file mode 100644 index 0000000000..ef5c37b868 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_list.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_list_filter.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_list_filter.png new file mode 100644 index 0000000000..b5176de4c5 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_list_filter.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_menu.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_menu.png new file mode 100644 index 0000000000..c55652fd52 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_menu.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_duration.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_duration.png new file mode 100644 index 0000000000..d80dc795c9 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_duration.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_filters.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_filters.png new file mode 100644 index 0000000000..d0acaded72 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_filters.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_general_info.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_general_info.png new file mode 100644 index 0000000000..0afad7485c Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_general_info.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_images.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_images.png new file mode 100644 index 0000000000..67f4a1e5fe Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_images.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_metadata.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_metadata.png new file mode 100644 index 0000000000..dbca9bbe11 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_metadata.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_other.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_other.png new file mode 100644 index 0000000000..8b8983b083 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_other.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_visibility.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_visibility.png new file mode 100644 index 0000000000..1926290e29 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_new_form_visibility.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_edit_process.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_edit_process.png new file mode 100644 index 0000000000..1d5e6397de Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_edit_process.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_filter.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_filter.png new file mode 100644 index 0000000000..835f90f1de Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_filter.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_form.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_form.png new file mode 100644 index 0000000000..0697afbd00 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_list.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_list.png new file mode 100644 index 0000000000..ae1c91020a Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assemblies_types_list.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members.png new file mode 100644 index 0000000000..82c8f9c9df Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members_list.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members_list.png new file mode 100644 index 0000000000..3316b3c825 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members_list.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members_new_form.png b/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members_new_form.png new file mode 100644 index 0000000000..29d5023ae3 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/assembly_members_new_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/assemblies/import_menu.png b/docs/en/modules/admin/assets/images/spaces/assemblies/import_menu.png new file mode 100644 index 0000000000..e9654047d3 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/assemblies/import_menu.png differ diff --git a/docs/en/modules/admin/pages/spaces/assemblies.adoc b/docs/en/modules/admin/pages/spaces/assemblies.adoc index 6d1e1a6f02..b2af45102e 100644 --- a/docs/en/modules/admin/pages/spaces/assemblies.adoc +++ b/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] diff --git a/docs/en/modules/admin/pages/spaces/assemblies/assembly_creation.adoc b/docs/en/modules/admin/pages/spaces/assemblies/assembly_creation.adoc new file mode 100644 index 0000000000..98ce105083 --- /dev/null +++ b/docs/en/modules/admin/pages/spaces/assemblies/assembly_creation.adoc @@ -0,0 +1,269 @@ += Assembly creation + +== Understand the basics + +Assemblies allows administrators to configure components inside a long-lasting space, with defined members. +To start creating an assembly, when on the assembly list, click the "New assembly" button at the top right of the page. + +The assembly creation form is divided into different sections that are detailed in the sections below. + +Once you created an assembly, in the secondary navigation panel, you can see all the assembly configurations available: + +* xref:admin:spaces/assemblies/assembly_creation.adoc[About this assembly]: here you can access and edit all the fields from the creation form. +* xref:admin:spaces/assemblies/landing_page.adoc[Landing 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] + +== General information + +This section allows to provide a general description about the assembly, mainly a title, URL, and description. + +image::spaces/assemblies/assemblies_new_form_general_info.png[New assembly form general info section] + +.New assembly form: General information +[cols="20h,10h,~,~"] +|=== +|Field |Type |Description |Visibility + +|Title +|Required +|Title of the assembly, "General Committee" or "neighborhood city council" for example. +|Visible in the card of the assembly on the homepage, the assemblies index, the navigation, and the "Hero image and CTA" landing page block. + +|Subtitle +|Required +|Subtitle of the assembly. +|Visible in the "Hero image and CTA" landing page block. + +|Order position +|Required +|Determines the order of the assembly when displayed in the processes index or homepage. +|N/A + +|URL slug +|Required +|URL slugs are used to generate the URLs that point to this process. Only accepts letters, numbers and dashes, and must +start with a letter. +|Visible in the URL of the assembly, for example https://example.org/assemblies/city_coucil. + +|Hashtag +|Optional +|Hashtag redirecting to the X social network. +|Visible in the "Hero image and CTA" landing page block. + +|Short description +|Required +|A short explanation of what's your participatory process about. +|Visible in the "Main data" landing page block. + +|Description +|Required +|A long explanation of what's your assembly about. +|Visible in the "Main data" landing page block. + +|Purpose of action +|Optional +|The explanation of the assembly's goals. +|Visible in the "Main data" landing page block. + +|Composition +|Optional +|Who composes the assembly. +|Visible in the "Main data" landing page block. + +|Internal organisation +|Optional +|How the assembly is organized. +|Visible in the "Main data" landing page block. + +|Announcement +|Optional +|The text you enter here is shown to the user right below the process information. +|Visible in the "Announcement" landing page block. + +|=== + +== Duration + +This section allows to provide information about the assembly important dates. + +image::spaces/assemblies/assemblies_new_form_duration.png[New assembly form duration section] + +.New assembly form: Duration +[cols="20h,10h,~,~"] +|=== +|Field |Type |Description |Visibility + +|Date created +|Optional +|When this assembly was created. You have a calendar widget to choose the day. Expected format: dd/mm/yyyy. +|Visible in the "Dates metadata" landing page block. + +|Included at +|Optional +|The date when this assembly was added to the instance. It does not necessarily have to be the same as the creation date. Expected format: dd/mm/yyyy. +|Visible in the "Dates metadata" landing page block. + +|Duration +|Optional +|If the duration of this assembly is limited, select the end date. Otherwise, it appears as indefinite. Expected format: dd/mm/yyyy. +|Visible in the "Type and duration" landing page block. + +|Closing date +|Optional +|When this assembly closed. Expected format: dd/mm/yyyy. +|Visible in the "Dates metadata" landing page block. + +|Closing date reason +|Optional +|Why this assembly closed. +|Not displayed on the landing page. + +|=== + +== Images + +image::spaces/assemblies/assemblies_new_form_images.png[New assembly form images section] + +.New assembly form: Images +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Home image +|Optional +|Image used in presentation cards of this process. Guidance for file: Has to be an image or a document. +For images, use preferably landscape images, the service crops the image. Maximum file size: 10 MB + +|Banner image +|Optional +|Deprecated, isn't used anywhere. Use "Hero image and CTA" content block on the landing page instead. + +|=== + +== Filters + +This section determines the filters available in the assembly, in the different components. +Filters can then be enabled and configured in each components. + +image::spaces/assemblies/assemblies_new_form_filters.png[New assembly form filters section] + +.New assembly form: Filters +[cols="20h,10h,~"] +|=== +|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. + +|=== + +== Metadata + +This section allows to provide meta information about the assembly. + +image::spaces/assemblies/assemblies_new_form_metadata.png[New assembly form metadata section] + +.New assembly form: Metadata +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|What is decided +|Optional +|The issue of the assembly, the object of what is decided. + +|How is it decided +|Optional +|The decision making process inside the assembly. + +|Scope metadata +|Optional +|Metadata on the assembly scope, if it's relevant. + +|Promoter group +|Optional +|If a specific group is at the origin of the assembly, like a city direction, an association committee, etc. + +|Organization area +|Optional +|The organization domain or category, if it's relevant. + +|Who participates +|Optional +|Who are the authorized participants, who can participate to the assembly. + +|=== + +== Visibility + +This section allows administrators to configure the process placement in the different pages and its publicity or no. + +image::spaces/assemblies/assemblies_new_form_visibility.png[New assembly form visibility section] + +.New assembly form: Visibility +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Parent assembly +|Optional +|To what other assemblies this assembly belongs. Assemblies can be nested inside one another. + +|Highlighted +|Optional +|Check if you want the assembly to have more visibility in the Assemblies public list. It's also visible in the "Highlighted +Assemblies" 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 participants. This means that other participants +or visitors can see it but they can't participate in it. + +|=== + +== Other + +image::spaces/assemblies/assemblies_new_form_other.png[New assembly form other section] + +.New assembly form: Other +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Created by +|Optional +|Choose "City Council" "Public" or "Other" in case you want to specify the name of the organization that created +this assembly. + +|Assembly type +|Optional +|Which xref:admin:spaces/assemblies/types.adoc[Assembly type] is related to this assembly. + +|Related participatory processes +|Optional +|Select other participatory processes related to this assembly. + +|Social +|Optional +|Which social networks profile does this assembly has. Can be X, Facebook, Instagram, YouTube, and/or GitHub. + +|=== diff --git a/docs/en/modules/admin/pages/spaces/assemblies/members.adoc b/docs/en/modules/admin/pages/spaces/assemblies/members.adoc index b64508b465..3041758272 100644 --- a/docs/en/modules/admin/pages/spaces/assemblies/members.adoc +++ b/docs/en/modules/admin/pages/spaces/assemblies/members.adoc @@ -1,25 +1,38 @@ = Assembly members -Assembly members allow showing all the people or groups that belong to a given assembly. It's useful for being transparent. +== Understand the basics -You can see an example in https://meta.decidim.org/assemblies/coordination-committee/members[Decidim Coordination Commitee Assembly in Metadecidim]. +Assembly members allow showing all the participants that belong to a given assembly, whether individuals or groups. +This is a feature specific to the assemblies space, made for improving transparency of the organization assemblies. -image:assembly_members.png[Assembly members of the Coordination Committee] +image::spaces/assemblies/assembly_members.png[Assembly members] -== New assembly member form +== Manage assembly members -image:assembly_members_list.png[Assembly members admin list] +To access the assembly members list, click in the secondary navigation panel on the "Members" item. -For creating a new phase of a participatory process: +image::spaces/assemblies/assembly_members_list.png[Assembly members administration list] -. Sign in as administrator -. Go to the assemblies section in the sidebar -. Click on the assembly Edit action -. Click on the Members link in the sidebar -. Click on the "New member" button -. Fill the form +== Actions -image:assembly_members_new_form.png[Assembly members new form] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|To edit this member fields. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete this member. + +|=== + +== Create an assembly member + +To create a new assembly member, click the "New assembly member" button in the top right of the page. + +image::spaces/assemblies/assembly_members_new_form.png[Assembly members new form] .New assembly member form |=== @@ -27,35 +40,36 @@ image:assembly_members_new_form.png[Assembly members new form] |Participant type |Required -|Wheter this assembly member is non-participant or existing participant. Do they already have an account created on the platform? +|Wether this assembly member already has an account on the instance or not. |Full name -|Required if it's non-participant. -| +|Required. +|Field displayed if "non participant" was selected. + +|Avatar +|Optional. +|Field displayed if "non participant" was selected. |User or group |Required if it's an existing participant. -|Type at least three characters to search. +|Type at least three characters to search for the participant account. |Position |Required |Choose one of President, Vice president, Secretary, or Other. In case it's other, you can fill in the position title. -|Weight +|Order position |Optional -|Which order will it have in relation to the other members. Having a lower number means a higher priority. For instance, if you have two members, "Member a" with weight "10" and "Member b" with weight "0", then "Member b" will be first when ordering. +|Which order the members has in relation to the other members. Having a lower number means a higher priority. +For instance, if you have two members, "Member a" with weight "10" and "Member b" with weight "0" then "Member b" is first when ordering. |Designation date |Required -|When was this person or group assigned as a member of this assembly. Expected format: dd/mm/yyyy - -|Designation mode -|Optional -|How was this person designed. +|When this person or group was assigned as a member of this assembly. Expected format: dd/mm/yyyy. |Ceased date |Optional -|When was this person or group ceased to be a member of this assembly. Expected format: dd/mm/yyyy +|When this person or group ceased to be a member of this assembly. Expected format: dd/mm/yyyy. |Gender |Optional @@ -63,7 +77,7 @@ image:assembly_members_new_form.png[Assembly members new form] |Birthday |Optional -|When was this person born. Expected format: dd/mm/yyyy +|When was this person born. Expected format: dd/mm/yyyy. |Birthplace |Optional diff --git a/docs/en/modules/admin/pages/spaces/assemblies/types.adoc b/docs/en/modules/admin/pages/spaces/assemblies/types.adoc new file mode 100644 index 0000000000..54e433f791 --- /dev/null +++ b/docs/en/modules/admin/pages/spaces/assemblies/types.adoc @@ -0,0 +1,45 @@ += Assemblies types + +== Understand the basics + +In some cases it is necessary to organize assemblies by more than just children and sub-assemblies. +This is where assemblies types can be useful, and add a layer of categorization. +Participants are then able to filter assemblies by the assembly types you created. + +NOTE: Assembly types work similarly to xref:admin:spaces/processes/types.adoc[Process types]. + +== Manage assemblies types + +To access the assembly types list, click the "Manage" button on the top right of the page, and click the "Assemblies type" menu item. + +image::spaces/assemblies/assemblies_types_list.png[Backend assemblies types menu item] + +== Create an assembly type + +Click the "New assembly type" button on the top right of the page. + +image::spaces/assemblies/assemblies_types_form.png[Process type creation form] + +.New assembly type form: General information +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|Title of the assembly type. + +|=== + +== Add assembly type to an assembly + +To relate assemblies to assembly types, in the edition page of an assembly, select the assembly type under the section labelled Other. + +image:spaces/assemblies/assemblies_types_edit_process.png[Choose an assembly type when editing an assembly] + +== Filter by assembly types + +If there is at least one assembly type defined and related to an assembly, a filter is displayed at the left of the assemblies list +in the participant interface, allowing filtering of assemblies. + +image::spaces/assemblies/assemblies_types_filter.png[Assemblies types filter in the assemblies index] \ No newline at end of file