diff --git a/docs/en/modules/admin/assets/images/components/debates/close_debate_backend.png b/docs/en/modules/admin/assets/images/components/debates/close_debate_backend.png index 7061aa69c8..c5bf24a305 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/close_debate_backend.png and b/docs/en/modules/admin/assets/images/components/debates/close_debate_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/close_debate_frontend.png b/docs/en/modules/admin/assets/images/components/debates/close_debate_frontend.png index b0cea6df9a..6418ebce97 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/close_debate_frontend.png and b/docs/en/modules/admin/assets/images/components/debates/close_debate_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/component.png b/docs/en/modules/admin/assets/images/components/debates/component.png index 996368e5bb..cc14f64a55 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/component.png and b/docs/en/modules/admin/assets/images/components/debates/component.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/component_debate.png b/docs/en/modules/admin/assets/images/components/debates/component_debate.png new file mode 100644 index 0000000000..17e5983de5 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/debates/component_debate.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/debate_closed.png b/docs/en/modules/admin/assets/images/components/debates/debate_closed.png index 3e562da893..9dea15dc8e 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/debate_closed.png and b/docs/en/modules/admin/assets/images/components/debates/debate_closed.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/debate_finite.png b/docs/en/modules/admin/assets/images/components/debates/debate_finite.png deleted file mode 100644 index 11ff8d5bab..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/debates/debate_finite.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/debates/debates_list.png b/docs/en/modules/admin/assets/images/components/debates/debates_list.png index d346510d67..ca13aae9a7 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/debates_list.png and b/docs/en/modules/admin/assets/images/components/debates/debates_list.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/example01.png b/docs/en/modules/admin/assets/images/components/debates/example01.png index 48473a94cc..62d3560dd1 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/example01.png and b/docs/en/modules/admin/assets/images/components/debates/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/example02.png b/docs/en/modules/admin/assets/images/components/debates/example02.png deleted file mode 100644 index 84961e6c3d..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/debates/example02.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/debates/manage_debates.png b/docs/en/modules/admin/assets/images/components/debates/manage_debates.png index be604836eb..79be4fbe60 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/manage_debates.png and b/docs/en/modules/admin/assets/images/components/debates/manage_debates.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/new_debate_backend.png b/docs/en/modules/admin/assets/images/components/debates/new_debate_backend.png index 8374ffdb4c..98bdebe9d0 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/new_debate_backend.png and b/docs/en/modules/admin/assets/images/components/debates/new_debate_backend.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_close.png b/docs/en/modules/admin/assets/images/icons/action_close.png new file mode 100644 index 0000000000..e3e0590bdc Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_close.png differ diff --git a/docs/en/modules/admin/pages/components/blog.adoc b/docs/en/modules/admin/pages/components/blog.adoc index a22a2be810..eb5e4d55f3 100644 --- a/docs/en/modules/admin/pages/components/blog.adoc +++ b/docs/en/modules/admin/pages/components/blog.adoc @@ -24,7 +24,7 @@ Then: . Fill the component creation form You can still update this form and the configuration after creating the component, by clicking the -image:icons/action_configure.png[Configure icon] in the components list. +image:icons/action_configure.png[Configure icon] icon in the components list. image::components/blog/component.png[Add component form] @@ -140,6 +140,10 @@ image:components/blog/new_post.png[New post form] |Attachments |To add documents related to the post. +|image:icons/action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + |image:icons/action_permissions.png[Permissions icon] |Permissions |To handle the authorizations needed to comment or endorse this specific blog post. diff --git a/docs/en/modules/admin/pages/components/budgets/projects.adoc b/docs/en/modules/admin/pages/components/budgets/projects.adoc index 6cb18d25c1..ae90cad5b7 100644 --- a/docs/en/modules/admin/pages/components/budgets/projects.adoc +++ b/docs/en/modules/admin/pages/components/budgets/projects.adoc @@ -72,6 +72,7 @@ image::components/budgets/projects_list_filter.png[Projects list filter] === Actions .Actions +[cols="10h,20h,~"] |=== |Icon |Name |Definition diff --git a/docs/en/modules/admin/pages/components/debates.adoc b/docs/en/modules/admin/pages/components/debates.adoc index 30e50db73b..07e5b2cbbe 100644 --- a/docs/en/modules/admin/pages/components/debates.adoc +++ b/docs/en/modules/admin/pages/components/debates.adoc @@ -1,52 +1,47 @@ -= Debate += Debates -The Debate component allows people to have discussions, without voting nor prioritzation. It also allows to close them, -by adding conclusions or a summary of what the discussion was about. +== Understand the basics -From this starting point, there could be other configurations, such as: +The Debate component allows people to have discussions, without voting nor prioritization. It also allows to close debates, +by adding conclusions or a summary of what the discussion was about. -* To allow debates creation by participants -* To have debates with a fixed started and ending date or open -* To show endorsements (public supports) or not +image::components/debates/example01.png[Debates listing example] -Some examples of where this component was used: +== Configuration -* https://meta.decidim.org/processes/roadmap/f/219/[Propose new functionalities for Decidim software in Metadecidim] +To create a Debate component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. -image:components/debates/example01.png[Debates listing example] -image:components/debates/example02.png[Debate example] +image::components/debates/component_debate.png[Add Debate component button] -To configure the Debate component: +Then: -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". -. Go to components -. Click on "Add component" button -. Click on "Debate" -. Fill the xref:_add_component[Add component] form +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Debate" +. Fill the component creation form -== Add component +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] icon in the components list. -image:components/debates/component.png[Add component form] +image::components/debates/component.png[Add component form] .Add component: Debate form +[cols="20h,10h,~"] |=== |Field |Type |Description |Name |Required -|What is the title of this component. For instance, "Debates" +|The title of this component. |Order position |Optional -|Which order will it have in relation to the other debates. Having a lower number means a higher priority. -For instance, if you have two debates, "Debate a" with weight "10" and "Debate b" with weight "0", then "Debate b" will be first when ordering. +|Which order it has in relation to the other debates. Having a lower number means a higher priority. +For instance, if you have two debates, "Debate a" with weight "10" and "Debate b" with weight "0" then "Debate b" is first when ordering. |=== -.Add component: Debate form - Global settings +.Debate form - Global settings |=== |Field |Type |Description @@ -58,17 +53,13 @@ For instance, if you have two debates, "Debate a" with weight "10" and "Debate b |Optional |Which xref:admin:scopes.adoc[Scope] does this component belongs to. -|Global scope -|Optional -| - |Comments enabled |Optional |Whether you want to have comments in the meetings. |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|The characters limit that participants have when making comments. Leave 0 for default value. |Announcement |Optional @@ -76,24 +67,21 @@ For instance, if you have two debates, "Debate a" with weight "10" and "Debate b |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in -xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. - .Add component: Debates form - Step settings |=== |Field |Type |Description |Endorsements enabled |Optional -|Check if you want that participants show public support for these debates. +|Check if you want to enable participants to show public support for debates. |Endorsements blocked |Optional -| +|Check is you want to block new endorsements to be performed on debates at this phase. -|Debate creation by participants enabled +|Participants can create debates |Optional -|Check if you want to allow the creation of new debates by participants. +|Check if you want to allow the creation of new debates by participants during this phase. |Comments blocked |Optional @@ -105,29 +93,9 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |=== -== Permissions - -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make -certain actions in the debates: +== Create a debate -* Create -* Endorse - -== Manage debates - -image:components/debates/manage_debates.png[Manage debates table] - -=== Export all - -Allows exporting the comments in the debates in different formats. - -* Comments as CSV -* Comments as JSON -* Comments as Excel - -=== New debate form - -image:components/debates/new_debate_backend.png[New debate backend form] +image::components/debates/new_debate_backend.png[New debate backend form] .New debate form |=== @@ -135,24 +103,24 @@ image:components/debates/new_debate_backend.png[New debate backend form] |Title |Required -|What is the title of this debate. For instance, "How can we improve this process?" +|The title of this debate. For instance, "How can we improve this process?" |Description |Required -|What is the description of this debate. +|The description of this debate. |Instructions to participate |Required -|Add a message for the participants. +|Add a message for the participants, displayed on the debate page in an information box. |Information updates |Optional -|Add a message for the participants. +|Add a message for the participants, displayed on the debate page in an information box. |xref:_debate_types[Debate type] |Required |Choose between Finite and Open. Finite means that the debate has a starting and ending date and time, Open means that -there isn't any timeframe. +there isn't any time frame. |Starts at |Required if the debate type is Finite @@ -166,56 +134,83 @@ there isn't any timeframe. |Optional |Which category has the debate. Used for filtering in the debates list. +|Comments enabled +|Optional +|Whether you want participants to be able to comment on this debate. + |=== -==== Debate types +== Manage debates + +To start creating and managing debates, click in the component title in the navigation bar or in the component list, or click in the +image:icons/action_edit.png[Manage component icon] icon on the components list. + +image::components/debates/manage_debates.png[Manage debates table] + +On the debates list in the administration panel, administrators can see: + +* *Title*: Title of the debate. +* *Start date*: Start date of the debate. +* *End date*: End date of the debate. +* *Scope*: Scope of the debate, if enabled in the participatory space. + +You can also export the comments in the debates in CSV, JSON and Excel format by clicking the "Export all" button. + +=== Debate types It's possible to have two kinds of debates: . Finite: with a start and end date . Open: without a start and end date -This is shown publically in the debate list. +This is shown publicly in the debate list. image:components/debates/debates_list.png[Debates list] -image:components/debates/debate_finite.png[Finite debate] -==== Actions +=== Actions + +NOTE: When participants can create debates, administrators have less actions available, and can't edit nor delete the debates. .Actions +[cols="10h,20h,~"] |=== |Icon |Name |Definition -|image:action_edit.png[Edit icon] +|image:icons/action_edit.png[Edit icon] |Edit -|Edit form for a debate. It's the same form as "New debate". +|Edit form for a debate. -|image:action_close.png[Close icon] +|image:icons/action_close.png[Close icon] |Close |Close form for a debate. For adding conclusions. -|image:action_permissions.png[Permissions icon] +|image:icons/action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:icons/action_permissions.png[Permissions icon] |Permissions -|To handle the permissions of this debate, depending on the verification a participant has. +|To handle the authorizations needed to create or endorse debates. -|image:action_delete.png[Delete icon] +|image:icons/action_delete.png[Delete icon] |Delete -|To delete this debate. Only can be done when there aren't any projects. +|To delete this debate. |=== === Close debate form -A debate can be closed. This is useful for adding conclusions. After a debate was closed it can't be edited nor commented any more +A debate can be closed. This is useful for publishing debates conclusions. +After a debate was closed it can't be edited nor commented any more. -image:components/debates/close_debate_backend.png[Close debate backend form] +image::components/debates/close_debate_backend.png[Close debate backend form] -Take in account that if the debate was created by a participant then only that -participant can close it. +Take into account that if the debate was created by a participant, then only that participant can close it. -image:components/debates/close_debate_frontend.png[Close debate frontend form] +image::components/debates/close_debate_frontend.png[Close debate frontend form] .Close debate form +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -227,4 +222,10 @@ image:components/debates/close_debate_frontend.png[Close debate frontend form] The conclusions are shown publicly with the close date and time. -image:components/debates/debate_closed.png[Closed debate] +image::components/debates/debate_closed.png[Closed debate] + +== Examples + +Some examples of where this component is used: + +* https://meta.decidim.org/processes/roadmap/f/219/[Propose new functionalities for Decidim software in Metadecidim] \ No newline at end of file