diff --git a/docs/en/modules/ROOT/nav.adoc b/docs/en/modules/ROOT/nav.adoc index 49ddf1bdec..c71f04b74d 100644 --- a/docs/en/modules/ROOT/nav.adoc +++ b/docs/en/modules/ROOT/nav.adoc @@ -54,15 +54,17 @@ **** xref:admin:participants/authorizations/census.adoc[Organization's census] ** xref:admin:spaces.adoc[Spaces] *** xref:admin:spaces/processes.adoc[Participatory Processes] -**** xref:admin:spaces/processes/phases.adoc[Phases] -**** xref:admin:spaces/processes/components.adoc[Components] -**** xref:admin:spaces/processes/categories.adoc[Categories] -**** xref:admin:spaces/processes/attachments.adoc[Attachments] -**** xref:admin:spaces/processes/admins.adoc[Process admins] -**** xref:admin:spaces/processes/private_participants.adoc[Private participants] -**** xref:admin:spaces/processes/moderations.adoc[Moderations] **** xref:admin:spaces/processes/groups.adoc[Process Groups] **** xref:admin:spaces/processes/types.adoc[Process Types] +**** xref:admin:spaces/processes/process_creation.adoc[Process creation] +***** xref:admin:spaces/processes/landing_page.adoc[Landing page] +***** xref:admin:spaces/processes/phases.adoc[Phases] +***** xref:admin:spaces/processes/components.adoc[Components] +***** xref:admin:spaces/processes/categories.adoc[Categories] +***** xref:admin:spaces/processes/attachments.adoc[Attachments] +***** xref:admin:spaces/processes/admins.adoc[Process admins] +***** 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/components.adoc[Components] **** xref:admin:spaces/assemblies/categories.adoc[Categories] diff --git a/docs/en/modules/admin/assets/images/icons/action_activate.png b/docs/en/modules/admin/assets/images/icons/action_activate.png new file mode 100644 index 0000000000..d1a9576b8f Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_activate.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_export.png b/docs/en/modules/admin/assets/images/icons/action_export.png new file mode 100644 index 0000000000..1fdcc1ba86 Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_export.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_moderate.png b/docs/en/modules/admin/assets/images/icons/action_moderate.png new file mode 100644 index 0000000000..a6ed95b8ab Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_moderate.png differ diff --git a/docs/en/modules/admin/assets/images/process_backend_metadata.png b/docs/en/modules/admin/assets/images/process_backend_metadata.png deleted file mode 100644 index 061bd43dec..0000000000 Binary files a/docs/en/modules/admin/assets/images/process_backend_metadata.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/process_frontend_metadata.png b/docs/en/modules/admin/assets/images/process_frontend_metadata.png deleted file mode 100644 index 84b207acd0..0000000000 Binary files a/docs/en/modules/admin/assets/images/process_frontend_metadata.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/process_phases.png b/docs/en/modules/admin/assets/images/process_phases.png deleted file mode 100644 index cfcdc7e06c..0000000000 Binary files a/docs/en/modules/admin/assets/images/process_phases.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/process_phases_header.png b/docs/en/modules/admin/assets/images/process_phases_header.png deleted file mode 100644 index bad9cd7a58..0000000000 Binary files a/docs/en/modules/admin/assets/images/process_phases_header.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/process_phases_list.png b/docs/en/modules/admin/assets/images/process_phases_list.png deleted file mode 100644 index 417788cccf..0000000000 Binary files a/docs/en/modules/admin/assets/images/process_phases_list.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/process_phases_new_form.png b/docs/en/modules/admin/assets/images/process_phases_new_form.png deleted file mode 100644 index fc3ab824a1..0000000000 Binary files a/docs/en/modules/admin/assets/images/process_phases_new_form.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/process_submenu.png b/docs/en/modules/admin/assets/images/process_submenu.png deleted file mode 100644 index e27c15663d..0000000000 Binary files a/docs/en/modules/admin/assets/images/process_submenu.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/processes_group_example.png b/docs/en/modules/admin/assets/images/processes_group_example.png deleted file mode 100644 index 27c64ca9a8..0000000000 Binary files a/docs/en/modules/admin/assets/images/processes_group_example.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/processes_group_landing.png b/docs/en/modules/admin/assets/images/processes_group_landing.png deleted file mode 100644 index f9c9fd785a..0000000000 Binary files a/docs/en/modules/admin/assets/images/processes_group_landing.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/processes_group_list.png b/docs/en/modules/admin/assets/images/processes_group_list.png deleted file mode 100644 index 6b31d8f8e6..0000000000 Binary files a/docs/en/modules/admin/assets/images/processes_group_list.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/processes_group_new_form.png b/docs/en/modules/admin/assets/images/processes_group_new_form.png deleted file mode 100644 index 08e1dfc26d..0000000000 Binary files a/docs/en/modules/admin/assets/images/processes_group_new_form.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/processes_list.png b/docs/en/modules/admin/assets/images/processes_list.png deleted file mode 100644 index 652c25660f..0000000000 Binary files a/docs/en/modules/admin/assets/images/processes_list.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/processes_list_filter.png b/docs/en/modules/admin/assets/images/processes_list_filter.png deleted file mode 100644 index 2dfdffa022..0000000000 Binary files a/docs/en/modules/admin/assets/images/processes_list_filter.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/processes_new_form.png b/docs/en/modules/admin/assets/images/processes_new_form.png deleted file mode 100644 index e6e0680777..0000000000 Binary files a/docs/en/modules/admin/assets/images/processes_new_form.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/import_menu.png b/docs/en/modules/admin/assets/images/spaces/processes/import_menu.png new file mode 100644 index 0000000000..b361dafc7d Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/import_menu.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process-types-admin-backend.png b/docs/en/modules/admin/assets/images/spaces/processes/process-types-admin-backend.png deleted file mode 100644 index 03ef36090a..0000000000 Binary files a/docs/en/modules/admin/assets/images/spaces/processes/process-types-admin-backend.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process-types-edit-process.png b/docs/en/modules/admin/assets/images/spaces/processes/process-types-edit-process.png deleted file mode 100644 index 614b8bb5e0..0000000000 Binary files a/docs/en/modules/admin/assets/images/spaces/processes/process-types-edit-process.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process-types-front-end.png b/docs/en/modules/admin/assets/images/spaces/processes/process-types-front-end.png deleted file mode 100644 index 960b9a21e9..0000000000 Binary files a/docs/en/modules/admin/assets/images/spaces/processes/process-types-front-end.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process_phases.png b/docs/en/modules/admin/assets/images/spaces/processes/process_phases.png new file mode 100644 index 0000000000..b20123d9b1 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/process_phases.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process_phases_block.png b/docs/en/modules/admin/assets/images/spaces/processes/process_phases_block.png new file mode 100644 index 0000000000..cb722f73ce Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/process_phases_block.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process_phases_list.png b/docs/en/modules/admin/assets/images/spaces/processes/process_phases_list.png new file mode 100644 index 0000000000..02ee76bf52 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/process_phases_list.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process_phases_new_form.png b/docs/en/modules/admin/assets/images/spaces/processes/process_phases_new_form.png new file mode 100644 index 0000000000..f12917ada1 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/process_phases_new_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process_types_edit_process.png b/docs/en/modules/admin/assets/images/spaces/processes/process_types_edit_process.png new file mode 100644 index 0000000000..4837891e08 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/process_types_edit_process.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process_types_filter.png b/docs/en/modules/admin/assets/images/spaces/processes/process_types_filter.png new file mode 100644 index 0000000000..35f9e1aa82 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/process_types_filter.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process_types_form.png b/docs/en/modules/admin/assets/images/spaces/processes/process_types_form.png new file mode 100644 index 0000000000..cbd2683631 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/process_types_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process_types_list.png b/docs/en/modules/admin/assets/images/spaces/processes/process_types_list.png new file mode 100644 index 0000000000..c181530286 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/process_types_list.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group__barcelona_example.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group__barcelona_example.png new file mode 100644 index 0000000000..82dd904010 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group__barcelona_example.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group__cd44_example.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group__cd44_example.png new file mode 100644 index 0000000000..c3f1c86059 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group__cd44_example.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_about.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_about.png new file mode 100644 index 0000000000..9403ee3eac Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_about.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_metadata.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_metadata.png new file mode 100644 index 0000000000..8237c5a139 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_metadata.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_visibility.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_visibility.png new file mode 100644 index 0000000000..b5ec51d194 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_form_visibility.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing.png new file mode 100644 index 0000000000..4ae114dc32 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_events.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_events.png new file mode 100644 index 0000000000..332cb05742 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_events.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_hero.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_hero.png new file mode 100644 index 0000000000..fb11b0d9a5 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_hero.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_html.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_html.png new file mode 100644 index 0000000000..e738d00ee0 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_html.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_metadata.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_metadata.png new file mode 100644 index 0000000000..1b97d712d7 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_metadata.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_processes.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_processes.png new file mode 100644 index 0000000000..933aec2673 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_processes.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_proposals.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_proposals.png new file mode 100644 index 0000000000..cb5c895e0a Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_proposals.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_stats.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_stats.png new file mode 100644 index 0000000000..43ae9beef3 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_stats.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_title.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_title.png new file mode 100644 index 0000000000..f1dc000175 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_landing_title.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_group_list.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_list.png new file mode 100644 index 0000000000..07b4feb0d1 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_group_list.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_list.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_list.png new file mode 100644 index 0000000000..20db763f5f Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_list.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_list_filter.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_list_filter.png new file mode 100644 index 0000000000..033ce6aa19 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_list_filter.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_menu.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_menu.png new file mode 100644 index 0000000000..6f5740e277 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_menu.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_duration.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_duration.png new file mode 100644 index 0000000000..8d65cadefa Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_duration.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_filters.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_filters.png new file mode 100644 index 0000000000..c466991e02 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_filters.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_general_info.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_general_info.png new file mode 100644 index 0000000000..e2f7db3bb0 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_general_info.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_images.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_images.png new file mode 100644 index 0000000000..ee561426fa Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_images.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_metadata.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_metadata.png new file mode 100644 index 0000000000..647e82134e Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_metadata.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_related_processes.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_related_processes.png new file mode 100644 index 0000000000..729036590d Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_related_processes.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_visibility.png b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_visibility.png new file mode 100644 index 0000000000..48529f63ae Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/processes/processes_new_form_visibility.png differ diff --git a/docs/en/modules/admin/assets/images/spaces_admin.png b/docs/en/modules/admin/assets/images/spaces_admin.png index 5c1bc5d6f0..4c8fc9e09d 100644 Binary files a/docs/en/modules/admin/assets/images/spaces_admin.png and b/docs/en/modules/admin/assets/images/spaces_admin.png differ diff --git a/docs/en/modules/admin/assets/images/spaces_visitor.png b/docs/en/modules/admin/assets/images/spaces_visitor.png index 7c1cd808e1..0f8907a919 100644 Binary files a/docs/en/modules/admin/assets/images/spaces_visitor.png and b/docs/en/modules/admin/assets/images/spaces_visitor.png differ diff --git a/docs/en/modules/admin/pages/spaces.adoc b/docs/en/modules/admin/pages/spaces.adoc index b935b16390..c55051affd 100644 --- a/docs/en/modules/admin/pages/spaces.adoc +++ b/docs/en/modules/admin/pages/spaces.adoc @@ -1,12 +1,41 @@ = Spaces -The participatory spaces are the channels that citizens can participate through when public decisions are being taken. By default -the platform is provided with participatory processes, initiatives, consultations, conferences, votings and assemblies, but -any organization can develop its own mechanisms through xref:develop:modules.adoc[Modules]. +== Understand the basics -They are accessible through the main sidebar in the administration panel, and also through the main navigation menu in the -public interface. +Participatory spaces are the channels through which citizens can take part in public decision-making. +By default, an instance is provided with those different spaces: -image:spaces_admin.png[Spaces in admin sidebar] +.Participatory spaces +|=== +|Name |Description |Use cases -image:spaces_visitor.png[Spaces visible in the public interface] +|*xref:admin:spaces/processes.adoc[Participatory Processes]* +|A participatory process allows administrators to configure different participatory components, which evolve over different participatory phases. +|Participatory budgeting, Proposal recollection, Voting or debate process, etc. + +|*xref:admin:spaces/assemblies.adoc[Assemblies]* +|An assembly allows administrator to configure participatory components in a continued space, with the possibility to define members. +|Committee organization space, citizen assembly, etc. + +|*xref:admin:spaces/initiatives.adoc[Initiatives]* +|Initiatives space allows administrators to open a bottom-up space, with different initiatives types. +|Petitions, Hearing requests, Participatory process requests, etc. + +|*xref:admin:spaces/conferences.adoc[Conferences]* +|A conference allows administrators to organize and publicize events, deal with registrations, program , speakers and venues. +|Participatory event, Citizen assembly, Association festival, etc. + +|=== + +NOTE: Any organization can develop its own spaces by creating xref:develop:modules.adoc[Modules]. + +== Configuration + +Spaces are accessible through the administration navigation bar. + +image::spaces_admin.png[Spaces in administrator sidebar] + +Once you start publishing spaces, participants see links to the different spaces indexes appear in the homepage global menu, +the instance navigation bar and the footer. + +image::spaces_visitor.png[Spaces visible in the public interface] diff --git a/docs/en/modules/admin/pages/spaces/processes.adoc b/docs/en/modules/admin/pages/spaces/processes.adoc index 7fe8cbaabe..f251438c59 100644 --- a/docs/en/modules/admin/pages/spaces/processes.adoc +++ b/docs/en/modules/admin/pages/spaces/processes.adoc @@ -1,7 +1,16 @@ -= Processes += Participatory processes -A participatory process is a sequence of participatory activities (e.g. first filling out a survey, then making proposals, -discussing them in face-to-face or virtual meetings, and finally prioritizing them) with the aim of defining and making a decision on a specific topic. +== Understand the basics + +A participatory process is a sequence of participatory activities with the aim of defining and making a decision on a specific topic. +For example, you could have a participatory process like this: + +. First filling out a survey for collect participants opinion; +. Then opening proposals; +. Discussing them in face-to-face or virtual meetings; +. Finally prioritizing them before implementation. + +NOTE: You want to create a participatory process? Check the xref:admin:spaces/processes/process_creation.adoc[process creation] article. Examples of participatory processes are: a process of electing committee members (where candidatures are first presented, then debated and finally a candidacy is chosen), participatory budgets (where proposals are made, valued economically, @@ -13,230 +22,107 @@ in a participatory process in Decidim: image::process_steps_components.png[Relation between Steps and Components in a Process in Decidim] -What this diagram is showing is that for a participatory process you can have 7 phases: - -. Configuration & Presentation -. Diagnostic -. Proposal Creation -. Proposal Selection -. Results -. Evaluation -. Monitoring - -Inside of every one of these Phases, there are some components (like Blog, Meetings, Survey, Debates, Proposals, Results). -Some of these Components allow some features depending on the Phase that we are. - -In this section, we'll explain how we can configure a Participatory Process in Decidim. +What this diagram is showing is that for a participatory process you can configure different phases, and enable and configure +the components for each phase as you need it for your process. -== List +Inside of every one of these Phases, you can enable the xref:admin:components.adoc[Components] you need. -To configure participatory processes on the Decidim platform, click on btn:[Processes] in the admin sidebar menu. A list -will appear with the existing processes if there are any: +In this documentation section, you can find how to configure and manage all of those items: -image::processes_list.png[Participatory processes list] +* xref:admin:spaces/processes/groups.adoc[Process Groups] +* xref:admin:spaces/processes/types.adoc[Process Types] +** xref:admin:spaces/processes/process_creation.adoc[Process creation] +** xref:admin:spaces/processes/landing_page.adoc[Landing page] +** xref:admin:spaces/processes/phases.adoc[Phases] +** xref:admin:spaces/processes/components.adoc[Components] +** xref:admin:spaces/processes/categories.adoc[Categories] +** xref:admin:spaces/processes/attachments.adoc[Attachments] +** xref:admin:spaces/processes/admins.adoc[Process admins] +** xref:admin:spaces/processes/private_participants.adoc[Private participants] +** xref:admin:spaces/processes/moderations.adoc[Moderations] -You can filter by the ones that are: +== How to find it? -* Published / Unpublished -* Public / Private +To access the Participatory processes panel, go in the administration panel and click the "Processes" item in the administration +navigation bar. -image::processes_list_filter.png[Participatory processes list filtered] +image::spaces/processes/processes_menu.png[Pages: Access processes panel] -You can also search by title and control how many elements are in the list. - -You have 4 possible actions in this list after a Participatory Process is created: - -1. Export: send by email the configuration for a given process. Can be imported in other Decidim installation. -2. Duplicate: to duplicate this process. -3. Configure: to edit the metadata and configuration for a process. -4. Preview: how it will look once published. - -== New process form - -image::processes_new_form.png[New participatory process form] - -.New participatory process form: General information -|=== -|Field |Type |Description +There, you are able to manage participatory processes and processes groups. -|Title -|Required -|Title of the participatory process. For instance, "Participatory Budgeting 2020". +== Manage processes -|Subtitle -|Required -|Subtitle. For instance, "Let's decide our priorities together" +image::spaces/processes/processes_list.png[Participatory processes list] -|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. Example: if your domain is 'example.org' and your slug 'participatory-budget-2020' then your URL will -be https://example.org/processes/participatory-budget-2020 +On this page, you are able to manage processes and xref:admin:spaces/processes/groups.adoc[process groups]. -|Hashtag -|Optional -|Hashtag for Twitter +You can find all the processes on the list in the administration panel, with: -|Short description -|Required -|A short explanation of what's your participatory process about. +* *Title*: title of the process. +* *Created at*: date of creation of the process. +* *Private*: if the process is opened to all participants or to only certain participants. +* *Published*: if the process is published or no. -|Description -|Required -|A long explanation of what's your participatory process about. +You can filter and sort this list by clicking the "Filter" button and the columns headers. +You can also search for processes by their title in the search bar. -|Announcement -|Optional -|The text you enter here will be shown to the user right below the process information. +image::spaces/processes/processes_list_filter.png[Participatory processes list filtered] -|=== +== Actions -.New participatory process form: Duration |=== -|Field |Type |Description - -|Start date -|Optional -|When this process start. You have a calendar widget to choose the day. Expected format: dd/mm/yyyy - -|End date -|Optional -|When this process start. You have a calendar widget to choose the day. Expected format: dd/mm/yyyy +|Icon |Name |Definition -|=== +|image:icons/action_edit.png[Configure process icon] +|Configure +|To edit the configuration and components for a process. -.New participatory process form: Images -|=== -|Field |Type |Description +|image:icons/action_export.png[Export process icon] +|Export all +|Send the process configuration JSON file by email. Then it can be imported in other Decidim installation. -|Home image -|Optional -|Image that will be 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: 10MB +|image:icons/action_duplicate.png[Duplicate process icon] +|Duplicate +|To duplicate this process. -|Banner image -|Optional -|Image that will be used inside of the 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: 10MB +|image:icons/action_preview.png[Preview process icon] +|Preview +|Preview of how the process looks in the user interface. -|=== +|image:icons/action_moderate.png[Moderate process icon] +|Moderate +|To access the process moderation panel. -.New participatory process form: Metadata |=== -|Field |Type |Description -|Promoter group -|Optional -|Information that's displayed in the process metadata sidebar. +You can also click the "Manage" button at the top right of the page, to be able to import a process or +configure xref:admin:spaces/processes/types.adoc[Process Types]. -|Organization area -|Optional -|Information that's displayed in the process metadata sidebar. +=== Import a process -|Scope metadata -|Optional -|Information that's displayed in the process metadata sidebar. +To import a process, click the "Manage" button at the top right of the page. -|Who participates -|Optional -|Information that's displayed in the process metadata sidebar. +image::spaces/processes/import_menu.png[Participatory processes import menu] -|What is decided -|Optional -|Information that's displayed in the process metadata sidebar. +You are redirected to the import page, where you need to fill in those fields: -|How is it decided -|Optional -|Information that's displayed in the process metadata sidebar. - -|=== - -image::process_frontend_metadata.png[Process frontend metadata] - -image::process_backend_metadata.png[Process backend metadata] - -.New participatory process form: Filters -|=== -|Field |Type |Description +* Title : The title you wish to give to the process. +* URL identifier: The ‘slug’ for the process. +* Add a document: Here you need to load the process JSON file obtained by email when exporting. -|Scopes enabled -|Optional -|Check if you want to have Scopes filtering in this process. - -|Scope -|Optional -|Which xref:admin:scopes.adoc[Scope] does this process belongs to. - -|Scope filter depth -|Optional -|Restrict the scope filter depth; The filter will show from general to the selected scope type. This is only relevant if -you have complex relations in Scopes children (like a Russian Doll). For instance if you have a Grandmother -> Mother -> -Child, this setting allows you to choose the Mother, so the participants can only choose the Child. This would be the -case for instance if you have Provinces -> Cities -> Districts, and the process is about a particular City. - -|Area -|Optional -|Which xref:admin:areas.adoc[Area] does this process belongs to. - -|=== - -.New participatory process form: Visibility -|=== -|Field |Type |Description - -|Processes group -|Optional -|Enables to make groups of multiple participatory processes. Ideally for processes that are related between them, for -instance multiple squares in a City or multiple documents using the same participatory rules. - -|Private space -|Optional -|Check if this process should only be accessible by xref:admin:spaces/processes/private_participants.adoc[Private Participants] - -|Promoted -|Optional -|Check if you want the process to have more visibility in the Process public list. It'll also be visible in the -Participatory Process Content Block in the xref:admin:homepage.adoc[Homepage] configuration. This is accessible in the -btn:[Edit] action in a Process. - -|=== - -.New participatory process form: Filters -|=== -|Field |Type |Description - -|Related processes -|Optional -|Select other participatory processes that are related to this one. - -|=== - -.New participatory process form: Filters -|=== -|Field |Type |Description - -|Show statistics -|Optional -|Check if you want to show the Statistics section. - -|Show metrics -|Optional -|Check if you want to show the Metrics section. - -|=== +You can then select the type of data you want to import from the file. -After you've initially created your process you have a submenu where you need to keep configuring more information -about your participatory process. +* Import steps: Imports all the phases present in the original file. +* Import categories: Imports all the categories present in the original file. +* Import attachments : Import attachments of the original process. +* Import components : Imports all the components and their configuration from the original file, without importing their content. -image::process_submenu.png[Process submenu in admin] +== Examples -Here you can keep configuring your process: +Below, you can find some links to examples participatory processes: -. Info: the same form that we explained in this page. -. xref:admin:spaces/processes/phases.adoc[Phases] -. xref:admin:spaces/processes/components.adoc[Components] -. xref:admin:spaces/processes/categories.adoc[Categories] -. xref:admin:spaces/processes/attachments.adoc[Attachments] -. xref:admin:spaces/processes/admins.adoc[Process admins] -. xref:admin:spaces/processes/private_participants.adoc[Private participants] -. xref:admin:spaces/processes/moderations.adoc[Moderations] +* https://www.decidim.barcelona/processes/PAM2020[Procés participatiu del Programa d'Actuació Municipal (PAM) 2020-2023, Barcelona] +* https://www.participate.nyc.gov/processes/Citywidepb2024[The People's Money (2024-2025), New York city participatory budget] +* https://brasilparticipativo.presidencia.gov.br/processes/planoclima/[Plano Clima, Brazilian government] +* https://omastadi.hel.fi/processes/osbu-2023/[Helsinki city participatory budget] +* https://ecrivons.angers.fr/processes/BP24-25[Angers city participatory budget] diff --git a/docs/en/modules/admin/pages/spaces/processes/groups.adoc b/docs/en/modules/admin/pages/spaces/processes/groups.adoc index 9d8101fd66..ac2c7d383c 100644 --- a/docs/en/modules/admin/pages/spaces/processes/groups.adoc +++ b/docs/en/modules/admin/pages/spaces/processes/groups.adoc @@ -1,113 +1,232 @@ = Process groups -A group of processes proves useful for subdividing large participatory processes into subprocesses according to a criteria, -for instance the xref:admin:scopes.adoc[scope] of every process. +== Understand the basics -As an example you can see the https://www.decidim.barcelona/processes_groups/4[Barcelona City Council's Neighborhoods Plan, Pla de Barris]. -This is is a 150 million euro shock plan that aims to reduce inequalities within the city. There are 10 related processes, one for each involved neighborhood. +A group of processes can be useful for subdividing large participatory processes into sub-processes according to a criteria. +It can also allow administrators to organize an instance with a lot of processes, to gather together the ones related to a +specific type of process, or a specific scope, like participatory budgeting annual editions, mobility planning processes, etc. -image::processes_group_example.png[Participatory process group example] +== Manage process groups -== New process group form +To access the process group management page, click the "Process groups" tab in the processes index page. +There, you can find the list of process groups. -For creating a new process group: +image::spaces/processes/processes_group_list.png[Participatory process groups list] -. Sign in as administrator -. Go to the Processes section in the sidebar -. Click on the Process groups link in the sidebar -. Click on the "New process group" button -. Fill in the form +=== Actions -image::processes_group_list.png[Participatory process groups list] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit process group icon] +|Edit +|To edit the configuration and components for the process group. + +|image:icons/action_preview.png[Preview process group icon] +|Preview +|See a preview of the process group landing page. + +|image:icons/action_delete.png[Delete process group icon] +|Delete +|To delete this process group. + +|=== + +== Create a process group + +To create a new process group, click the "New process group" button in the top right of the page. -image::processes_group_new_form.png[New participatory process group form] +=== About this process + +This section allows to provide a general description about the process group, mainly a title, image, and description, and to +select the existing processes that pertain to the group. + +image::spaces/processes/processes_group_form_about.png[Participatory process groups creation form about this process] .New participatory process group form: General information +[cols="20h,10h,~,~"] |=== -|Field |Type |Description +|Field |Type |Description |Visibility |Title |Required -|Title of the participatory process group. For instance, "Participatory Budgeting". +|Title of the participatory process group. +|Visible in the card of the process groups on the homepage, the processes index, the navigation, the "title and description" +and the "Hero image and CTA" landing page blocks. |Description |Required -|A long explanation of what's your participatory process about. +|A long explanation of what's the process group about. +|Visible in the card of the processes index and the "title and description" landing page block. |Related processes |Optional -|Which are the processes that are related to this one? They will be used for populating -the Content Blocks in the Landing page of this Process group. For selecting multiple you'll -need to use the *ctrl* function. +|The processes that should be grouped inside this process group. To select multiple processes, use the *CTRL* or *CMD* key. +|Visible in the "Participatory processes" landing page block. |Image |Optional |Image that will be used in presentation cards of this process group. Guidance for image: Preferably a landscape image that does not have any text. The service crops the image. -Maximum file size: 10MB. Allowed file extensions: jpeg jpg png +Maximum file size: 10 MB. Allowed file extensions: JPEG JPG PNG +|Visible in the card of the process groups on the homepage and the processes index. |=== +=== Metadata + +This section allows to provide meta information about the process group. +It can be enabled on the landing page with the "Metadata" landing page block. + +image::spaces/processes/processes_group_form_metadata.png[Participatory process groups creation form metadata] + .New participatory process group form: Metadata +[cols="20h,10h,~"] |=== |Field |Type |Description -Hashtag -Website +|Hashtag +|Optional +|Hashtag redirecting to the X social network. + +|Website +|Optional +|Website related to this process group. |Promoter group |Optional -|Information that's displayed in the process metadata content block. +|If a specific group is at the origin of the process, like a city direction, an association committee, etc. |Organization area |Optional -|Information that's displayed in the process metadata content block. +|The organization domain or category, if it's relevant. |Scope metadata |Optional -|Information that's displayed in the process metadata content block. +|Metadata on the process scope, if it's relevant. |Who participates |Optional -|Information that's displayed in the process metadata content block. +|Who are the authorized participants, who can participate to the process. |What is decided |Optional -|Information that's displayed in the process metadata content block. +|The issue of the process, the object of what is decided. |How is it decided |Optional -|Information that's displayed in the process metadata content block. +|The decision making process. |=== +=== Visibility + +This section allows administrators to configure the process group visibility in the homepage and processes index. + +image::spaces/processes/processes_group_form_visibility.png[Participatory process groups creation form visibility] + .New participatory process group form: Visibility +[cols="20h,10h,~"] |=== |Field |Type |Description |Promoted |Optional -|Check if you want the process to have more visibility in the Process public list. It'll also be visible in the -ParticpipatoryProcess Content Block in the xref:admin:homepage.adoc[Homepage] configuration. This is accessible in the btn:[Edit] action in a Process. +|Check if you want the process to have more visibility in the Process public list. It'll also be visible in the "Highlighted processes" +content block in the xref:admin:homepage.adoc[Homepage]. |=== -== Landing page - -One of the main features of a process group is to be able to configure the Landing page, through Content blocks, just like -the general homepage of the platform. This means that you can enable or disable different sections of the landing page and also -configure some fo these sections. - -image::processes_group_landing.png[Participatory process group landing page] - -* Title, description and hashtag -* Metadata -* Image, text and Call to Action button. Configurable. -* Proposals. You can configure how the elements will be sorted: by most recent or random. -* Results. You can configure how the elements will be sorted: by most recent or random. -* Upcoming events -* Statistics -* Participatory processes -* First HTML block -* Second HTML block -* Third HTML block +== Landing page content blocks + +Process groups are mainly landing pages, grouping more complex participatory processes. +This landing page works with different content blocks, just like the general homepage of the platform. +This means that you can enable different sections of the landing page and configure some of these sections. + +To configure a process group landing page, when editing the process group, click the "Manage" button in the top right of the page, +and click the "Landing page" menu item. + +image::spaces/processes/processes_group_landing.png[Participatory process group landing page] + +Below, you'll find all the content blocks configuration guides and screenshots of how there are displayed on the landing page. + +NOTE: If there is no content to display in a content block, or if wasn't configured, it won't be displayed on the landing page. + +=== Title and description + +The Title and description content block allows to display: + +* *Title*: the title of the process group. +* *Description*: the description of the process group. +* *Number of related processes*: the number of published participatory processes related to this process group. +* *Scope*: the scope of the process group. +* *Hashtag*: the hashtag, redirecting to the X social media. +* *Website*: a link to the website. + +image::spaces/processes/processes_group_landing_title.png[Participatory process group landing page title and description block] + +=== Metadata + +image::spaces/processes/processes_group_landing_metadata.png[Participatory process group landing page metadata block] + +=== Hero image and CTA + +The hero image and CTA content block allows to display: + +* *Title*: the title of the process group. +* *an hashtag*: the hashtag, redirecting to the X social media. +* *a call to action button*: enable it by clicking the "Edit" icon on the landing page content block. +* *an image*: download an image for this block by clicking the "Edit" icon on the landing page content block. + +image::spaces/processes/processes_group_landing_hero.png[Participatory process group landing page hero block] + +=== Proposals + +The Proposals content block allows to display a selection of proposals from the different participatory processes of the process group. +You can configure how the proposals are sorted by most recent or random by clicking the "Edit" icon on the landing page content block. + +image::spaces/processes/processes_group_landing_proposals.png[Participatory process group landing page proposals block] + +=== Results + +The Results content block allows to display a selection of results from the different participatory processes. +You can configure how the results are sorted by most recent or random by clicking the "Edit" icon on the landing page content block. + +image::spaces/processes/processes_group_landing_results.png[Participatory process group landing page results block] + +=== Upcoming meetings + +The Upcoming meetings content block allows to display a selection of meetings from the different participatory processes. +You can configure how the results are sorted by most recent or random by clicking the "Edit" icon on the landing page content block. +If there is no upcoming meetings, this block shows the past ones. + +image::spaces/processes/processes_group_landing_events.png[Participatory process group landing page events block] + +=== Statistics + +image::spaces/processes/processes_group_landing_stats.png[Participatory process group landing page statistics block] + +=== Participatory processes + +The participatory processes content block displays a grid of participatory processes on the landing page. +You can configure if only active processes will be displayed by clicking the "Edit" icon on the landing page content block. + +image::spaces/processes/processes_group_landing_processes.png[Participatory process group landing page processes block] + +=== HTML blocks + +The HTML block content block allows to add an editable HTML block on the landing page, and therefore to create a personalized section. + +image::spaces/processes/processes_group_landing_html.png[Participatory process group landing page HTML blocks] + +== Examples + +The https://www.decidim.barcelona/processes_groups/4[Barcelona City Council's Neighborhoods Plan], a 150 million +euro shock plan that aims to reduce inequalities within the city. There are 10 sub-processes, one for each involved neighborhood. + +image::spaces/processes/processes_group__barcelona_example.png[Participatory process group example] + +The https://participer.loire-atlantique.fr/processes_groups/32[Loire-Atlantique participatory budget], with an elaborated HTML block +on the landing page. + +image::spaces/processes/processes_group__cd44_example.png[Participatory process group example] diff --git a/docs/en/modules/admin/pages/spaces/processes/landing_page.adoc b/docs/en/modules/admin/pages/spaces/processes/landing_page.adoc new file mode 100644 index 0000000000..81d1ed5112 --- /dev/null +++ b/docs/en/modules/admin/pages/spaces/processes/landing_page.adoc @@ -0,0 +1,2 @@ + +include::partial$page_landing_page.adoc[] diff --git a/docs/en/modules/admin/pages/spaces/processes/phases.adoc b/docs/en/modules/admin/pages/spaces/processes/phases.adoc index f63c5e4864..da40ad2c6d 100644 --- a/docs/en/modules/admin/pages/spaces/processes/phases.adoc +++ b/docs/en/modules/admin/pages/spaces/processes/phases.adoc @@ -1,12 +1,14 @@ = Phases +== Understand the basics + A participatory process is a sequence of phases ordered in time. Depending on which phase of the process timeline you -are, then you can enable or disable some features. +are, then you can enable and configure the features you need for each phase. Ideally, the Phases of a Participatory Process are always the same and are not changed, so participants can know what are -the rules and timeframe and can organize their lives to know when it'd be best for them to participate in this process. +the rules and time frame and can organize to know when it'd be best for them to participate in this process. -As a guideline, the standard structure of a participatory process may be as follows: +For example, the standard structure of a participatory process could be as follows: . Presentation . Diagnosis @@ -15,76 +17,79 @@ As a guideline, the standard structure of a participatory process may be as foll . Proposals evaluation . Monitoring -Participants can find the link to different phases of a participatory process in the header of the participatory process, -in the link "Process phases". Here they can see the full description and explanation of the phases. The active phase -will be highlighted. +Participants can find the link to different phases of a participatory process in the "Phase and duration" landing page content block, +when it's enabled by an administrator in the process xref:admin:spaces/processes/landing_page.adoc[Landing page]. -image:process_phases_header.png[Header with processes phases link] +image::spaces/processes/process_phases_block.png[Block with processes phases link] -image:process_phases.png[Process phases explanation] +When clicking on the link for the active phase, they can see the full description and explanation of the phases in a pop-up. -== Create a new phase +image::spaces/processes/process_phases.png[Process phases explanation] -image:process_phases_list.png[Phases of a participatory process] +== Manage phases -For creating a new phase of a participatory process: +To access the phases configuration, click in the secondary navigation panel on the "Phases" item. -. Sign in as administrator -. Go to the participatory process section in the sidebar -. Click on the participatory process Edit action -. Click on the Phases link in the sidebar -. Click on the "New phase" button +image::spaces/processes/process_phases_list.png[Phases of a participatory process] -image:process_phases_new_form.png[Create a new participatory process phase form] +=== Actions -.Create meeting +|=== +|Icon |Name |Definition |Condition + +|image:icons/action_edit.png[Edit icon] +|Edit +|To edit this phase. +|Always available + +|image:icons/action_activate.png[Activate icon] +|Activate +|To make this phase the active one. +|Only available for inactive phases. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete this phase. +|Always available + +|=== + +== Create a new phase + +To create a new phase, click the "New phase" button in the top right of the page. + +image::spaces/processes/process_phases_new_form.png[Create a new participatory process phase form] + +.Create process phase form +[cols="20h,10h,~"] |=== |Field |Type |Description |Title |Required -|What is the title for this phase. +|The title for this phase, displayed in the phase content block and on the process cards when phase is active. |Description -| +|Optional |A long description explaining what's this phase for. |Start date -| -|Which day this phase will start. Expected format: dd/mm/yyyy +|Optional +|The start date of this process phase. Expected format: dd/mm/yyyy |End date -| -|Which day this phase will end. Expected format: dd/mm/yyyy +|Optional +|The end date of this process phase. Expected format: dd/mm/yyyy |Call to Action path -| -|Where will the button link to. For instance, it could point to the new proposal creation form. Use partial paths, not full -URLs here. Accepts letters, numbers, dashes, and, slashes, and must start with a letter. If not set, the button will not be shown. +|Optional +|Deprecated |Call to Action text -| -|What will the button say. For instance, it could be "Create a proposal". If not set, the button will not be shown. - -|=== - -== Actions - -After a phase was created you have these actions: +|Optional +|Deprecated |=== -|Icon |Name |Definition - -|image:action_activate.png[Activate icon] -|Activate -|To make this phase the active one. - -|image:action_edit.png[Edit icon] -|Edit -|To edit this phase. -|image:action_delete.png[Delete icon] -|Delete -|To delete this phase. - -|=== +CAUTION: Configuring the CTA through the Phase of the participatory process is deprecated with the new design. +Now this is done in the Landing Page, using the Hero and image content block. diff --git a/docs/en/modules/admin/pages/spaces/processes/process_creation.adoc b/docs/en/modules/admin/pages/spaces/processes/process_creation.adoc new file mode 100644 index 0000000000..f26709c074 --- /dev/null +++ b/docs/en/modules/admin/pages/spaces/processes/process_creation.adoc @@ -0,0 +1,237 @@ += Participatory process creation + +== Understand the basics + +Participatory processes allows administrators to configure components in articulation with different participatory phases. +To start creating a process, when on the process list, click the "New process" button at the top right of the page. + +The process creation form is divided into different sections that are detailed in the sections below. + +Once you created a process, in the secondary navigation panel, you can see all the process configuration available: + +* xref:admin:spaces/processes/process_creation.adoc[About this process]: here you can access and edit all the fields from the creation form. +* xref:admin:spaces/processes/landing_page.adoc[Landing page] +* xref:admin:spaces/processes/phases.adoc[Phases] +* xref:admin:spaces/processes/components.adoc[Components] +* xref:admin:spaces/processes/categories.adoc[Categories] +* xref:admin:spaces/processes/attachments.adoc[Attachments] +* xref:admin:spaces/processes/admins.adoc[Process admins] +* xref:admin:spaces/processes/private_participants.adoc[Private participants] +* xref:admin:spaces/processes/moderations.adoc[Moderations] + +== General information + +This section allows to provide a general description about the process, mainly a title, URL, and description. + +image::spaces/processes/processes_new_form_general_info.png[New participatory process form general info section] + +.New participatory process form: General information +[cols="20h,10h,~,~"] +|=== +|Field |Type |Description |Visibility + +|Title +|Required +|Title of the participatory process. For instance, "Participatory Budgeting 2020" +|Visible in the card of the process on the homepage, the processes index, the navigation, and the "Hero image and CTA" landing page block. + +|Subtitle +|Required +|Subtitle. For instance, "Let's decide our priorities together" +|Visible in the "Hero image and CTA" landing page block. + +|Order position +|Required +|Determines the order of the process 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 participatory process, for example https://example.org/processes/participatory-budget-2020. + +|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 the participatory process about. +|Visible in the "Main data" landing page block. + +|Description +|Required +|A detailed explanation of what's the participatory process about. +|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 process start and end dates. +It can be enabled on the landing page with the "Phase & duration" landing page block. + +image::spaces/processes/processes_new_form_duration.png[New participatory process form duration section] + +.New participatory process form: Duration +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Start date +|Optional +|When this process start. You have a calendar widget to choose the day. Expected format: dd/mm/yyyy + +|End date +|Optional +|When this process start. You have a calendar widget to choose the day. Expected format: dd/mm/yyyy + +|=== + +== Images + +image::spaces/processes/processes_new_form_images.png[New participatory process form images section] + +.New participatory process 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 + +|=== + +== Metadata + +This section allows to provide meta information about the process. +It can be enabled on the landing page with the "Metadata" landing page block. + +image::spaces/processes/processes_new_form_metadata.png[New participatory process form metadata section] + +.New participatory process form: Metadata +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Promoter group +|Optional +|If a specific group is at the origin of the process, like a city direction, an association committee, etc. + +|Organization area +|Optional +|The organization domain or category, if it's relevant. + +|Scope metadata +|Optional +|Metadata on the process scope, if it's relevant. + +|Who participates +|Optional +|Who are the authorized participants, who can participate to the process. + +|What is decided +|Optional +|The issue of the process, the object of what is decided. + +|How is it decided +|Optional +|The decision making process. + +|=== + +== Filters + +This section determines the filters available in the process, in the different components. +Filters can then be enabled and configured in each components. + +image::spaces/processes/processes_new_form_filters.png[New participatory process form filters section] + +.New participatory process form: Filters +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Scopes enabled +|Optional +|Check if you want to have Scopes filtering in this process. + +|Scope +|Optional +|Which xref:admin:scopes.adoc[Scope] does this process belongs to. + +|Scope filter depth +|Optional +|Restrict the scope filter depth. This is relevant if you have complex relations in Scopes children (like a Russian Doll). +For instance if you have Grandmother -> Mother -> Child nested scopes, this setting allows you to choose the Mother scope, +so the participants can only filter between the Child sub-scopes. This would be the case for instance if you have +Provinces -> Cities -> Districts, and the process is about a particular City. + +|Area +|Optional +|Which xref:admin:areas.adoc[Area] does this process belongs to. + +|=== + +== Visibility + +This section allows administrators to configure the process placement in the different pages and its publicity or no. + +image::spaces/processes/processes_new_form_visibility.png[New participatory process form visibility section] + +.New participatory process form: Visibility +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Processes group +|Optional +|Enables to group multiple processes together. Check xref:admin:spaces/processes/groups.adoc[Process Groups] to know more. + +|Private space +|Optional +|Check this if the process should only be accessible by xref:admin:spaces/processes/private_participants.adoc[Private Participants]. + +|Promoted +|Optional +|Check if you want the process to have more visibility in the Process public list and the "Highlighted processes" content block +in the xref:admin:homepage.adoc[Homepage] configuration. + +|=== + +== Related processes + +This section allows to create relations between processes. It's different from processes groups. +It can be enabled on the landing page with the "Related processes" landing page block. + +image::spaces/processes/processes_new_form_related_processes.png[New participatory process form Related processes section] + +.New participatory process form: Related processes +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Related processes +|Optional +|Select other participatory processes that are related to this one. + +|=== + +== Other + +This section is empty, unless an administrator already created xref:admin:spaces/processes/types.adoc[Process Types]. +If so, you should be able to select a process type to categorize the process. +Participants are then able to filter processes in the processes index with those types. + +image::spaces/processes/process_types_edit_process.png[Choose a process type when editing a process] + +image::spaces/processes/process_types_filter.png[Process types filter in the processes index] diff --git a/docs/en/modules/admin/pages/spaces/processes/types.adoc b/docs/en/modules/admin/pages/spaces/processes/types.adoc index 785d1c5009..1bae4dd1b3 100644 --- a/docs/en/modules/admin/pages/spaces/processes/types.adoc +++ b/docs/en/modules/admin/pages/spaces/processes/types.adoc @@ -1,40 +1,45 @@ = Process types -In some cases it is necessary to organize participatory processes by more than just xref:spaces/processes/groups.adoc[Process Groups]. This is where Process Types can be useful. +== Understand the basics -Process Types work similarly to xref:admin:spaces/assemblies.adoc#_assemblies_types[Assembly types]. +In some cases it is necessary to organize participatory processes by more than just xref:spaces/processes/groups.adoc[Process Groups]. +This is where process types can be useful, and add a layer of categorization. +Participants are then able to filter processes by the process types you created. -== New process type form +NOTE: Process types work similarly to xref:admin:spaces/assemblies.adoc#_assemblies_types[Assembly types]. -For creating a new process type: +== Manage process types -. Sign in as administrator -. Go to the Processes section in the sidebar -. Click on the Process types link in the sidebar -. Click on the "New process type" button -. Fill in the form +To access the process types list, click the "Manage" button on the top right of the page, and click the "Process type" menu item. -image:spaces/processes/process-types-admin-backend.png[A screenshot of the back-end showing the button to create a new process type,title="Create a new process type in the back-end"] +image::spaces/processes/process_types_list.png[Backend process types menu item] + +== Create a process type + +Click the "New process type" button on the top right of the page. + +image:spaces/processes/process_types_form.png[Process type creation form] .New participatory process type form: General information +[cols="20h,10h,~"] |=== |Field |Type |Description |Title |Required -|Title of the participatory process type. For instance, "Consultative". +|Title of the participatory process type. |=== -== Add process type to existing processes - -It's possible to add a process type to existing processes. Edit the process, and select the process type under the section labelled Other. +== Add process type to a process -image:spaces/processes/process-types-edit-process.png[A screenshot of editing an existing process to add a process type,title="Add process type to an existing process"] +To relate processes to process types, in the edition page of a process, select the process type under the section labelled Other. -== Process type filter +image:spaces/processes/process_types_edit_process.png[Choose a process type when editing a process] -In the front-end if there is at least one Process Type defined, a filter shows, allowing filtering of Processes. +== Filter by process types -image:spaces/processes/process-types-front-end.png[A screenshot of the front-end showing a filter for Process types,title="Front-end filter for Process Types"] +If there is at least one process type defined and related to a process, a filter is displayed at the left of the processes list +in the participant interface, allowing filtering of Processes. +image::spaces/processes/process_types_filter.png[Process types filter in the processes index]