diff --git a/docs/ca/modules/ROOT/nav.adoc b/docs/ca/modules/ROOT/nav.adoc index ef8f361fc9..21a5f32d0e 100644 --- a/docs/ca/modules/ROOT/nav.adoc +++ b/docs/ca/modules/ROOT/nav.adoc @@ -61,6 +61,7 @@ **** 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/assemblies.adoc[Assemblies] **** xref:admin:spaces/assemblies/components.adoc[Components] **** xref:admin:spaces/assemblies/categories.adoc[Categories] @@ -151,6 +152,18 @@ *** xref:develop:guide_architecture.adoc[5. Architecture] ** xref:develop:security.adoc[Security] ** Advanced +*** Creating custom classes +**** xref:develop:classes/cells.adoc[Cells] +**** xref:develop:classes/commands.adoc[Commands] +**** xref:develop:classes/controllers.adoc[Controllers] +**** xref:develop:classes/events.adoc[Events] +**** xref:develop:classes/forms.adoc[Forms] +**** xref:develop:classes/jobs.adoc[Jobs] +**** xref:develop:classes/mailers.adoc[Mailers] +**** xref:develop:classes/models.adoc[Models] +**** xref:develop:classes/permissions.adoc[Permissions] +**** xref:develop:classes/presenters.adoc[Presenters] +**** xref:develop:classes/queries.adoc[Queries] *** Concerns **** xref:develop:authorable.adoc[Authorable] **** xref:develop:embeddable.adoc[Embeddable] @@ -167,16 +180,19 @@ *** xref:develop:deploy.adoc[Deploy] *** xref:develop:docker.adoc[Docker] *** xref:develop:fixing_locales.adoc[Fixing locales] -*** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] *** xref:develop:maps.adoc[Maps] *** xref:develop:managing_translations_i18n.adoc[i18n] +*** xref:develop:maintainers/index.adoc[Maintainers] +**** xref:develop:backports.adoc[Backports] +**** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] +**** xref:develop:maintainers/releases.adoc[Releasing new versionss] +**** xref:develop:maintainers/security.adoc[Security procedures] *** xref:develop:metrics.adoc[Metrics] *** xref:develop:modules.adoc[Modules] *** xref:develop:notifications.adoc[Notifications] *** xref:develop:open-data.adoc[Open Data] *** xref:develop:permissions.adoc[Permissions] *** xref:develop:profiling.adoc[Profiling] -*** xref:develop:releases.adoc[Releases] *** xref:develop:reminders.adoc[Reminders] *** xref:develop:templates.adoc[Templates] *** xref:develop:testing.adoc[Testing] @@ -184,7 +200,6 @@ *** xref:develop:turbolinks.adoc[Turbolinks] *** Views **** xref:develop:content_blocks.adoc[Content Blocks] -**** xref:develop:data-picker.adoc[Data Picker] **** xref:develop:newsletter_templates.adoc[Newsletter Templates] **** xref:develop:view_hooks.adoc[View Hooks] **** xref:develop:view_models_aka_cells.adoc[View Models (Cells)] @@ -215,4 +230,4 @@ *** xref:publications:spanish.adoc[Spanish] ** Whitepaper *** xref:whitepaper:decidim-a-brief-overview.adoc[Decidim: a brief overview] -* xref:releases:index.adoc[Release Notes] \ No newline at end of file +* xref:releases:index.adoc[Release notes] \ No newline at end of file diff --git a/docs/ca/modules/ROOT/pages/index.adoc b/docs/ca/modules/ROOT/pages/index.adoc index 8ed5c4eb1d..abc8d67629 100644 --- a/docs/ca/modules/ROOT/pages/index.adoc +++ b/docs/ca/modules/ROOT/pages/index.adoc @@ -8,6 +8,11 @@ Decidim is a framework that allows anybody to create and configure a website pla You’ve found the documentation for Decidim. Learn about the project at https://decidim.org[decidim.org]. +[NOTE] +==== +This is the documentation for the `develop` branch. You can see this same documentation site for other versions: xref:v0.28@ROOT:index.adoc[v0.28] and xref:v0.27@ROOT:index.adoc[v0.27] +==== + // * Read the xref:ROOT:getting-started.adoc[Getting Started guide] The documentation covers xref:install:index.adoc[installing], xref:configure:index.adoc[configuring], and xref:admin:index.adoc[running] your own Decidim site. diff --git a/docs/ca/modules/admin/pages/components/accountability.adoc b/docs/ca/modules/admin/pages/components/accountability.adoc index 3657f8f81d..2913cb2ce9 100644 --- a/docs/ca/modules/admin/pages/components/accountability.adoc +++ b/docs/ca/modules/admin/pages/components/accountability.adoc @@ -7,4 +7,4 @@ The Accountability component allows people to follow project implementations. It * defining and applying progress in implementation statuses (0% to 100% implemented) around their implementation * displaying the extent of the results’ implementation grouped by categories and scopes -Results, projects and statuses can be updated through a CVS, or manually by the administration interface. \ No newline at end of file +Results, projects and statuses can be updated through a CSV (comma-separated values), or manually by the administration interface. \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/components/budgets.adoc b/docs/ca/modules/admin/pages/components/budgets.adoc index e4e986f0b1..93261f865c 100644 --- a/docs/ca/modules/admin/pages/components/budgets.adoc +++ b/docs/ca/modules/admin/pages/components/budgets.adoc @@ -17,7 +17,7 @@ Some examples of where this component was used: * https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona]. The city of Barcelona (Spain) has allocated a budget of 30.000.000 EUR so people can present, define, prioritize, vote -and choose which investment projects the city goverment should execute. +and choose which investment projects the city government should execute. * https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers (France) has allocated a budget of 1.000.000 EUR so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. * https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million euros to realising @@ -345,7 +345,7 @@ After the voting step has finished, then an administrator need to: . Change the Voting configuration for the Budget component to "Voting finished" . Go to the Budgets and view the results -. On the projects that according to the normative have been selected, she'll need to go to each project, edit it and +. On the projects that according to the normative have been selected, they will need to go to each project, edit it and then check the "Selected for implementation". image:components/budgets/results_unselected.png[Unselected projects after voting] diff --git a/docs/ca/modules/admin/pages/components/meetings.adoc b/docs/ca/modules/admin/pages/components/meetings.adoc index 96b29fa84e..8b017d8085 100644 --- a/docs/ca/modules/admin/pages/components/meetings.adoc +++ b/docs/ca/modules/admin/pages/components/meetings.adoc @@ -130,7 +130,7 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we Meetings can be created by participants if the setting is "Participants can create meetings" is checked. -If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create meetings as that group also. +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create meetings as that group also. image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)] image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form (frontend)] @@ -202,7 +202,7 @@ image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting f |Create meeting as |Required if the participant belongs to a group -|With which identity she wants to create this meeting: as her user or as a group that she's reprensenting? +|With which identity they want to create this meeting: as their user or as a group that they are reprensenting? |=== After creating the meeting, participants can also edit and xref:components/meetings/close.adoc[close] it. diff --git a/docs/ca/modules/admin/pages/components/meetings/registrations.adoc b/docs/ca/modules/admin/pages/components/meetings/registrations.adoc index 71f3b3adb2..b8a7cfd6de 100644 --- a/docs/ca/modules/admin/pages/components/meetings/registrations.adoc +++ b/docs/ca/modules/admin/pages/components/meetings/registrations.adoc @@ -81,7 +81,7 @@ The exported data will have these fields: * code: the xref:_registration_code[registration code] (if this feature is enabled) * user/name: the name of the user * user/email: the email of the user -* user/user_group: the group of the user if she has selected that's representing a group when registering +* user/user_group: the group of the user if they have selected that's representing a group when registering == Invitations @@ -92,7 +92,7 @@ image:components/meetings/registrations/invite_attendee.png[Invite attendee for == Registration code -This feature allows you to check if the attendee is registered in the meeting. She needs to provide her code, that gets +This feature allows you to check if the attendee is registered in the meeting. They need to provide their code, that gets entered in this form and it's checked against the database. image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting] diff --git a/docs/ca/modules/admin/pages/components/proposals.adoc b/docs/ca/modules/admin/pages/components/proposals.adoc index 5d2b652324..808fb78693 100644 --- a/docs/ca/modules/admin/pages/components/proposals.adoc +++ b/docs/ca/modules/admin/pages/components/proposals.adoc @@ -68,8 +68,8 @@ For instance, if you have two components, "Proposals" with weight "10" and "Meet |Minimum supports per user |Optional -|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If she doesn't -reach this number, her supports will not be taken in account. +|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If they don't +reach this number, their supports will not be taken in account. |Proposal limit per participant |Optional @@ -322,7 +322,7 @@ image:components/proposals/new_proposal_frontend.png[New proposal form] Proposals can be created by participants if the setting is "Proposal creation enabled" is checked for the active phase. -If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create proposals as that group also. +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create proposals as that group also. This form depends a lot in which settings you've enabled in this component. It can be really short (with only a Title and Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, Image and Attachment). diff --git a/docs/ca/modules/admin/pages/components/proposals/amendments.adoc b/docs/ca/modules/admin/pages/components/proposals/amendments.adoc index be89e58eb5..1bc4fd0b75 100644 --- a/docs/ca/modules/admin/pages/components/proposals/amendments.adoc +++ b/docs/ca/modules/admin/pages/components/proposals/amendments.adoc @@ -42,7 +42,7 @@ image:components/proposals/amendments/amendment_list.png[] image:components/proposals/amendments/amendment_view_side_by_side.png[] . It's also possible to filter the amended proposals image:components/proposals/amendments/amendment_list_filter.png[] -. Alice receives a notification that Bob has proposed an amendment to her original proposal +. Alice receives a notification that Bob has proposed an amendment to their original proposal image:components/proposals/amendments/proposal_amendmed_notification.png[] . Alice can see the amendment proposal image:components/proposals/amendments/proposal_amendmed_to_review.png[] diff --git a/docs/ca/modules/admin/pages/components/proposals/collaborative_drafts.adoc b/docs/ca/modules/admin/pages/components/proposals/collaborative_drafts.adoc index 9c26ef25e2..ef2c4cb7b3 100644 --- a/docs/ca/modules/admin/pages/components/proposals/collaborative_drafts.adoc +++ b/docs/ca/modules/admin/pages/components/proposals/collaborative_drafts.adoc @@ -6,7 +6,7 @@ It's useful to propose improvements or corrections. It has similarities with xref:components/proposals/amendments.adoc[Amendments] but the main difference is that with collaborative drafts there is a need to trust other authors, as they can make any change to the original proposal without approval by the -original author, although the original author can decide if she promotes the collaborative draft as a proposal. +original author, although the original author can decide if they promote the collaborative draft as a proposal. image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[Collaborative draft with request access button] @@ -24,7 +24,7 @@ For instance, it could be "Processes", "Assemblies", or "Conferences" == How it works -. A participant (Alice) wants to create a collaborative draft. For that, she goes to the proposals list page. +. A participant (Alice) wants to create a collaborative draft. For that, they go to the proposals list page. . Alice clicks in the "Access collaborative drafts" button image:components/proposals/collaborative_drafts/proposals_list01.png[] . Alice clicks in "New collaborative draft" button @@ -40,7 +40,7 @@ image:components/proposals/collaborative_drafts/collaborative_draft_request_acce image:components/proposals/collaborative_drafts/access_requested.png[] . Alice receives the notification image:components/proposals/collaborative_drafts/notification.png[] -. Alice goes to the collaborative draft. There she can accept or reject the collaboration request +. Alice goes to the collaborative draft. There they can accept or reject the collaboration request image:components/proposals/collaborative_drafts/author_sidebar.png[] . Alice approves the collaboration request. Once a request is approved it can't be rejected . Now the collaborative draft has multiple authors @@ -53,7 +53,7 @@ image:components/proposals/collaborative_drafts/collaborative_draft_edited.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_01.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_02.png[] -. Once Alice is satisfied with the collaborative draft, she can publish it by click in the "Publish" button +. Once Alice is satisfied with the collaborative draft, they can publish it by click in the "Publish" button image:components/proposals/collaborative_drafts/publish_modal.png[] . When it's published it becomes a proposal image:components/proposals/collaborative_drafts/proposal.png[] diff --git a/docs/ca/modules/admin/pages/features/badges.adoc b/docs/ca/modules/admin/pages/features/badges.adoc index 6cf9a138d3..7d546a113e 100644 --- a/docs/ca/modules/admin/pages/features/badges.adoc +++ b/docs/ca/modules/admin/pages/features/badges.adoc @@ -5,16 +5,16 @@ and interacting in the platform, they will earn different badges. Here is the li It's a https://en.wikipedia.org/wiki/Gamification[gamification] mechanism to improve the engagement of the participants in a ludic way. -The badges a participant has are visible in her account. There's also a general explanation page with a short description of every badge. +The badges a participant has are visible in their account. There's also a general explanation page with a short description of every badge. image:features/badges/example01.png[Example of badges in profile] -When a participant earns a badge she receives a notification. +When a participant earns a badge they receive a notification. image:features/badges/notification.png[Example of badges notification] -Badges have multiple levels, depending in the number of times she has made the action. For instance, for Proposals badge -she'll receive the first level badge when arriving at 1 follower, the second level at 15 followers, the third level at 30 followers, +Badges have multiple levels, depending in the number of times they have made the action. For instance, for Proposals badge +they will receive the first level badge when arriving at 1 follower, the second level at 15 followers, the third level at 30 followers, the fourth level at 60 and the fifth level at 100. @@ -25,14 +25,14 @@ the fourth level at 60 and the fifth level at 100. |image:features/badges/accepted_proposals_badge.png[Accepted proposals badge] |Accepted proposals |Granted when particiapnts actively participate with new proposals and these are accepted. -|The participant needs to choose the participation space of her interest with submission for proposals enabled and try to +|The participant needs to choose the participation space of their interest with submission for proposals enabled and try to make proposals that can be carried out. This way they are more likely to be accepted. |1, 5, 15, 30, 50 |image:features/badges/attended_meetings_badge.png[Attended meetings badge] |Attended meetings |Granted when participants attend several face-to-face meetings. -|The participant needs to register for the meetings she want to attend +|The participant needs to register for the meetings they want to attend |1, 3, 5, 10, 30 |image:features/badges/debates_badge.png[Debates badge] @@ -45,7 +45,7 @@ make proposals that can be carried out. This way they are more likely to be acce |Followers |Granted when participant reach a certain number of followers. The platform is a social and political network, so participants ned to weave their web to communicate with other people in the platform. -|The participant needs to be be active and follow other people. That will surely make other people follow her. +|The participant needs to be be active and follow other people. That will surely make other people follow them. |1, 15, 30, 60, 100 |image:features/badges/published_initiatives_badge.png[Published initiatives badge] @@ -57,20 +57,20 @@ participants ned to weave their web to communicate with other people in the plat |image:features/badges/invitations_badge.png[invitations badge] |Invitations |Granted when participants invite some people and they have become participants. -|The participant needs to use the “invite friends” link on her user page to invite her friends. She can customize the -message she's sending. She’ll level up by sending invitations and getting them registered. Note that this feature is disabled +|The participant needs to use the “invite friends” link on their user page to invite their friends. They can customize the +message they are sending. They will level up by sending invitations and getting them registered. Note that this feature is disabled and this badge is not available, so it'll be removed in the future. |1, 5, 10, 30, 50 |image:features/badges/proposal_supports_badge.png[Proposal supports badge] |Proposal supports |Granted when participants support other people's proposals. -|The participant needs to browse and spend some time reading other people's proposals and give support to the proposals she like or find interesting. +|The participant needs to browse and spend some time reading other people's proposals and give support to the proposals they like or find interesting. |5, 15, 50, 100, 500 |image:features/badges/proposals_badge.png[Proposals badge] |Proposals |Granted when participants actively participate with new proposals. -|The participant needs to choose the participation space of her interest with submission for proposals enabled and create a new proposal. +|The participant needs to choose the participation space of their interest with submission for proposals enabled and create a new proposal. |1, 5, 10, 30, 60 |=== \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/features/endorsements.adoc b/docs/ca/modules/admin/pages/features/endorsements.adoc index b407e0ca97..90b2f56ab5 100644 --- a/docs/ca/modules/admin/pages/features/endorsements.adoc +++ b/docs/ca/modules/admin/pages/features/endorsements.adoc @@ -8,7 +8,7 @@ This is done through the button in the sidebar. Administrators can enable or dis image:features/endorsements/sidebar.png[Endorsement button in sidebar] -When a participant belongs to a verified group she can also endorse like that group by selecting the identity. +When a participant belongs to a verified group they can also endorse like that group by selecting the identity. image:features/endorsements/modal.png[Select identity modal] diff --git a/docs/ca/modules/admin/pages/features/my_account.adoc b/docs/ca/modules/admin/pages/features/my_account.adoc index f15dc1f51e..67c0baefad 100644 --- a/docs/ca/modules/admin/pages/features/my_account.adoc +++ b/docs/ca/modules/admin/pages/features/my_account.adoc @@ -1,6 +1,6 @@ = My account -My account is all the pages where a participant can change her personal data that is displayed in her xref:admin:features/my_public_profile.adoc[My public profile] page, change her notifications settings, see which groups she belongs, etc. +My account is all the pages where a participant can change their personal data that is displayed in their xref:admin:features/my_public_profile.adoc[My public profile] page, change their notifications settings, see which groups they belong to, etc. To go to this section: @@ -8,7 +8,7 @@ To go to this section: . Click in the name of the participant in the header . Click in "My account" -The actions that she can do are: +The actions that they can do are: * xref:admin:features/my_account/account.adoc[Account] * xref:admin:features/my_account/notifications_settings.adoc[Notifications settings] diff --git a/docs/ca/modules/admin/pages/features/my_account/account.adoc b/docs/ca/modules/admin/pages/features/my_account/account.adoc index 9eb98b406b..115a68a819 100644 --- a/docs/ca/modules/admin/pages/features/my_account/account.adoc +++ b/docs/ca/modules/admin/pages/features/my_account/account.adoc @@ -28,7 +28,7 @@ The service crops the image. Maximum file size: 5MB |Your email |Required -|The email of the participant, where she'll receive notifications, password recovery, etc. If it's changed it needs to be +|The email of the participant, where they will receive notifications, password recovery, etc. If it's changed it needs to be confirmed. |Personal URL diff --git a/docs/ca/modules/admin/pages/features/my_account/delete_my_account.adoc b/docs/ca/modules/admin/pages/features/my_account/delete_my_account.adoc index 8ba403a53e..3522a1c183 100644 --- a/docs/ca/modules/admin/pages/features/my_account/delete_my_account.adoc +++ b/docs/ca/modules/admin/pages/features/my_account/delete_my_account.adoc @@ -10,7 +10,7 @@ To delete the account: . Click in the name of the participant in the header . Click in "My account" . Click in "Delete my account" in the sidebar -. Optionally, she can provide a reason for the deletion +. Optionally, they can provide a reason for the deletion . Click in "Delete my account" . Click in "Yes, I want to delete my account" diff --git a/docs/ca/modules/admin/pages/features/notifications.adoc b/docs/ca/modules/admin/pages/features/notifications.adoc index 18006f9c47..1d5a122581 100644 --- a/docs/ca/modules/admin/pages/features/notifications.adoc +++ b/docs/ca/modules/admin/pages/features/notifications.adoc @@ -1,5 +1,7 @@ = Notifications +== The notification menu + Most of the actions in the platform generate notifications so particpants can know when there are new things to watch. This is accessible from the `Notifications` menu item (image:icon_bell.png[Notification icon]) in the header, after a participant has logged in. @@ -13,4 +15,216 @@ If there are notifications, then the participant will see the icon with a color image:features/notifications/notifications.png[Example of notifications page when there are notifications] -image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] \ No newline at end of file +image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] + +== Notifications list + +Below is an exhaustive list of actions that trigger notifications to participants. Participants are divided into three categories: affected users, followers, and administrators. + +[NOTE] +==== +Affected users depend on the notification context. For instance, it could be the author of moderated content, a user that earns a badge, a user that has been mentioned, etc. +==== + +[cols="7,2,1,1,1"] +|=== +|Action |Feature |Affected user |Follower |Administrator + +|A new attachment has been created |Admin |❌ |✅ |❌ + +|An admin requested an export |Admin |❌ |❌ |✅ + +|A component has been published in a participatory space |Admin |❌ |✅ |❌ + +|A participant has tried to verify themself with the data of another participant |Verifications |❌ |❌ |✅ + +|An administrator moderated a resource because it has been reported |Moderation |✅ |❌ |❌ + +|A resource has been reported |Moderation |❌ |❌ |✅ + +|A user confirms the registration (if welcome notification is enabled) |User |✅ |❌ |❌ + +|A user earned a badge (if badges are enabled) |User |✅ |❌ |❌ + +|A user has reached a new badge level (if badges are enabled) |User |✅ |❌ |❌ + +|A user has been officialized |User |❌ |❌ |✅ + +|A user asked their data export |User |✅ |❌ |❌ + +|A user I follow endorsed a resource |User |❌ |✅ |❌ + +|A public profile has been updated |User |❌ |✅ |❌ + +|A new user group has been created |User groupsfootnote:user-group[If user groups are enabled] |❌ |❌ |✅ + +|A user group has updated its profile |User groupsfootnote:user-group[] |❌ |❌ |✅ + +|A user has been invited to join a user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user has been promoted as group admin |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user requested to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request has been accepted to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request to join the user group has been rejected |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The group admin has been demoted |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The user has been removed from the group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|An admin of the assembly has added you as one of its members |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the assembly |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the participatory process |Processes |✅ |❌ |❌ + +|The phases dates have been updated |Processes |❌ |✅ |❌ + +|A new phase has been activated |Processes |❌ |✅ |❌ + +|You have been assigned a role for the conference |Conferences |✅ |❌ |❌ + +|The registration to the conference has been confirmed |Conferences |✅ |❌ |❌ + +|The registration for the conference is open |Conferences |❌ |✅ |❌ + +|The conference occupied slots are over X% |Conferences |❌ |❌ |✅ + +|The conference is taking place in 2 days |Conferences |❌ |✅ |❌ + +|The conference has been updated |Conferences |❌ |✅ |❌ + +|The election is now active for the participatory space |Elections |❌ |✅ |❌ + +|You are added as a trustee for the election |Elections |✅ |❌ |❌ + +|An admin has added you as trustee |Elections |✅ |❌ |❌ + +|Your vote was accepted |Elections |✅ |❌ |❌ + +|You have been assigned a role of the Polling Station |Elections |✅ |❌ |❌ + +|Here is your Access Code |Elections |✅ |❌ |❌ + +|A user I follow created an initiative |Initiatives |❌ |✅ |❌ + +|My initiative has been created |Initiatives |✅ |❌ |❌ + +|A user I follow endorsed an initiative |Initiatives |❌ |✅ |❌ + +|A user sent their initiative to technical validation |Initiatives |❌ |❌ |✅ + +|The initiative has changed its status |Initiatives |✅ |✅ |❌ + +|The signatures end date for the initiative have been extended |Initiatives |❌ |✅ |❌ + +|The request to be part of the promoter committee for the initiative has been accepted |Initiatives |✅ |❌ |❌ + +|The request to be part of the promoter committee for the initiative has been rejected |Initiatives |✅ |❌ |❌ + +|A user wants to join your initiative |Initiatives |✅ |❌ |❌ + +|The initiative has reached the signatures threshold |Initiatives |❌ |❌ |✅ + +|Your initiative has achieved the X% of signatures |Initiatives |❌ |✅ |❌ + +|The initiative has achieved the X% of signatures |Initiatives |✅ |❌ |❌ + +|The proposal has been included in a result |Accountability |❌ |✅ |❌ + +|The result progress has been updated |Accountability |❌ |✅ |❌ + +|A post has been published |Blogs |❌ |✅ |❌ + +|The budget is now active |Budgets |❌ |✅ |❌ + +|A resource has a comment |Comments |❌ |✅ |❌ + +|A user group has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has replied your comment |Comments |✅ |❌ |❌ + +|A group you belong to has been mentioned |Comments |✅ |❌ |❌ + +|You have been mentioned |Comments |✅ |❌ |❌ + +|Your comment in has been upvoted |Comments |✅ |❌ |❌ + +|Your comment in has been downvoted |Comments |✅ |❌ |❌ + +|A debate has been created |Debates |❌ |✅ |❌ + +|Debate creation is enabled for participants |Debates |❌ |✅ |❌ + +|Debate creation is no longer active |Debates |❌ |✅ |❌ + +|The debate was closed |Debates |✅ |✅ |❌ + +|A meeting has been created |Meetings |❌ |✅ |❌ + +|A meeting was closed |Meetings |✅ |✅ |❌ + +|A meeting was updated |Meetings |❌ |✅ |❌ + +|Your meeting's registration has been confirmed |Meetings |✅ |❌ |❌ + +|The allocated slots for the meeting are over X% |Meetings |❌ |❌ |✅ + +|The meeting has enabled registrations |Meetings |❌ |✅ |❌ + +|The registration code for the meeting has been validated. |Meetings |✅ |❌ |❌ + +|The meeting will start in less than 48h |Meetings |❌ |✅ |❌ + +|A new proposal has been published |Proposals |❌ |✅ |❌ + +|Proposal creation is open |Proposals |❌ |✅ |❌ + +|Proposal supports are open |Proposals |❌ |✅ |❌ + +|Proposal endorsements are open |Proposals |❌ |✅ |❌ + +|Someone has left a note on the proposal |Proposals |❌ |❌ |✅ + +|A proposal is currently being evaluated |Proposals |✅ |✅ |❌ + +|A proposal has been rejected |Proposals |✅ |✅ |❌ + +|A proposal has been accepted |Proposals |✅ |✅ |❌ + +|An admin has updated the scope of your proposal |Proposals |✅ |❌ |❌ + +|An admin has updated the category of your proposal |Proposals |✅ |❌ |❌ + +|A proposal has been mentioned |Proposals |✅ |❌ |❌ + +|A user requested access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user withdrawn the collaborative draft |Proposal drafts |✅ |❌ |❌ + +|An amendment has been rejected |Amendmentsfootnote:amendments[If amendments are enabled] |✅ |✅ |❌ + +|An amendment has been accepted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been created |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been promoted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|A sortition has been created |Sortitions |❌ |✅ |❌ + +|A survey has been opened |Surveys |❌ |✅ |❌ + +|A survey has been closed |Surveys |❌ |✅ |❌ +|=== \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/global_moderations.adoc b/docs/ca/modules/admin/pages/global_moderations.adoc index bb3d553310..ce8d81dee3 100644 --- a/docs/ca/modules/admin/pages/global_moderations.adoc +++ b/docs/ca/modules/admin/pages/global_moderations.adoc @@ -36,8 +36,8 @@ the https://www.decidim.barcelona/pages/terms-and-conditions[Terms of Service] s > * to create multiple users by pretending to be different people (astroturfing). Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant -profile. After a participant has clicked in this action then she needs to provide a -reason why she's making this report: +profile. After a participant has clicked in this action then they need to provide a +reason why they are making this report: * Contains clickbait, advertising, scams or script bots. * Contains racism, sexism, slurs, personal attacks, death threats, suicide requests or any form of hate speech. diff --git a/docs/ca/modules/admin/pages/help_sections.adoc b/docs/ca/modules/admin/pages/help_sections.adoc index 7e942f55d7..9be6d5e3d7 100644 --- a/docs/ca/modules/admin/pages/help_sections.adoc +++ b/docs/ca/modules/admin/pages/help_sections.adoc @@ -1,6 +1,6 @@ = Help sections -The first time a visitor goes to any Space page she'll see an information box about what's this Space about. +The first time a visitor goes to any Space page they will see an information box about what's this Space about. This is how the information box is shown to participants and visitors: diff --git a/docs/ca/modules/admin/pages/newsletters.adoc b/docs/ca/modules/admin/pages/newsletters.adoc index 7c3c069551..cddc909cf4 100644 --- a/docs/ca/modules/admin/pages/newsletters.adoc +++ b/docs/ca/modules/admin/pages/newsletters.adoc @@ -141,8 +141,8 @@ the selected participatory spaces in the list * Sending the newsletter to all the participants that have selected an scope in their "My interests" settings in their account. -It's important to note that even if a participant has confirmed its account and -is following the space, the system will not send her a newsletter email if she +It's important to note that even if a participant has confirmed their account and +is following the space, the system will not send them a newsletter email if they haven't activated the "I want to receive newsletters". image::newsletter_select_recipients.png[Newsletter select recipients] diff --git a/docs/ca/modules/admin/pages/pages.adoc b/docs/ca/modules/admin/pages/pages.adoc index 70e77220cd..b68fbc4592 100644 --- a/docs/ca/modules/admin/pages/pages.adoc +++ b/docs/ca/modules/admin/pages/pages.adoc @@ -100,11 +100,11 @@ image::pages_backend_tos_change.png[Backend: ToS change] image::pages_frontend_tos_change.png[Frontend: ToS change] -If a participant rejects to accept the terms, then she has three options: +If a participant rejects to accept the terms, then they have three options: -. To review this again later. It signs her out automatically. +. To review this again later. It signs them out automatically. . To download their personal data -. To delete her account +. To delete their account image::pages_frontend_tos_reject.png[Frontend: ToS reject] diff --git a/docs/ca/modules/admin/pages/participants/admins.adoc b/docs/ca/modules/admin/pages/participants/admins.adoc index f88bcff92b..0746ef9183 100644 --- a/docs/ca/modules/admin/pages/participants/admins.adoc +++ b/docs/ca/modules/admin/pages/participants/admins.adoc @@ -11,7 +11,7 @@ Here you can: * see when was the last time an administrator logged in For inviting a new administrator, you need to go to the button "New user" and fill -the form with the admin username, email and which role will she have: +the form with the admin username, email and which role will they have: * Admin: to give full access to the platform * Participant manager: to give permission to only do xref:admin:participants/impersonations.adoc[Impersonations] diff --git a/docs/ca/modules/admin/pages/participants/authorizations.adoc b/docs/ca/modules/admin/pages/participants/authorizations.adoc index 3937fffc92..022397e249 100644 --- a/docs/ca/modules/admin/pages/participants/authorizations.adoc +++ b/docs/ca/modules/admin/pages/participants/authorizations.adoc @@ -8,7 +8,7 @@ With authorizations an administrator can define different permissions so partici For instance you can configure that only participants who have verified herselves by their identity documents can vote on proposals in a participatory process. -A participant can see which authorizations does she have available in her account settings. +A participant can see which authorizations do they have available in their account settings. image:authorizations_account.png[Authorizations in participants account] diff --git a/docs/ca/modules/admin/pages/participants/authorizations/census.adoc b/docs/ca/modules/admin/pages/participants/authorizations/census.adoc index b7e2cfbb9d..bc81ab9578 100644 --- a/docs/ca/modules/admin/pages/participants/authorizations/census.adoc +++ b/docs/ca/modules/admin/pages/participants/authorizations/census.adoc @@ -15,7 +15,7 @@ In the admin panel, the administrator can review the request by going to the "Or image:authorizations_organization_census.png[Organization's census in admin panel] -After the CSV is imported then the administrator can see how many participants where imported. She can also delete this +After the CSV is imported then the administrator can see how many participants where imported. They can also delete this imported census. image:authorizations_organization_census_imported.png[Imported CSV] @@ -29,6 +29,6 @@ image:authorizations_organization_census_account.png[Organization's census in pa == 3. The participant is verified (or not) -After is verified, as with other verifications, she can see it in her account settings. +After is verified, as with other verifications, they can see it in their account settings. image:authorizations_organization_census_verified.png[Verified by organization's census] \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/participants/authorizations/code_postal_letter.adoc b/docs/ca/modules/admin/pages/participants/authorizations/code_postal_letter.adoc index 953c5c0eb0..7ad078d0f9 100644 --- a/docs/ca/modules/admin/pages/participants/authorizations/code_postal_letter.adoc +++ b/docs/ca/modules/admin/pages/participants/authorizations/code_postal_letter.adoc @@ -1,7 +1,7 @@ = Code by postal letter authorization -This authorization allows a participant to request for a verification code to be sent to its address, to confirm that she -lives or works in this place. She'll need to then fill the code in the platform. +This authorization allows a participant to request for a verification code to be sent to its address, to confirm that they +live or work in this place. They will need to then fill the code in the platform. The process is: @@ -9,16 +9,16 @@ The process is: . An administrator sends the letter to their address with the verification code. . An administrator marks the letter as sent. . Once you mark the letter as sent, the participant will be able to introduce the code. -. If this code matchs, then she gets verified. +. If this code matchs, then they get verified. == 1. A participant request the verification code By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for filling in her full address to request the verification code. +a participant can see the form for filling in their full address to request the verification code. image:authorizations_code_postal_letter_request.png[Code by postal letter request by participant] -If she tries to edit it, she'll see this message: +If they try to edit it, they will see this message: image:authorizations_code_postal_letter_edit.png[Edit the postal letter request] @@ -31,17 +31,17 @@ In the admin panel, the administrator can review the request by going to the "Co image:authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in admin] -Here she can see the verification code and can send it to the participant by mail. After the code is sent she can mark it +Here they can see the verification code and can send it to the participant by mail. After the code is sent they can mark it as sent with the icon image:action_mark_as_sent.png[Mark as sent]. It'll also show when the letter was sent. == 3. A participant fills in the verification code -After the participant has received the code, she can go to it's account settings and click in the "Code by postal letter" +After the participant has received the code, they can go to their account settings and click in the "Code by postal letter" verfication method. image:authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account] -Then she'll see the form for confirming the code. +Then they will see the form for confirming the code. image:authorizations_code_postal_letter_confirm.png[Code by postal letter confirmation form] @@ -52,6 +52,6 @@ If the verification code matches, then the participant will see the message "Con On the other hand, if the verification code doesn't match, then the participant will see the message "Your verification code doesn't match ours. Please double-check the letter we sent to you." -After is verified, as with other verifications, she can see it in her account settings. +After is verified, as with other verifications, they can see it in their account settings. image:authorizations_code_postal_letter_verified.png[Verified by code by postal letter] \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/participants/authorizations/identity_documents.adoc b/docs/ca/modules/admin/pages/participants/authorizations/identity_documents.adoc index 2502903d6a..bff9992031 100644 --- a/docs/ca/modules/admin/pages/participants/authorizations/identity_documents.adoc +++ b/docs/ca/modules/admin/pages/participants/authorizations/identity_documents.adoc @@ -6,7 +6,7 @@ they could be a driver's license, a passport, a national identity card, a club m These documents will be reviewed by an administrator to accept or reject them. It's possible to do this process in two ways: Online or Offline. * Online: the participant will be asked to upload the documents, and the administrator will review these documents. -* Offline: the participant will be asked to fill in some data, and then she'll need to go to a presential place to show her documents face to face. +* Offline: the participant will be asked to fill in some data, and then they will need to go to a presential place to show their documents face to face. == Configuration @@ -42,13 +42,13 @@ The process is: . Participants fill in their document type and number and upload a copy of their document. . An administrator fills in the information present in the uploaded image. . The information should match whatever the user filled in. -. If the administrator can't clearly see the information or she can't get it verified, she can reject the request and +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and the user will be able to fix it. -=== 1. A participant fill in the document information and upload a copy of her document +=== 1. A participant fill in the document information and uploads a copy of their document By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for uploading a copy of her document. She also needs to fill in her document type and number. +a participant can see the form for uploading a copy of their document. They also need to fill in their document type and number. image:authorizations_id_document_online.png[ID document authorization online form] @@ -69,7 +69,7 @@ image:authorizations_id_document_online_confirm.png[ID document authorization on There are two actions an admin can do: * Accept: the participant will be fully authorized. -* Reject: the participant will be prompted to amend her documents +* Reject: the participant will be prompted to amend their documents If the request is rejected then the participant can provide other pictures or document. @@ -84,7 +84,7 @@ The process is: specific time to show their documents. . An administrator go to the "Offline verification" panel and fills in the information present in the physical documents. . The information should match whatever the user filled in. -. If the administrator can't clearly see the information or she can't get it verified, she can reject the request and +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and the user will be able to fix it. For this authorization to work, an administrator need to first configure it in the admin panel with the instructions explaining @@ -95,7 +95,7 @@ image:authorizations_id_document_configuration_offline.png[ID document authoriza === 1. A participant fill in the document information and follow the instructions By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for filling in her document type and number. +a participant can see the form for filling in their document type and number. image:authorizations_id_document_offline_request.png[ID document authorization offline form] @@ -105,7 +105,7 @@ In the admin panel, the administrator can review the request by clicking in the image:authorizations_id_document_offline_button.png[ID document authorization offline button in admin] -Then she'll need to fill some data provided by the participant and by reviewing the document physically provided by her. +Then they will need to fill some data provided by the participant and by reviewing the document physically provided by them. image:authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in admin] @@ -130,12 +130,12 @@ image:authorizations_id_document_offline_confirm.png[ID document authorization o === 3. The request is accepted or rejected In the cases where the verifications don't match (meaning that the email or the document number provided by the -participant and the ones filled by the administrators aren't the same), then the participant need to ammend it with her +participant and the ones filled by the administrators aren't the same), then the participant needs to amend it with their user account. == Both It's also possible to enable both of these verifications methods. In this case, the participant will be asked to choose -which kind of verification she wants to do. +which kind of verification they want to do. image:authorizations_id_document_account_choose.png[Choose ID document verification kind] \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/participants/groups.adoc b/docs/ca/modules/admin/pages/participants/groups.adoc index 3201f6fac9..3a40bc859e 100644 --- a/docs/ca/modules/admin/pages/participants/groups.adoc +++ b/docs/ca/modules/admin/pages/participants/groups.adoc @@ -4,7 +4,7 @@ An user group is a group of participants. Depending in the installation and the == Creation -This action is done by **a participant**. She needs to go to their profile and in the sidebar there's a button that says "Create group": +This action is done by **a participant**. They need to go to their profile and in the sidebar there's a button that says "Create group": image:user_sidebar.png[User sidebar] @@ -48,7 +48,7 @@ image:user_group_new_form.png[New user group form] == Membership -After a group has been created, it's possible to invite participants to become members of the group. After a participant has accepted to be part of this group then she can become an admin. +After a group has been created, it's possible to invite participants to become members of the group. After a participant has accepted to be part of this group then they can become an admin. The actions that can be done by a participant in the user group are: diff --git a/docs/ca/modules/admin/pages/participants/impersonations.adoc b/docs/ca/modules/admin/pages/participants/impersonations.adoc index 9cd1788be5..05979cfe5f 100644 --- a/docs/ca/modules/admin/pages/participants/impersonations.adoc +++ b/docs/ca/modules/admin/pages/participants/impersonations.adoc @@ -36,7 +36,7 @@ After this data is confirmed then there'll be a session for the participant for image::participants_impersonations_user.png[Impersonated user session] Finally, it's also possible to Promote a participant, meaning that after a -participant has been managed, an administrator can add the email and send her +participant has been managed, an administrator can add the email and send them an Invitation: image::participants_impersonations_promotion.png[Admin's promotion Impersonations] \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/participants/participants.adoc b/docs/ca/modules/admin/pages/participants/participants.adoc index e76ab358b4..64e5d2ec77 100644 --- a/docs/ca/modules/admin/pages/participants/participants.adoc +++ b/docs/ca/modules/admin/pages/participants/participants.adoc @@ -2,7 +2,7 @@ In this page an administrator can: -* Block a participant, for instance because she's spamming or acting against the Terms of Service +* Block a participant, for instance because they are spamming or acting against the Terms of Service * Contact a participant with Decidim private messages (Conversations) * Officialize a participant * See its email @@ -48,7 +48,7 @@ blocking this participant: image:participants_block_user_justification.png[Justificate the blocked user action] -Once a blocked participant tries to log-in she'll see an error message: +Once a blocked participant tries to log-in they will see an error message: image:participants_block_user_alert.png[Message shown to blocked user] @@ -58,7 +58,7 @@ See more at xref:admin:participants/reported_users.adoc[Reported users] === Show email address -After clicking this option, the admin will see a modal. She'll have to click in +After clicking this option, the admin will see a modal. They will have to click in button "Show email address". image:participants_show_email.png[Modal in show email] diff --git a/docs/ca/modules/admin/pages/participants/reported_users.adoc b/docs/ca/modules/admin/pages/participants/reported_users.adoc index 6616b10c2b..855316b7f4 100644 --- a/docs/ca/modules/admin/pages/participants/reported_users.adoc +++ b/docs/ca/modules/admin/pages/participants/reported_users.adoc @@ -8,8 +8,8 @@ A participant can be blocked from the xref:participants/participants.adoc[partic section in the admin panel] or through this "Reported users" section. Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant -profile. After a participant has clicked in this action she needs to provide a -reason why she's making this report: +profile. After a participant has clicked in this action they need to provide a +reason why they are making this report: * Contains clickbait, advertising, scams or script bots. * Contains racism, sexism, slurs, personal attacks, death threats, suicide requests @@ -26,7 +26,7 @@ blocking this participant: image:participants_block_user_justification.png[Justificate the blocked user action] -Once a blocked participant tries to log-in she'll see an error message: +Once a blocked participant tries to log-in they will see an error message: image:participants_block_user_alert.png[Message shown to blocked user] diff --git a/docs/ca/modules/admin/pages/participants/verifications_conflicts.adoc b/docs/ca/modules/admin/pages/participants/verifications_conflicts.adoc index 1e14b977f6..4e6afbfb07 100644 --- a/docs/ca/modules/admin/pages/participants/verifications_conflicts.adoc +++ b/docs/ca/modules/admin/pages/participants/verifications_conflicts.adoc @@ -4,8 +4,8 @@ There are cases depending on which kind of verifications you've enabled that the For instance: -. A participant get xref:admin:participants/impersonations.adoc[impersonated], and she doesn't provide an email -. Then she creates an account and tries to verify herself with the Census verification +. A participant get xref:admin:participants/impersonations.adoc[impersonated], and they don't provide an email +. Then they create an account and try to verify themselves with the Census verification For security, we try to be extra cautious in these cases, and we want that an administrator reviews these verifications. As you can see, this depends a lot on which kind of verifications you've enabled in your organization, so it's easy to say @@ -17,7 +17,7 @@ image:verifications_conflicts.png[Verification's conflicts panel] An administrator can review these conflicts by clicking in the Transfer user image:action_transfer_user.png[Transfer user] icon. -Then she'll see the Transfer user form, where she can provide a reason for the transfer. +Then they will see the Transfer user form, where they can provide a reason for the transfer. image:verifications_conflicts_transfer_user.png[] diff --git a/docs/ca/modules/admin/pages/scopes.adoc b/docs/ca/modules/admin/pages/scopes.adoc index e189ca92cb..a528c1eb9f 100644 --- a/docs/ca/modules/admin/pages/scopes.adoc +++ b/docs/ca/modules/admin/pages/scopes.adoc @@ -96,7 +96,7 @@ On a participatory space which concerns only one of the cities, you will be able === User interests and Newsletters -A Participant can choose which Scopes she wants to follow in its account. +A Participant can choose which Scopes they want to follow in its account. image:account_my_interests.png[Account: my interests] diff --git a/docs/ca/modules/admin/pages/spaces/assemblies/members.adoc b/docs/ca/modules/admin/pages/spaces/assemblies/members.adoc index 64a7159a8f..6668e828db 100644 --- a/docs/ca/modules/admin/pages/spaces/assemblies/members.adoc +++ b/docs/ca/modules/admin/pages/spaces/assemblies/members.adoc @@ -28,7 +28,7 @@ image:assembly_members_new_form.png[Assembly members new form] |Participant type |Required -|Wheter this assembly member is non-participant or existing participant. Does she already have an account created on the platform? +|Wheter this assembly member is non-participant or existing participant. Do they already have an account created on the platform? |Full name |Required if it's non-participant. diff --git a/docs/ca/modules/admin/pages/spaces/conferences/registrations/invites.adoc b/docs/ca/modules/admin/pages/spaces/conferences/registrations/invites.adoc index bd02c5da95..4ffe30d645 100644 --- a/docs/ca/modules/admin/pages/spaces/conferences/registrations/invites.adoc +++ b/docs/ca/modules/admin/pages/spaces/conferences/registrations/invites.adoc @@ -18,7 +18,7 @@ image:spaces/conferences/invite_participant_form.png[Invite a participant form] |Attendee type |Required -|Wheter this invited person is a non-existing or existing participant. Does she already have an account created on the platform? +|Wheter this invited person is a non-existing or existing participant. Do they already have an account created on the platform? |Name |Required if it's a non-existing participant. diff --git a/docs/ca/modules/admin/pages/spaces/conferences/registrations/types.adoc b/docs/ca/modules/admin/pages/spaces/conferences/registrations/types.adoc index 1625887826..e1756b8391 100644 --- a/docs/ca/modules/admin/pages/spaces/conferences/registrations/types.adoc +++ b/docs/ca/modules/admin/pages/spaces/conferences/registrations/types.adoc @@ -51,6 +51,6 @@ image:spaces/conferences/registration_types_backend.png[Manage registration type |Select conference meetings |=== -If the participant is already logged in then she'll see her username and email in the registration page. +If the participant is already logged in then they will see their username and email in the registration page. image:spaces/conferences/registration_types_frontend_w_user.png[Select registration type with user account] \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/spaces/conferences/registrations/users.adoc b/docs/ca/modules/admin/pages/spaces/conferences/registrations/users.adoc index 33dc8d6b46..24e2468fc2 100644 --- a/docs/ca/modules/admin/pages/spaces/conferences/registrations/users.adoc +++ b/docs/ca/modules/admin/pages/spaces/conferences/registrations/users.adoc @@ -16,12 +16,12 @@ It's possible to export the registrations in multiple formats: CSV, JSON, and XL == Flow . A participant registers to the conference -. She receives a pending registration notification +. They receive a pending registration notification image:spaces/conferences/user_registration_pending_notification.png[Notification for pending user registration] -. She receives a pending registration email +. They receive a pending registration email image:spaces/conferences/user_registration_pending_email.png[Email for pending user registration] . An administrator reviews and confirms the registration with the image:action_check.png[Confirm] button . The participant receives a confirmed registration notification image:spaces/conferences/user_registration_confirmed_notification.png[Notification for confirmed user registration] -. She receives a confirmed registration email with an calendar file (.ICS). +. They receive a confirmed registration email with an calendar file (.ICS). image:spaces/conferences/user_registration_confirmed_email.png[Email for confirmed user registration] \ No newline at end of file diff --git a/docs/ca/modules/admin/pages/spaces/conferences/speakers.adoc b/docs/ca/modules/admin/pages/spaces/conferences/speakers.adoc index f62160a3e8..339f5a7256 100644 --- a/docs/ca/modules/admin/pages/spaces/conferences/speakers.adoc +++ b/docs/ca/modules/admin/pages/spaces/conferences/speakers.adoc @@ -26,7 +26,7 @@ image:spaces/conferences/new_speaker.png[Conferences speakers] |Participant type |Required -|Wheter this speaker is a non-participant or existing participant. Does she already have an account created on the platform? +|Wheter this speaker is a non-participant or existing participant. Do they already have an account created on the platform? |Full name |Required if it's non-participant. diff --git a/docs/ca/modules/admin/pages/spaces/initiatives.adoc b/docs/ca/modules/admin/pages/spaces/initiatives.adoc index 7abb57a326..f9dec1da31 100644 --- a/docs/ca/modules/admin/pages/spaces/initiatives.adoc +++ b/docs/ca/modules/admin/pages/spaces/initiatives.adoc @@ -90,7 +90,7 @@ image:admin_initiative_type.png[New initiative type form] |Collect participant personal data on signature |Optional -|Adds a step to the signature process. When a participant clicks on the signature button, she'll be redirected to a form asking for some personal data. This will be used with the PDF export action after the recollection period has ended. +|Adds a step to the signature process. When a participant clicks on the signature button, they will be redirected to a form asking for some personal data. This will be used with the PDF export action after the recollection period has ended. |Legal information about the collection of personal data |Depends on whether the option "Collect participant personal data on the signature" is checked @@ -104,7 +104,7 @@ image:admin_initiative_type.png[New initiative type form] |Authorization to verify document number on signatures |Optional -|When a participant is making the signature process, will she be asked for an authorization? +|When a participant is making the signature process, will they be asked for an authorization? |Add SMS code validation step to the signature process | @@ -137,7 +137,7 @@ This action is done by **the author**. The author is a participant that creates image:initiative_list.png[Initiatives list] -For creating an initiative, a participant must click in the "New initiative" button. Then she'll have a wizard with multiple steps: +For creating an initiative, a participant must click in the "New initiative" button. Then they will have a wizard with multiple steps: === 1.1 Choose the initiative type @@ -181,7 +181,7 @@ image:initiative_print.png[Print an initiative] ==== Technical validation -After the author has reviewed how the initiative will look, she can send it to technical validation. +After the author has reviewed how the initiative will look, they can send it to technical validation. image:initiative_send_to_technical_validation.png[Send initiative to technical validation] diff --git a/docs/ca/modules/admin/pages/spaces/processes/types.adoc b/docs/ca/modules/admin/pages/spaces/processes/types.adoc new file mode 100644 index 0000000000..2e1c452b2b --- /dev/null +++ b/docs/ca/modules/admin/pages/spaces/processes/types.adoc @@ -0,0 +1,39 @@ += 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. + +Process Types work similarly to xref:admin:spaces/assemblies.adoc#_assemblies_types[Assembly types]. + +== New process type form + +For creating a new process type: + +. 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 + +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"] + + +.New participatory process type form: General information +|=== +|Field |Type |Description + +|Title +|Required +|Title of the participatory process type. For instance, "Consultative". +|=== + +== 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. + +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"] + +== Process type filter + +In the front-end if there is at least one Process Type defined, a filter shows, allowing filtering of Processes. + +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"] \ No newline at end of file diff --git a/docs/ca/modules/admin/partials/page_admins.adoc b/docs/ca/modules/admin/partials/page_admins.adoc index e4527970ba..db05cf9da8 100644 --- a/docs/ca/modules/admin/partials/page_admins.adoc +++ b/docs/ca/modules/admin/partials/page_admins.adoc @@ -28,7 +28,7 @@ image:spaces/admins_form.png[New space admin form] |Email |Required -|What is the email of the new admin, so she can receive the invitation. +|What is the email of the new admin, so they can receive the invitation. |Role |Required @@ -59,7 +59,7 @@ image:spaces/admins_role_moderator.png[Process moderators view] === Process valuators -A space valuator can review the proposals of the space. She can: +A space valuator can review the proposals of the space. They can: * change the status of the proposals, by accepting or rejecting them * add a monetary value to the proposals, so they can be voted with the budget component. diff --git a/docs/ca/modules/admin/partials/page_private_participants.adoc b/docs/ca/modules/admin/partials/page_private_participants.adoc index 90580396be..f5d5983d88 100644 --- a/docs/ca/modules/admin/partials/page_private_participants.adoc +++ b/docs/ca/modules/admin/partials/page_private_participants.adoc @@ -65,11 +65,11 @@ image:spaces/private_participants_actions.png[Private participants actions] == Invitation -When a participant was invited she'll get an email with a link for accepting the invitation: +When a participant was invited they will get an email with a link for accepting the invitation: image:spaces/private_participants_email_invite.png[Email invitation of a private participant] -After clicking in this email, she'll have to fill a form for setting her password, accepting the Terms of Service and giving -her consent if she wants to receive newsletters. +After clicking in this email, they will have to fill a form for setting their password, accepting the Terms of Service and giving +their consent if they want to receive newsletters. image:spaces/private_participants_user_registration_form.png[User registration form of a private participant] \ No newline at end of file diff --git a/docs/ca/modules/features/pages/general-description.adoc b/docs/ca/modules/features/pages/general-description.adoc index c54b27a835..e34d230c73 100644 --- a/docs/ca/modules/features/pages/general-description.adoc +++ b/docs/ca/modules/features/pages/general-description.adoc @@ -50,7 +50,7 @@ Administrators can *manage permissions* for registered or verified users selecti There are different types of administrators: *administrators* of the whole platform or of specific spaces and components, they can also be *moderators* (with the exclusive power of moderating proposals, comments or debates) or *collaborators* that can read unpublished content, create notes and responses to proposals. -Participants can register as an *individual* or as a *collective* (associations, working groups, etc. within the main organization). User *groups* might also be created so that individuals can be associated to a *group*. Decidim allows participants belonging to such a group to express or act individually or embodying the group identity: when an action is carried the platform prompts the participant to choose wether she wants to act as herself or as the group she belong to. +Participants can register as an *individual* or as a *collective* (associations, working groups, etc. within the main organization). User *groups* might also be created so that individuals can be associated to a *group*. Decidim allows participants belonging to such a group to express or act individually or embodying the group identity: when an action is carried the platform prompts the participant to choose wether they want to act as themselves or as the group they belong to. Participants can not only navigate the content of Decidim through the top menu and move down the architectural hierarchy, from a space to its different components; they can also get information through the *search engine*, or via *notifications*. Participants can also talk to each other by internal messaging or *chat*. diff --git a/docs/ca/modules/releases/pages/index.adoc b/docs/ca/modules/releases/pages/index.adoc index c9f9bc7423..f0af39d4f1 100644 --- a/docs/ca/modules/releases/pages/index.adoc +++ b/docs/ca/modules/releases/pages/index.adoc @@ -1,4 +1,4 @@ -= Releases += Release notes Here you can find all the blog posts for every minor release. @@ -6,6 +6,9 @@ You can find all the releases (with minor and patches) at https://rubygems.org/gems/decidim/versions[RubyGems.org] and https://github.com/decidim/decidim/releases[GitHub]. +* https://decidim.org/blog/2023-12-20-new-version-0-28-0/[Version 0.28 (2022-12-20)] +* https://decidim.org/blog/2022-09-30-new-version-0-27-0/[Version 0.27 (2022-09-30)] +* https://decidim.org/blog/2022-02-22-new-version-0-26-0/[Version 0.26 (2022-02-22)] * https://decidim.org/blog/2021-10-07-new-version-0-25-0/[Version 0.25 (2021-10-07)] ** xref:develop:guide_migrate_webpacker_module.adoc[Migrate to Webpacker a module] ** xref:develop:guide_migrate_webpacker_app.adoc[Migrate to Webpacker an instance app] diff --git a/docs/de/modules/ROOT/nav.adoc b/docs/de/modules/ROOT/nav.adoc new file mode 100644 index 0000000000..49f7b02049 --- /dev/null +++ b/docs/de/modules/ROOT/nav.adoc @@ -0,0 +1,233 @@ +* xref:install:index.adoc[Anfangen] +** xref:install:manual.adoc[Manuelle Installation] +** xref:install:checklist.adoc[Checklist] +** xref:install:update.adoc[Update] +* xref:configure:index.adoc[Configure] +** xref:configure:environment_variables.adoc[Umgebungsvariablen] +** xref:configure:initializer.adoc[Initializer] +** xref:customize:index.adoc[Customize] +*** xref:customize:authorizations.adoc[Authorizations] +*** xref:customize:code.adoc[Code] +*** xref:customize:data_consent.adoc[Zustimmung zu den Daten] +*** xref:customize:gemfile.adoc[Gemfile] +*** xref:customize:images.adoc[Images] +*** xref:customize:javascript.adoc[Javascript] +*** xref:customize:logic.adoc[Logic] +*** xref:customize:menu.adoc[Menu] +*** xref:customize:oauth.adoc[OAuth] +*** xref:customize:styles.adoc[Styles] +*** xref:customize:texts.adoc[Texts] +*** xref:customize:users_registration_mode.adoc[Benutzerregistrierungsmodus] +*** xref:customize:views.adoc[Views] +** xref:services:index.adoc[Services] +*** xref:services:activejob.adoc[Aktiver Job] +*** xref:services:activestorage.adoc[Aktiver Speicher] +*** xref:services:elections_bulletin_board.adoc[Wahlbulletin Board] +*** xref:services:etherpad.adoc[Etherpad] +*** xref:services:maps.adoc[Maps] +*** xref:services:sms.adoc[SMS] +*** xref:services:smtp.adoc[SMTP] +*** xref:services:social_providers.adoc[Soziale Anbieter] +* Administrator +** xref:admin:index.adoc[Introduction] +*** xref:admin:system.adoc[System-Panel] +*** xref:admin:dashboard.adoc[Dashboard] +** Einstellungen +*** xref:admin:configuration.adoc[Configuration] +*** xref:admin:appearance.adoc[Appearance] +*** xref:admin:homepage.adoc[Homepage] +*** xref:admin:scopes.adoc[Scopes] +*** xref:admin:areas.adoc[Areas] +*** xref:admin:help_sections.adoc[Hilfe-Abschnitte] +** xref:admin:pages.adoc[Pages] +** xref:admin:participants.adoc[Participants] +*** xref:admin:participants/admins.adoc[Admins] +*** xref:admin:participants/groups.adoc[Groups] +*** xref:admin:participants/participants.adoc[Participants] +*** xref:admin:participants/impersonations.adoc[Impersonations] +**** xref:admin:participants/verifications_conflicts.adoc[Überprüfungskonflikte] +*** xref:admin:participants/reported_users.adoc[Gemeldete Benutzer] +*** xref:admin:participants/authorizations.adoc[Authorizations] +**** xref:admin:participants/authorizations/identity_documents.adoc[Identifizierungsdokumente] +**** xref:admin:participants/authorizations/code_postal_letter.adoc[Code by postal letter] +**** 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/assemblies.adoc[Assemblies] +**** 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] +*** xref:admin:spaces/initiatives.adoc[Initiatives] +*** xref:admin:spaces/conferences.adoc[Conferences] +**** xref:admin:spaces/conferences/components.adoc[Components] +**** xref:admin:spaces/conferences/categories.adoc[Categories] +**** xref:admin:spaces/conferences/attachments.adoc[Attachments] +**** xref:admin:spaces/conferences/media_links.adoc[Media Links] +**** xref:admin:spaces/conferences/partners.adoc[Partners] +**** xref:admin:spaces/conferences/speakers.adoc[Speakers] +**** xref:admin:spaces/conferences/registrations.adoc[Registrations] +***** xref:admin:spaces/conferences/registrations/types.adoc[Registration Types] +***** xref:admin:spaces/conferences/registrations/users.adoc[User Registrations] +***** xref:admin:spaces/conferences/registrations/invites.adoc[Invites] +***** xref:admin:spaces/conferences/registrations/certificates.adoc[Certificate of Attendance] +**** xref:admin:spaces/conferences/admins.adoc[Conference admins] +**** xref:admin:spaces/conferences/moderations.adoc[Moderations] +*** xref:admin:spaces/consultations.adoc[Consultations] +*** xref:admin:spaces/votings.adoc[Votings] +** xref:admin:components.adoc[Components] +*** xref:admin:components/accountability.adoc[Accountability] +*** xref:admin:components/blog.adoc[Blog] +*** xref:admin:components/budgets.adoc[Budgets] +*** xref:admin:components/debates.adoc[Debates] +*** xref:admin:components/elections.adoc[Elections] +*** xref:admin:components/meetings.adoc[Meetings] +**** xref:admin:components/meetings/registrations.adoc[Registrations] +**** xref:admin:components/meetings/agenda.adoc[Agenda] +**** xref:admin:components/meetings/polls.adoc[Polls] +**** xref:admin:components/meetings/close.adoc[Close] +*** xref:admin:components/pages.adoc[Pages] +*** xref:admin:components/proposals.adoc[Proposals] +**** xref:admin:components/proposals/amendments.adoc[Amendments] +**** xref:admin:components/proposals/answers.adoc[Answers] +**** xref:admin:components/proposals/collaborative_drafts.adoc[Kollaborative Entwürfe] +**** xref:admin:components/proposals/participatory_texts.adoc[teilnehmende Texte] +*** xref:admin:components/sortitions.adoc[Sortitions] +*** xref:admin:components/surveys.adoc[Surveys] +** Funktionen +*** xref:admin:features/badges.adoc[Badges] +*** xref:admin:features/comments.adoc[Comments] +*** xref:admin:features/conversations.adoc[Conversations] +*** xref:admin:features/embed.adoc[Embed] +*** xref:admin:features/endorsements.adoc[Endorsements] +*** xref:admin:features/fingerprint.adoc[Fingerprint] +*** xref:admin:features/follows.adoc[Follows] +*** xref:admin:features/metrics.adoc[Metrics] +*** xref:admin:features/my_account.adoc[Mein Konto] +**** xref:admin:features/my_account/account.adoc[Account] +**** xref:admin:features/my_account/notifications_settings.adoc[Benachrichtigungseinstellungen] +**** xref:admin:features/my_account/authorizations.adoc[Authorizations] +**** xref:admin:features/my_account/groups.adoc[Groups] +**** xref:admin:features/my_account/my_interests.adoc[Meine Interessen] +**** xref:admin:features/my_account/my_data.adoc[Meine Daten] +**** xref:admin:features/my_account/delete_my_account.adoc[Mein Konto löschen] +*** xref:admin:features/my_public_profile.adoc[Mein öffentliches Profil] +**** xref:admin:features/my_public_profile/timeline.adoc[Timeline] +**** xref:admin:features/my_public_profile/activity.adoc[Activity] +**** xref:admin:features/my_public_profile/badges.adoc[Badges] +**** xref:admin:features/my_public_profile/follows.adoc[Follows] +**** xref:admin:features/my_public_profile/followers.adoc[Followers] +**** xref:admin:features/my_public_profile/groups.adoc[Groups] +*** xref:admin:features/notifications.adoc[Notifications] +*** xref:admin:features/search.adoc[Search] +*** xref:admin:features/share.adoc[Share] +*** xref:admin:features/statistics.adoc[Statistics] +*** xref:admin:features/versions.adoc[Versions] +** xref:admin:newsletters.adoc[Newsletters] +** xref:admin:global_moderations.adoc[Globale Moderationen] +** Abgelehnt +*** xref:admin:information-pages.adoc[Informationsseiten] +* xref:mitmachen:index.adoc[Contribute] +** xref:contribute:governance.adoc[Governance] +** xref:contribute:translations.adoc[Translations] +** xref:mitwirken:documentation.adoc[Documentation] +* xref:develop:index.adoc[Develop] +** xref:develop:guide.adoc[Guide] +*** xref:develop:guide_example_apps.adoc[1. Beispielanwendungen] +*** xref:develop:guide_development_app.adoc[2. Development App] +*** xref:develop:guide_commands.adoc[3. Commands] +*** xref:develop:guide_conventions.adoc[4. Conventions] +*** xref:develop:guide_architecture.adoc[5. Architecture] +** xref:develop:security.adoc[Security] +** Advanced +*** Creating custom classes +**** xref:develop:classes/cells.adoc[Cells] +**** xref:develop:classes/commands.adoc[Commands] +**** xref:develop:classes/controllers.adoc[Controllers] +**** xref:develop:classes/events.adoc[Events] +**** xref:develop:classes/forms.adoc[Forms] +**** xref:develop:classes/jobs.adoc[Jobs] +**** xref:develop:classes/mailers.adoc[Mailers] +**** xref:develop:classes/models.adoc[Models] +**** xref:develop:classes/permissions.adoc[Permissions] +**** xref:develop:classes/presenters.adoc[Presenters] +**** xref:develop:classes/queries.adoc[Queries] +*** Concerns +**** xref:develop:authorable.adoc[Authorable] +**** xref:develop:embeddable.adoc[Embeddable] +**** xref:develop:endorsable.adoc[Endorsable] +**** xref:develop:followable.adoc[Followable] +**** xref:develop:reportable.adoc[Reportable] +**** xref:develop:traceable.adoc[Traceable] +**** xref:develop:machine_translations.adoc[TranslatableResource aka Machine Translations] +**** xref:develop:share_tokens.adoc[Shareable with Tokens] +*** xref:develop:api.adoc[API] +*** xref:develop:components.adoc[Components] +*** xref:develop:content_processors.adoc[Content Processors] +*** xref:develop:custom_seed_data.adoc[Custom Seed Data] +*** xref:develop:deploy.adoc[Deploy] +*** xref:develop:docker.adoc[Docker] +*** xref:develop:fixing_locales.adoc[Fixing locales] +*** xref:develop:maps.adoc[Maps] +*** xref:develop:managing_translations_i18n.adoc[i18n] +*** xref:develop:maintainers/index.adoc[Maintainers] +**** xref:develop:backports.adoc[Backports] +**** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] +**** xref:develop:maintainers/releases.adoc[Releasing new versionss] +**** xref:develop:maintainers/security.adoc[Security procedures] +*** xref:develop:metrics.adoc[Metrics] +*** xref:develop:modules.adoc[Modules] +*** xref:develop:notifications.adoc[Notifications] +*** xref:develop:open-data.adoc[Open Data] +*** xref:develop:permissions.adoc[Permissions] +*** xref:develop:profiling.adoc[Profiling] +*** xref:develop:reminders.adoc[Reminders] +*** xref:develop:templates.adoc[Templates] +*** xref:develop:testing.adoc[Testing] +*** xref:develop:guide_development_with_localhost_ssl.adoc[Testing SSL and Tenants in Development] +*** xref:develop:turbolinks.adoc[Turbolinks] +*** Views +**** xref:develop:content_blocks.adoc[Content Blocks] +**** xref:develop:newsletter_templates.adoc[Newsletter Templates] +**** xref:develop:view_hooks.adoc[View Hooks] +**** xref:develop:view_models_aka_cells.adoc[View Models (Cells)] +* Understand +** xref:understand:about.adoc[About] +** xref:understand:background.adoc[Background] +** xref:features:general-description.adoc[Features] +*** xref:features:participatory-spaces.adoc[Participatory spaces] +*** xref:features:components.adoc[Components] +*** xref:admin:participants.adoc[Participants] +*** xref:features:general-features.adoc[Allgemeine Merkmale] ++ +// ** xref:understand:governance.adoc[Project governance] + +// ** xref:understand:history.adoc[History of the project] + +// ** xref:understand:research.adoc[Research] + +** xref:understand:social-contract.adoc[Gesellschaftsvertrag] +*** xref:understand:social-contract-ca.adoc[Catalan] +*** xref:understand:social-contract-es.adoc[Castellano] +** Publikationen +*** xref:publications:catalan.adoc[Catalan] +*** xref:publications:german.adoc[English] +*** xref:publications:french.adoc[French] +*** xref:publications:german.adoc[German] +*** xref:publications:italian.adoc[Italian] +*** xref:publications:spanish.adoc[Spanish] +** Whitepaper +*** xref:whitepaper:decidim-a-brief-overview.adoc[Decidim: ein kurzer Überblick] +* xref:releases:index.adoc[Release notes] \ No newline at end of file diff --git a/docs/de/modules/ROOT/pages/index.adoc b/docs/de/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000000..fb8cc718e8 --- /dev/null +++ b/docs/de/modules/ROOT/pages/index.adoc @@ -0,0 +1,24 @@ += Willkommen bei der Decidim-Dokumentation + +Dies ist die Dokumentationsseite zu Decidim, einer partizipatorischen Demokratieplattform, die ursprünglich vom Rathaus Barcelona geschaffen wurde. + +Decidim ist ein Framework, das es jedem erlaubt, eine Plattform zu erstellen und zu konfigurieren, in Form eines politischen Netzwerks für demokratische Partizipation. Die Plattform ermöglicht es jeder Organisation (Stadtrat, Vereinigung, Universität, NGO, Nachbarschaft oder Genossenschaft) Massenprozesse für die strategische Planung zu erstellen partizipative Budgetierung, gemeinschaftliche Gestaltung für Vorschriften, städtische Räume und Wahlprozesse. + +== Neu bei Decidim? + +Sie haben die Dokumentation für Decidim gefunden. Erfahren Sie mehr über das Projekt unter https://decidim.org[decidim.org]. + +[NOTE] +==== +This is the documentation for the `develop` branch. You can see this same documentation site for other versions: xref:v0.28@ROOT:index.adoc[v0.28] and xref:v0.27@ROOT:index.adoc[v0.27] +==== + +// * Read the xref:ROOT:getting-started.adoc[Getting Started guide] + +Die Dokumentation umfasst xref:install:index.adoc[installing], xref:configure:index.adoc[configuring]und xref:admin:index.adoc[running] Ihre eigene Decidim-Website. + +Wenn Sie Änderungen am Quellcode vornehmen möchten, haben wir auch eine Dokumentation für xref:develop:guide.adoc[developers]. + +Wenn du eine Organisation bist, die Decidim verwenden möchte, oder ein Entwickler, der an der Zusammenarbeit an der Software interessiert ist, bitte https://decidim.org/contact[get in contacch]. + +Decidim ist eine Gemeinschaftsanstrengung. Wenn du also Fehler in diesen Anleitungen findest, lass es uns bitte unter hola [at] Dezimierung [dot] Org wissen. Jede Hilfe ist willkommen. Wenn du ein GitHub Benutzer bist, kannst du sogar Änderungen an dieser Website mit dem Link Bearbeiten auf jeder Seite vorschlagen. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/components/accountability.adoc b/docs/de/modules/admin/pages/components/accountability.adoc new file mode 100644 index 0000000000..2913cb2ce9 --- /dev/null +++ b/docs/de/modules/admin/pages/components/accountability.adoc @@ -0,0 +1,10 @@ += Accountability + +The Accountability component allows people to follow project implementations. It works like a project management system built into the platform. It offers the following features: + +* creating results that represent projects to be implemented +* subdividing results into projects or sub-projects +* defining and applying progress in implementation statuses (0% to 100% implemented) around their implementation +* displaying the extent of the results’ implementation grouped by categories and scopes + +Results, projects and statuses can be updated through a CSV (comma-separated values), or manually by the administration interface. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/components/budgets.adoc b/docs/de/modules/admin/pages/components/budgets.adoc new file mode 100644 index 0000000000..93261f865c --- /dev/null +++ b/docs/de/modules/admin/pages/components/budgets.adoc @@ -0,0 +1,357 @@ += Budgets + +:page-toclevels: 4 + +The Budgets component allows people to vote by selecting projects of their choosing. Depending on the needs and normative +of the organization, this could be configured so people have assigned a total budget (for instance, 100.000 EUR) and then +every project has assigned a value (for instance, 10.000 EUR). Then when people vote on projects, they have a progress bar +where they see how much remaining budget they have to allocate in this voting. + +From this starting point, there could be other configurations, such as: + +* A minimum percentage of budget to be allocated +* A minimum number of projects to be allocated +* Multiple budgets, one for each district or neighborhood + +Some examples of where this component was used: + +* https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona]. +The city of Barcelona (Spain) has allocated a budget of 30.000.000 EUR so people can present, define, prioritize, vote +and choose which investment projects the city government should execute. +* https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers (France) has allocated +a budget of 1.000.000 EUR so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. +* https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million euros to realising +residents’ wishes. The ideas are developed together into proposals that Helsinki residents can vote on. The proposals with the +most votes are realised by the City. + +image:components/budgets/example01.png[Budgets example voting] +image:components/budgets/example02.png[Budgets example error messagge when exceding the amount of budget] +image:components/budgets/example03.png[Budgets vote confirmation] +image:components/budgets/example04.png[Budgets after voting] + +To configure the Budgets component: + +. 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 "Budgets" +. Fill the xref:_add_component[Add component] form + +== Add component + +image:components/budgets/component.png[Add component form] + + +.Add component: Budgets form +|=== +|Field |Type |Description + +|Name +|Required +|What is the title of this component. For instance, "Budgets" + +|Order position +|Optional +|Which order will it have in relation to the other budgets. Having a lower number means a higher priority. +For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0", then "Budget b" will be first when ordering. +|=== + + +.Add component: Budgets form - Global settings +|=== +|Field |Type |Description + +|Scopes enabled +|Optional +|Check if you want to have Scopes filtering in this component. + +|Scope +|Optional +|Which xref:admin:scopes.adoc[Scope] does this component belongs to. + +|Global scope +|Optional +| + +|xref:_workflows[Workflow] +|Required +|How the participants can vote if there are multiple budget sets. You can define your own xref:_workflows[Workflow] or use one of the availables. + +|Projects per page +|Required +|How many projects are displayed per page. + +|Enable rule: Minimum budget percentage +|Optional, but incompatible with "Minimum number of projects to be voted on" and "Selected projects with minimum and maximum number of projects to be voted on" +|Allows to define a "Vote threshold percent", a percent of the total budget that participants must reach to be able to vote. + +|Enable rule: Minimum number of projects to be voted on +|Optional, but incompatible with "Minimum budget percentage" and "Selected projects with minimum and maximum number of projects to be voted on" +|Allows to define a "Minimum number of projects to vote", a number of projects that participants must reach to be able to vote. + +|Enable rule: Selected projects with minimum and maximum number of projects to be voted on +|Optional, but incompatible with "Minimum budget percentage" and "Minimum number of projects to be voted on" +|Allows to define a "Minimum amount of projects to be selected" and a "Maximum amount of projects to be selected", the number of projects +that participants will need to vote as a minimum and maximum. + +|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. + +|Actions permissions can be set for each project +|Optional +|Whether you want to be able to set permissions for every one of the projects. Most of the time you will want to leave this option disabled. + +|Announcement +|Optional +|A general announcement that'll be visible on the general budgets landing page. + +|Budgets landing page +|Optional +|What message will be shown in the Budgets landing page when there are multiple budgets. + +|More information modal +|Optional +|What message will be shown when clicking on the "More information" link. +|=== + +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: Budgets form - Step settings +|=== +|Field |Type |Description + +|Comments blocked +|Optional +|Whether you want to enable comments for this phase. + +|Voting +|Required +|Choose one of the following options depending in the moment of the process: Voting disabled, Voting enabled or Voting finished. + +|Show votes +|Optional +|Wheter the votes will be shown. We strongly recommend that you only check this option after the voting is finished. + +|Announcement +|Optional +|A general announcement that'll be visible on the general budgets landing page. + +|Budgets landing page +|Optional +|What message will be shown in the Budgets landing page when there are multiple budgets. + +|More information modal +|Optional +|What message will be shown when clicking on the "More information" link. +|=== + +== Permissions + +Edit permissions + +* Vote +* Comment + +== Workflows + +One neat feature of the Budgets component is the ability to define your own workflows. + +This means that you can define multiple Budgets, for instance one for every Neighberhood or District that a City has, and +you can also define multiple rullings regarding how people can vote on those Budgets. By default you have these workflows: + +* Vote in one: allows participants to vote in any budget, but only in one. +* Vote in all: allows participants to vote in all budgets. +* Vote in a random component: allows participants to vote only in one budget, selected randomly. + +But this can be extended in your application by a developer, by making your own Workflows. For instance for the +https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona], +the people could vote in two districts: the one where they lived and one of their choosing. This was defined in the +https://github.com/AjuntamentdeBarcelona/decidim-barcelona/blob/743be2a210e8745d2dc443166642b285aed2b356/lib/budgets_workflow_pam2021.rb[decidim-barcelona application itself]. + +You can read more about Worfklows in https://github.com/decidim/decidim/blob/1ab5cd8fdabef48f5be94ff9c30c6bb3bc9a2f8f/decidim-budgets/README.md#budget-workflows[decidim-budgets README.md]. + +NOTE: You only want to have a voting without much complications? Like a city-wide vote? Don't worry: if you define only one +Budget, then people will go there directly when click in the Budgets section. + +== Manage budgets + +image:components/budgets/manage_budgets.png[Manage budgets table] + +This window also lets you see the votes that the various projects have received. (Number of votes) and the total number of votes (*Finished votes* and *Pending votes*, that is, that a participant has started voting but has still not cast their vote). + +=== Export all + +Allows to export the projects for this budget in different formats. + +* Projects as CSV +* Projects as JSON +* Projects as Excel + +=== New budget form + +image:components/budgets/new_budget.png[New budget form] + + +.New budget form +|=== +|Field |Type |Description + +|Title +|Required +|What is the title of this budget. For instance, "District A" + +|Order position +|Optional +|Which order will it have in relation to the other budgets. Having a lower number means a higher priority. +For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0", then "Budget b" will be first when ordering. + +|Description +|Optional +|What is the description of this budget. + +|Total budget +|Required +|What is the total amount of money that people will have for assigning. +|=== + +==== Actions + + +.Actions +|=== +|Icon |Name |Definition + +|image:action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:action_list.png[Manage projects icon] +|xref:_manage_projects[Manage projects] +|Allows you to manage the projects of a budget. + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for a budget. It's the same form as "New budget". + +|image:action_delete.png[Delete icon] +|Delete +|To delete this budget. Only can be done when there aren't any projects. +|=== + +==== Manage projects + +===== Import proposals to projects + +Depending in the normative, you could want to have a first phase where participants +make proposals, and those proposals are selected (by voting or by technical review), +then you can import those proposals and convert them to projects. + +For this to work: + +. The following settings in the proposals component need to be enabled: +.. Proposal answering enabled +.. Enable costs on proposal answers +. A valuator or administrator need to Answer proposals: +.. Review the proposals +.. Accept or reject them according to your normative +.. Add costs to the proposals if were accepted +. An administrator can Import proposals to projects + +image:components/budgets/import_proposals.png[Import proposals to projects] + +===== Export all + +Allows to export the projects for this budget in different formats. + +* Projects as CSV +* Projects as JSON +* Projects as Excel + +===== New project form + +image:components/budgets/new_project.png[New project form for a Budget] + + +.New project form +|=== +|Field |Type |Description + +|Title +|Required +|The title for this project. + +|Description +|Required +|A description of what this project is about. + +|Budget amount +|Required +|What's the budget amount for this project. How much money will it cost to implement this project? + +|Category +|Optional +|Which Category has the project. Used for filtering in the budgets list. + +|Proposals +|Optional +|Choose related proposals for this project. Automatic assingned when importing proposals. + +|Add an image gallery +|Optional +|Add multiple images illustrating what this project is about, or where it will be implemented. +|=== + +===== Actions + + +.Actions +|=== +|Icon |Name |Definition + +|image:action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for a project. It's the same form as "New project". + +|image:action_folder.png[Folders icon] +|Folders +|For classifying Attachments. + +|image:action_attachments.png[Attachments icon] +|Attachments +|Documents that are related to the project. + +|image:action_delete.png[Delete icon] +|Delete +|To delete this project. +|=== + +== Results + +After the voting step has finished, then an administrator need to: + +. Change the Voting configuration for the Budget component to "Voting finished" +. Go to the Budgets and view the results +. On the projects that according to the normative have been selected, they will need to go to each project, edit it and +then check the "Selected for implementation". + +image:components/budgets/results_unselected.png[Unselected projects after voting] +image:components/budgets/results_select_project.png[Select a project for implementation] +image:components/budgets/results_selected.png[Selected projects after voting] +image:components/budgets/results_selected_frontend.png[Selected projects after voting in the frontend] + +We strongly recommend that after you have selected projects then you enable the xref:components/accountability.adoc[Accountability] +component so participants can see the grade of impementation. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/components/meetings.adoc b/docs/de/modules/admin/pages/components/meetings.adoc new file mode 100644 index 0000000000..8b017d8085 --- /dev/null +++ b/docs/de/modules/admin/pages/components/meetings.adoc @@ -0,0 +1,411 @@ += Meetings + +Meetings are where people come together to discuss or inform about a given topic. All the meetings have a given location +(where the meeting will happen) and start and end date and time (when the meeting will happen). + +Some examples of where this component was used are: + +* https://www.decidim.barcelona/processes/PAM2020/f/3734/[Procés participatiu del Programa d'Actuació Municipal (PAM) 2020-2023] +in https://www.decidim.barcelona/[Decidim Barcelona] +* https://lejourdapres.parlement-ouvert.fr/processes/ateliers/f/14/[Les ateliers] in https://lejourdapres.parlement-ouvert.fr/[Le jour d'après] + +image:components/meetings/example01.png[Meetings list in Decidim Barcelona] +image:components/meetings/example02.png[Example meeting detail 01 in Decidim Barcelona] +image:components/meetings/example03.png[Example meeting detail 02 in Decidim Barcelona] +image:components/meetings/example04.png[Meetings list in Le jour d'après] + +== Types + +Regarding the *location*, depending on the configuration of the component, you can have: + +* In-person meetings: where you get together in a given location +* Online meetings: where you get together using an external service (for instance Jitsi Meet) + +Depending in the *author* (who's the person that's making the call): + +* Official meetings: meetings created by the organization (created by an administrator through the panel) +* Citizens meetings: meetings created by a User participant (a User or an UserGroup). + +== Add the component + +image:components/meetings/component.png[Add a meetings component] + +For adding the component, you need to: + +. 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 "Meetings" +. Fill the xref:_add_component[Add component] form + +== Add component + +For configuring the meeting component you have these settings: + + +.Add component - Meetings form +|=== +|Field |Type |Description + +|Name +|Required +|What is the name of this component. + +|Order position +|Optional +|Which order will it have in relation with the other components. Having a lower number means a higher priority. For instance, +if you have two components, "Proposals" with weight "10" and "Meetiings" with weight "0", then "Meetings" will be first when ordering. +|=== + + +.Add component - Meetings form: Global settings +|=== +|Field |Type |Description + +|Scopes enabled +|Optional +|Check if you want to have Scopes filtering in this process. + +|Scope +|Optional +|Which scope will be used for this component. + +|Announcement +|Optional +|A general announcement that'll be visible in the general meetings list. + +|Default registration terms +|Optional +|What'll be the registration terms of service that the participant would need to accept when registering. + +|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. + +|Registration code enabled +|Optional +|Check if you want to give registration codes to participants. Learn more in xref:components/meetings/registrations.adoc[Registrations]. + +|Actions permissions can be set for each meeting +|Optional +|If you want more granular permissions inside of every one of the Meetings. + +|Enable pads creation +|Optional +|If you want an Etherpad embedded in your meetings. Must have the xref:services:etherpad.adoc[Etherpad] integration configurated. + +|Participants can create meetings +|Optional +|Allows participants to create new meetings. See xref:_citizens_meetings[Citizens meetings] + +|Maps enabled +|Optional +|Wheter you want to show a map in the meetings in the meeting detail. +|=== + + +.Add component - Meetings form: Step settings +|=== +|Field |Type |Description + +|Announcement +|Optional +|A general announcement that'll be visible in the general meetings list. + +|Comments enabled +|Optional +|Whether you want to have comments in the meetings. +|=== + +== Create a new meeting + +=== Citizens meetings + +Meetings can be created by participants if the setting is "Participants can create meetings" is checked. + +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create meetings as that group also. + +image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)] +image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form (frontend)] + + +.Create meeting - Frontend form +|=== +|Field |Type |Description + +|Title +|Required +|What is the title for this meeting. + +|Description +|Required +|A description of what will be discussed in this meeting, like the topics. + +|Type +|Required +|Choose one option between "In person", "Online" or "Booth" + +|Address +|Required if meeting type is "In person" or "Booth" +|Address: used by Geocoder to find the location + +|Location +|Required +|Location: message directed to the users implying the spot to meet at + +|Location hints +|Optional +|Location hints: additional info. Example: the floor of the building + +|Online meeting URL +|Optional +|Which URL will the meeting be held. + +|Show embedded iframe for this URL +|Optional +|Whether or not embed the iframe for this videoconference URL. Only a few services allow embedding (i.e. YouTube, Twitch...) + +|Start Time +|Required +|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii + +|End Time +|Required +|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii + +|Category +|Optional +|Which Category has the meeting. Used for filtering in the meetings list. + +|Registration type +|Required +|Choose one option between "Registration disabled", "On this platform", or "On a different platform" + +|Available slots for this meeting +|Required if "Registration type" is "On this platform" +|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available + +|Registration terms +|Required if "Registration type" is "On this platform" +|What terms of services participants need to accept to register or join the meeting. Specific to "Citizens meetings" + +|Registration URL +|Required if "Registration type" is "On a different platform" +|Must be an URL. Link to go on the external service that you are using for registrations. + +|Create meeting as +|Required if the participant belongs to a group +|With which identity they want to create this meeting: as their user or as a group that they are reprensenting? +|=== + +After creating the meeting, participants can also edit and xref:components/meetings/close.adoc[close] it. + +=== Official meetings + +image:components/meetings/new_meeting_form_backend.png[Create a new meeting form (backend)] + + +.Create meeting - Backend form +|=== +|Field |Type |Description + +|Title +|Required +|What is the title for this meeting. + +|Description +|Required +|A description of what will be discussed in this meeting, like the topics. + +|Type +|Required +|Choose one option between "In person", "Online" or "Booth" + +|Address +|Required if meeting type is "In person" or "Booth" +|Address: used by Geocoder to find the location + +|Location +|Required +|Location: message directed to the users implying the spot to meet at + +|Location hints +|Optional +|Location hints: additional info. Example: the floor of the building + +|Online meeting URL +|Optional +|Which URL will the meeting be held. + +|Show embedded iframe for this URL +|Optional +|Whether or not embed the iframe for this videoconference URL. Only a few services allow embedding (i.e. YouTube, Twitch...) + +|Start Time +|Required +|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii + +|End Time +|Required +|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii + +|Category +|Optional +|Which Category has the meeting. Used for filtering in the meetings list. + +|Registration type +|Required +|Choose one option between "Registration disabled", "On this platform", or "On a different platform" + +|Available slots for this meeting +|Required if "Registration type" is "On this platform" +|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available + +|Registration URL +|Required if "Registration type" is "On a different platform" +|Must be an URL. Link to go on the external service that you are using for registrations. + +|Private meeting +|Optional +|Check if the meeting shouldn't be visible for all the visitors. Specific to "Official meetings". + +|Transparent +|Optional +|Related to "Private meeting", check if the meeting should be visible for all the visitors but they shouldn't be able to +participate in. Specific to "Official meetings". Specific to "Official meetings". + +|Customize registration email +|Optional +|Wheter you want to add a message in the registration email. Specific to "Official meetings". + +|Registration email custom content +|Required if "Customize registration email" is checked +|The content of the customized email. This text will appear in the middle of the registration confirmation email. Just +after the registration code. Specific to "Official meetings". +|=== + +You can also define *Services* inside of a Meeting. These are metadata that allows to comunicate, for instance, if there's +a place for children, deaf assistance, translations, etc. You can have multiple services inside of a meeting. + + +.Create meeting - Services +|=== +|Field |Type |Description + +|Title +|Required +|Title of the service. + +|Description +|Optional +|Description of the service. +|=== + +== Actions + +=== Citizens meetings + + +.Actions - Citizens meetings +|=== +|Icon |Name |Definition + +|image:action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:action_permissions.png[Permissions icon] +|Permissions +|To handle the permissions of this meeting, depending on the verification a participant has. Allows an admin to configure +who can *Join* a meeting. +|=== + +=== Official meetings + + +.Actions - Official meetings +|=== +|Icon |Name |Definition + +|image:action_publish.png[Publish icon] +|Publish +|To show publicly the meeting. + +|image:action_publish.png[Unpublish icon] +|Unpublish +|To not show publicly the meeting. + +|image:action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:action_duplicate.png[Duplicate icon] +|Duplicate +|Allows an admin to duplicate a meeting. + +|image:action_registrations.png[Registrations icon] +|xref:admin:components/meetings/registrations.adoc[Registrations] +|Allows to define who can register for attending to the meeting. + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for a Meeting. It's the same form as "Create a new meeting". + +|image:action_agenda.png[Agenda icon] +|xref:admin:components/meetings/agenda.adoc[Agenda] +|To add the topics that will be discussed in the meeting. + +|image:action_list.png[Poll icon] +|xref:admin:components/meetings/polls.adoc[Polls] +|To manage the polls for this online meeting. + +|image:action_close.png[Close icon] +|xref:admin:components/meetings/close.adoc[Close] +|Allows and admin to Close the meeting and add extra information. + +|image:action_folder.png[Folders icon] +|Folders +|For classifying Attachments. + +|image:action_attachments.png[Attachments icon] +|Attachments +|Documents that are related to the meeting. + +|image:action_permissions.png[Permissions icon] +|Permissions +|To handle the permissions of this meeting, depending on the verification a participant has. Allows an admin to configure +who can *Join* a meeting. + +|image:action_delete.png[Delete icon] +|Delete +|To delete this meeting. +|=== + +== Meetings features + +There are different kinds of features that can be enabled in meetings, such as: + +* xref:admin:components/meetings/registrations.adoc[Registrations]: for managing how particpant can register to attend the meeting. +* xref:admin:components/meetings/agenda.adoc[Agenda]: for seeing the topics that will be discussed in the meeting by minutes. +* xref:admin:components/meetings/polls.adoc[Polls]: for quick voting during an online meeting. +* xref:admin:components/meetings/close.adoc[Close]: for adding the final report on what was discussed in the meeting. + +== Online meetings + +Depending in the moment and configuration of the meeting, there could be different messages that will be shown to the participants. + +. If the "Online meeting URL" ins't set, there'll be a message that says "Link available soon" +image:components/meetings/online_meeting_available_soon.png[Online meeting available soon] +. If the "Online meeting URL" is set, and a few minutes before the meeting start, the mesage will say "The link to join +the meeting will be available a few minutes before it starts" +image:components/meetings/online_meeting_available_before.png[Online meeting available before it starts] +. If the "Online meeting URL" is set, and the start time of the meeting has arrived, then there'll be a message that says +that "the meeting is happening right now", with a link to join the meeting. +image:components/meetings/online_meeting_happening.png[Online meeting available before it starts] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/components/meetings/registrations.adoc b/docs/de/modules/admin/pages/components/meetings/registrations.adoc new file mode 100644 index 0000000000..b8a7cfd6de --- /dev/null +++ b/docs/de/modules/admin/pages/components/meetings/registrations.adoc @@ -0,0 +1,105 @@ += Registrations + +Through registrations you can have capacity control of the attendance for a meeting. With this feature for instance you can +limit how many people could attend to the meeting, or you can know before the start of a meeting if you need to find a bigger +room to have the meeting. + +Enabling this feature will add a button so that participants can express their wish to go to the meeting. Depending in how +this feature is configured, then: + +. it's possible to define how many slots are available for controling the maximum capacity for this meeting +. a xref:_registration_form[custom registration form] for asking information to participants can be configured +. administrators can make xref:_invitations[invitations] to other participants or people that isn't registered in the platform +. it's possible to control attendance to the meeting through xref:_registration_code[registration codes] + +image:components/meetings/registrations/frontend_join_meeting.png[Join a meeting sidebar button] + +Once participants confirm joining a meeting they get asked if they're reprensenting a group and if they want to show publicly that they're attending. + +image:components/meetings/registrations/frontend_confirm.png[Join a meeting confirm modal] + +== Enable registrations for a meeting + +To enable registrations for a meeting: + +. 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" +. Click on "Meetings" +. Search the meeting that you want to enable registrations for +. Click on the "Edit" button image:action_edit.png[Edit button] +. Change the "Registration type" field to "On this platform" +. Define how many slots are available in "Available slots for this meeting" +. Click on the "Update" button +. Click on the "Registrations" button image:action_registrations.png[Registrations button] +. Check the "Registrations enabled" checkbox +. Fill the form + +== Registrations settings form + +image:components/meetings/registrations/backend.png[Registrations settings in a meeting] + + +.Registrations settings form +|=== +|Field |Type |Description + +|Registrations enabled +|Required +|Check to enable the registration for this meeting. + +|Registration form enabled +|Optional +|Check if you want to enable the registration form + +|Available slots for this meeting +|Required +|How many slots are available. Leave it to 0 if you have unlimited slots available. + +|Reserved slots +|Required +|How many slots are already reserved. Leave it to 0 if you don't have reserved slots + +|Registration terms +|Required +|What terms of services participants need to accept to register or join the meeting. +|=== + +== Registration form + +This feature allows you to define a custom form like the xref:admin:components/surveys.adoc[Surveys] component to ask participants +for registration information. + +== Export all + +It's possible to export registrations in multiple formats: CSV, JSON and XLSX (Excel). + +The exported data will have these fields: + +* id: The registration id +* code: the xref:_registration_code[registration code] (if this feature is enabled) +* user/name: the name of the user +* user/email: the email of the user +* user/user_group: the group of the user if they have selected that's representing a group when registering + +== Invitations + +This feature allows you to invite attendes to a meeting. These could be already registered or non-existing participants +in the platform. + +image:components/meetings/registrations/invite_attendee.png[Invite attendee for registration in a meeting] + +== Registration code + +This feature allows you to check if the attendee is registered in the meeting. They need to provide their code, that gets +entered in this form and it's checked against the database. + +image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting] + +image:components/meetings/registrations/frontend_confirmed_w_code.png[Registration code in a meeting frontend] + +It can receive two kind of responses: + +* Registration code successfully validated. +* This registration code is invalid. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/components/proposals.adoc b/docs/de/modules/admin/pages/components/proposals.adoc new file mode 100644 index 0000000000..99ede095c7 --- /dev/null +++ b/docs/de/modules/admin/pages/components/proposals.adoc @@ -0,0 +1,445 @@ += Proposals + +The Proposals component allows people to create, comment, endorse, and give support to proposals. + +From this starting point, there could be other configurations, such as: + +* how many proposals a participant can create +* how many supports as a maximum a participant can give to proposals +* how many supports as a minimum a participant must give to proposals so their supports are valid +* whether you want to enable that participants comment on proposals +* whether you want that proposals have images, attachments, WYSIWYG editor, geolocated address, scopes, etc. + +Some examples of where this component was used: + +* https://futureu.europa.eu/[Conference of the Future of Europe] +* https://meta.decidim.org/processes/roadmap/f/122/[Propose new functionalities for Decidim software] in https://meta.decidim.org/[Metadecidim] + +image:components/proposals/example01.png[Proposals list example in COFE] +image:components/proposals/example02.png[Proposals list example in Metadecidim] +image:components/proposals/example03.png[Proposal detail example in Metadecidim] + +To configure the Proposals component: + +. 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 "Proposals" +. Fill the xref:_add_component[Add component] form + +== Add component + +image:components/proposals/component.png[Add component form] + + +.Add component: Proposals form +|=== +|Field |Type |Description + +|Name +|Required +|What is the title of this component. For instance, "Proposals" + +|Order position +|Optional +|Which order will it have in relation to the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Proposals" with weight "10" and "Meetings" with weight "0", then "Meetings" will be first when ordering. +|=== + + +.Add component: Proposals form - Global settings +|=== +|Field |Type |Description + +|Scopes enabled +|Optional +|Check if you want to have Scopes filtering in this component. + +|Scope +|Optional +|Which xref:admin:scopes.adoc[Scope] does this component belongs to. + +|Support limit per participant +|Optional +|Must be a number. How much supports a participant can give to proposals. + +|Minimum supports per user +|Optional +|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If they don't +reach this number, their supports will not be taken in account. + +|Proposal limit per participant +|Optional +|Must be a number. How many proposals a participant can create. + +|Maximum proposal body length +|Optional +|Must be a number. How many characters a proposal body can have as maximum. + +|Proposal editing +|Required +|Choose one of these two options: "Allow editing of proposals within a specific timeframe" or "Allow editing proposals +for an infinite amount of time". In case it's within a specific timeframe, you must specify the time in "Proposals can be +edited by authors before this many minutes passes". Note that if you xref:components/proposals/answers.adoc[answer a proposal] +then it can't be edited anymore. + +|Proposals can be edited by authors before this many minutes passes +|Required if "Proposal editing" is "Allow editing of proposals within a specific timeframe" +|Must be a number. How many minutes after the creation of a proposal it can be edited by its author. + +|Threshold per proposal +|Optional +|Must be a number. How many supports a proposal needs to have to be considered as "validated". See <>. + +|Can accumulate supports beyond threshold +|Optional. Only applies if "Threshold per proposal" is configured. +|Whether the proposal can accumulate more supports than the threshold. + +|Proposal answering enabled +|Optional +|Whether administrators or valuators can answer proposals. + +|Official proposals enabled +|Optional +|Wheter administrators can create official proposals. + +|Comments enabled +|Optional +|Whether you want to have comments in the meetings. + +|Comments max length +|Optional +|What are the characters limit that participants will have when making comments. Leave 0 for the default value. + +|Geocoding enabled +|Optional +|Wheter participants can define a geocoding address for their proposals. Need to have xref:configure:geocoding[Geocoding] enabled. See <>. + +|Allow attachments +|Optional +|Check to allow participants to attach files to their proposals. + +|Allow card image +|Optional +|Check to show a card image when participants attach images to their proposals. See <>. + +|Actions permissions can be set for each proposal +|Optional +|Whether you want to be able to set permissions for every one of the proposals. Most of the time you will want to leave this option disabled. + +|Collaborative drafts enabled +|Optional +|Check to enable xref:components/proposals/collaborative_drafts.adoc[collaborative drafts] in proposals. + +|Participatory texts enabled +|Optional +|Check to enable xref:components/proposals/participatory_texts.adoc[participatory texts] in proposals. + +|Amendments enabled +|Optional +|Check to enable xref:components/proposals/amendments.adoc[amendments] in proposals. If active, configure Amendment features for each step. + +|Amendments Wizard help text +|Optional. Visible if the "Amendments enabled" option is checked. +|What's the help text visible when creating new amendments. + +|Announcement +|Optional +|A general announcement that'll be visible on the general proposals landing page. + +|New proposal body template +|Optional +|A pre-defined text that will be used when creating new proposals. Useful if you want to define a format that participants need to +follow when creating new proposals. + +|New proposal help text +|Optional +|What's the help text visible when creating new proposals. + +|Proposal wizard "Create" step help text +|Optional +|What's the help text visible when creating new proposals in the "Create" step. + +|Proposal wizard "Compare" step help text +|Optional +|What's the help text visible when creating new proposals in the "Compare" step. + +|Proposal wizard "Complete" step help text +|Optional +|What's the help text visible when creating new proposals in the "Complete" step. + +|Proposal wizard "Publish" step help text +|Optional +|What's the help text visible when creating new proposals in the "Publish" step. +|=== + +[#setting-threshold] +*Example of threshold setting* + +image::components/proposals/setting_threshold01.png[Example of threshold setting] + +image::components/proposals/setting_threshold02.png[Example of threshold setting] + +[#setting-card-image] +*Example of card image setting* + +image::components/proposals/setting_card_image.png[Example of card image setting] + +[#setting-geocoding] +*Example of geocoding setting* + +image::components/proposals/setting_geocoding.png[Example of geocoding setting] + +--- + +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: Proposals form - Step settings +|=== +|Field |Type |Description + +|Announcement +|Optional +|A general announcement that'll be visible on the general proposal landing page. + +|Endorsements enabled +|Optional +|Check if you want that participants show public support for these proposals. + +|Endorsements blocked +|Optional +|Whether participants will be able to see the endorsments but don't make any. + +|Supports enabled +|Optional +|Whether participants will be able to support proposals in this step. + +|Supports blocked +|Optional +|Whether participants will be able to support proposals in this step. + +|Supports hidden +|Optional +|If supports are enabled, checking this will hide the number of supports. + +|Comments blocked +|Optional +|Whether you want to enable comments for this phase. + +|Proposal creation enabled +|Optional +|Whether you want to enable proposal creation by participants for this phase. See xref:_new_proposal_form[New proposal form] + +|Proposal answering enabled +|Optional +|Whether you want to enable xref:components/proposals/answers.adoc[proposal answering]. + +|Publish proposal answers immediately +|Optional +|Wheter you want that the answers of proposals are published at the same time that you're xref:components/proposals/answers.adoc[answering] them or you want to control when to publish the answers. + +|Enable costs on proposal answers +|Optional +|Wheter you want to add economical costs to proposal answers. Useful for importing to xref:components/budgets.adoc[budgets]. + +|Amendment creation enabled +|Optional. Visible if "Amendments enabled" option is checked. +|Participant can amend proposals. See xref:components/proposals/amendments.adoc[Amendments]. + +|Amendment reaction enabled +|Optional. Visible if "Amendments enabled" option is checked. +|Proposal's authors will be able to accept or reject Participant's emendations. + +|Amendment promotion enabled +|Optional. Visible if "Amendments enabled" option is checked. +|Emandation authors will be able to promote to Proposal the rejected emendation. + +|Amendments visibility +|Required. Visible if "Amendments enabled" option is checked. +|Choose one of "Amendments are visible to all" or "Amendments are visible only to their authors" + +|Announcement +|Optional +|A general announcement that'll be visible on the general proposals landing page. + +|Hashtags added to all proposals +|Optional +|Automatically add a hashtag to every proposal. See <>. + +|Hashtags suggested to participants for new proposals +|Optional +|Suggest hashtags to participants for new proposals. Participants can select more than one hashtag. See <>. +|=== + +[#setting-hashtags] +*Example of hashtags setting* + +image::components/proposals/setting_hashtag.png[Example of hashtag setting] + +== Permissions + +An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make +certain actions in the proposals: + +* Endorse +* Support +* Create +* Withdraw +* Amend +* Comment +* Vote comment + +== Manage proposals + +image:components/proposals/manage_proposals.png[Manage proposals table] + +=== Export + +Allows exporting the proposals in different formats. + +* Proposals as CSV +* Proposals as JSON +* Proposals as Excel +* Comments as CSV +* Comments as JSON +* Comments as Excel + +=== Import + +* Import from another component +* Import from a file + +=== New proposal form + +==== Citizens proposals + +image:components/proposals/new_proposal_frontend.png[New proposal form] + +Proposals can be created by participants if the setting is "Proposal creation enabled" is checked for the active phase. + +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create proposals as that group also. + +This form depends a lot in which settings you've enabled in this component. It can be really short (with only a Title and +Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, Image and Attachment). + + +.New proposal form - default (by a participant) +|=== +|Field |Type |Description + +|Title +|Required +|What is the title of this proposal. For instance, "Bike lane in Main Street". Must have at least 15 characters as minimum +and 150 characters as maximum. Must start with a capital letter. + +|Body +|Optional +|What is the full description for this proposal. Must have at least 15 characters as minimum and 450 characters as maximum +by default but can be changed with the setting "Maximum proposal body length". +|=== + +To detect duplicated proposals before publishing them, the proposal creation has a wizard form with multiple steps. This also +allows participants to save proposals drafts (unpublished) in case they need to fill too many fields. + +image:components/proposals/new_proposal_frontend_compare.png[New proposal form (by a participant) - Compare] + +As an example of what the form could look depending in the settings enabled, here's a screenshot of the form for a proposal +with the following settings: "Hashtags added to all proposals", "Hashtags suggested to participants for new proposals", +"Geocoding enabled", "Allow attachments", "Allow card image" and "Scopes enabled". + +image:components/proposals/new_proposal_frontend_complete.png[New proposal form (by a participant) - Complete] + +After completing these fields the participant can see a preview of their proposal before publishing. They can also modify +the proposal before publishing it. + +image:components/proposals/new_proposal_frontend_publish.png[New proposal form (by a participant) - Publish] + +image:components/proposals/new_proposal_frontend_published.png[Published proposal made by a participant] + +==== Official proposals + +Administrators can create official proposals. There will be a filter to show only official proposals in the proposals navigation page. + +image:components/proposals/new_proposal_backend01.png[New proposal form - default (official proposals)] + + +.New proposal form - default (official proposals) +|=== +|Field |Type |Description + +|Title +|Required +|What is the title of this proposal. For instance, "Bike lane in Main Street". Must have at least 15 characters as minimum +and 150 characters as maximum. Must start with a capital letter. + +|Body +|Optional +|What is the full description of this proposal. Must have at least 15 characters as minimum and 450 characters as maximum +by default but can be changed with the setting "Maximum proposal body length". + +|This proposal comes from a meeting +|Optional +|Check if this proposal comes from a meeting. + +|Select a meeting +|Required if the "This proposal comes from a meeting" checkbox is checked +|Dropdown selector with all the meetings of this space. The author of the proposal will be the meeting. +|=== + +As an example of what the form could look like depending on the settings enabled, here's a screenshot of the form for a proposal +with the following settings: "Hashtags added to all proposals", "Hashtags suggested to participants for new proposals", +"Geocoding enabled", "Allow attachments", "Allow card image" and "Scopes enabled". + +image:components/proposals/new_proposal_backend02.png[New proposal form - with multiple settings (official proposals)] + +==== Actions + + +.Actions +|=== +|Icon |Name |Definition + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for a proposal. It's the same form as "New proposal". Only visible when the proposal is an xref:_official_proposals["Official proposal"]. + +|image:action_answer.png[Answer proposal icon] +|xref:components/proposals/answers.adoc[Answer proposal] +|Allows you to answer a proposal. + +|image:action_permissions.png[Permissions icon] +|Permissions +| + +|image:action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. +|=== + +== Origin filter + +When navigating in the proposals listing, you can filter the proposals by origin. + +image:components/proposals/origin_filter.png[Proposals origin filter] + +There are five origin options: + +* All: select all the origins +* xref:_official_proposals[Official]: proposals created by administrators +* xref:_citizens_proposals[Citizens]: proposals created by participants +* Groups: proposals created by participants that belong to a user group and choose that option when creating the proposal +* Meetings: proposals created by administrators that have checked this option when creating the proposal + +== Proposal types and mechanisms + +There are different kind of proposals mechanisms that can be enabled in proposals, such as: + +* xref:admin:components/proposals/amendments.adoc[Amendments] +* xref:admin:components/proposals/answers.adoc[Answers] +* xref:admin:components/proposals/collaborative_drafts.adoc[Kollaborative Entwürfe] +* xref:admin:components/proposals/participatory_texts.adoc[teilnehmende Texte] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/components/proposals/amendments.adoc b/docs/de/modules/admin/pages/components/proposals/amendments.adoc new file mode 100644 index 0000000000..1bc4fd0b75 --- /dev/null +++ b/docs/de/modules/admin/pages/components/proposals/amendments.adoc @@ -0,0 +1,94 @@ += Amendments + +With the amendment feature, participants can propose changes to an already published proposal. + +It's useful to propose improvements or corrections, specially useful when redacting laws or normatives with xref:components/proposals/participatory_texts.adoc[Participatory Texts]. + +It has similarities with xref:components/proposals/collaborative_drafts.adoc[Collaborative Drafts], but the main difference +is that with amendments there is no need to trust the other authors intentions, as every change is reviewed and must be +approved by the author of the original proposal. + +image:components/proposals/amendments/amendment.png[Amendment of a proposal] + +To configure "Amendments" in proposals component: + +. 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 "Proposals" +. Check the "Amendments enabled" setting +. Review and configure the following related settings: "Amendments Wizard help text" in global component settings and "Amendment creation enabled", "Amendment reaction enabled", "Amendment promotion enabled", and "Amendments visibility" in the step component settings. +. Save the component + +== How it works + +. A participant (Alice) has created a proposal +. Another participant (Bob) has seen the proposal and wants to make some changes +image:components/proposals/amendments/proposal_to_amend.png[] +. Bob click on the "Amend proposal" button +. Bob makes the changes in the "Create amendment draft" form +image:components/proposals/amendments/create_amendment_draft.png[] +. Bob checks if there is any similar amendment +. Bob edits the amendment draft +image:components/proposals/amendments/edit_amendment_draft.png[] +. Bob publishes the amendment draft +image:components/proposals/amendments/publish_amendment_draft.png[] +. Anyone can see the amendment draft +image:components/proposals/amendments/proposal_amendmed.png[] +image:components/proposals/amendments/amendment_list.png[] +image:components/proposals/amendments/amendment_view_side_by_side.png[] +. It's also possible to filter the amended proposals +image:components/proposals/amendments/amendment_list_filter.png[] +. Alice receives a notification that Bob has proposed an amendment to their original proposal +image:components/proposals/amendments/proposal_amendmed_notification.png[] +. Alice can see the amendment proposal +image:components/proposals/amendments/proposal_amendmed_to_review.png[] +. Alice can review the amendment proposal +image:components/proposals/amendments/proposal_amendmed_review.png[] +. Alice can approve the amendment proposal +image:components/proposals/amendments/proposal_amendmed_accepted.png[] +. Anyone can see the final proposal +image:components/proposals/amendments/proposal_amendmed_final.png[] +image:components/proposals/amendments/proposal_amendmed_amendment_list.png[] +. Anyone can see the versions history of the proposal +image:components/proposals/amendments/proposal_amendmed_versions.png[] + +== Relevant component settings + + +.Proposals component form - Settings related to amendments +|=== +|Field |Type |Description + +|Amendments enabled +|Global +|Check to enable xref:components/proposals/amendments.adoc[amendments] in proposals. Other settings visible when enabling one. + +|Amendments Wizard help text +|Global +|What's the help text visible when creating new amendments. + +|Amendment creation enabled +|Step +|Participant can amend proposals. See xref:components/proposals/amendments.adoc[Amendments]. + +|Amendment reaction enabled +|Step +|Proposal's authors will be able to accept or reject Participant's emendations. + +|Amendment promotion enabled +|Step +|Emandation authors will be able to promote to Proposal the rejected emendation. + +|Amendments visibility +|Step +|Choose one of "Amendments are visible to all" or "Amendments are visible only to their authors" +|=== + +== Promotion + +If a proposal is rejected and the "Amendment promotion enabled" is enabled, then the author that have made the rejected +amendment will be able to promote to a new proposal the rejected emendation. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/components/proposals/collaborative_drafts.adoc b/docs/de/modules/admin/pages/components/proposals/collaborative_drafts.adoc new file mode 100644 index 0000000000..ef2c4cb7b3 --- /dev/null +++ b/docs/de/modules/admin/pages/components/proposals/collaborative_drafts.adoc @@ -0,0 +1,70 @@ += Collaborative draft + +With the collaborative draft feature participants can make a proposal with multiple authors. + +It's useful to propose improvements or corrections. + +It has similarities with xref:components/proposals/amendments.adoc[Amendments] but the main difference is that with collaborative +drafts there is a need to trust other authors, as they can make any change to the original proposal without approval by the +original author, although the original author can decide if they promote the collaborative draft as a proposal. + +image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[Collaborative draft with request access button] + +To configure "Collaborative Drafts" in Proposals component: + +. 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 "Proposals" +. Check the "Collaborative drafts enabled" setting +. Save the component + +== How it works + +. A participant (Alice) wants to create a collaborative draft. For that, they go to the proposals list page. +. Alice clicks in the "Access collaborative drafts" button +image:components/proposals/collaborative_drafts/proposals_list01.png[] +. Alice clicks in "New collaborative draft" button +image:components/proposals/collaborative_drafts/list_empty.png[] +. Alice fills the form and submits it +image:components/proposals/collaborative_drafts/create_form.png[] +. Once the collaborative draft is created, Alice can: edit, withdraw or publish the collaborative draft and approve or +reject collaboration requests +image:components/proposals/collaborative_drafts/collaborative_draft.png[] +. Another participant (Bob) has seen the collaborative draft and wants to make some changes +image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[] +. Bob clicks in the "Request access" button +image:components/proposals/collaborative_drafts/access_requested.png[] +. Alice receives the notification +image:components/proposals/collaborative_drafts/notification.png[] +. Alice goes to the collaborative draft. There they can accept or reject the collaboration request +image:components/proposals/collaborative_drafts/author_sidebar.png[] +. Alice approves the collaboration request. Once a request is approved it can't be rejected +. Now the collaborative draft has multiple authors +image:components/proposals/collaborative_drafts/multiple_authors.png[] +. Bob can edit the collaborative draft by clicking in the "Edit collaborative draft" button +image:components/proposals/collaborative_drafts/edit_collaborative_draft.png[] +image:components/proposals/collaborative_drafts/edit_form.png[] +. Once the collabrative draft is edited, then it's possible to see the old versions and its changes +image:components/proposals/collaborative_drafts/collaborative_draft_edited.png[] +image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions.png[] +image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_01.png[] +image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_02.png[] +. Once Alice is satisfied with the collaborative draft, they can publish it by click in the "Publish" button +image:components/proposals/collaborative_drafts/publish_modal.png[] +. When it's published it becomes a proposal +image:components/proposals/collaborative_drafts/proposal.png[] +image:components/proposals/collaborative_drafts/proposals_list02.png[] +. And the collaborative draft is still visible although it can't be edited anymore +image:components/proposals/collaborative_drafts/collaborative_draft_published.png[] + +== Important aspects + +- A collaborative draft can has any number of authors. +- Only the original author can approve or reject the collaboration requests. +- Only the original author can publish the collaborative draft. +- Only the original author can withdraw the collaborative draft. +- Once a collaboration request is approved, it can't be rejected. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/features/badges.adoc b/docs/de/modules/admin/pages/features/badges.adoc new file mode 100644 index 0000000000..7d546a113e --- /dev/null +++ b/docs/de/modules/admin/pages/features/badges.adoc @@ -0,0 +1,76 @@ += Badges + +Badges are recognitions to participant actions and progress in the platform. As participants start discovering, participating +and interacting in the platform, they will earn different badges. Here is the list of badges and some ways participants can earn them. + +It's a https://en.wikipedia.org/wiki/Gamification[gamification] mechanism to improve the engagement of the participants in a ludic way. + +The badges a participant has are visible in their account. There's also a general explanation page with a short description of every badge. + +image:features/badges/example01.png[Example of badges in profile] + +When a participant earns a badge they receive a notification. + +image:features/badges/notification.png[Example of badges notification] + +Badges have multiple levels, depending in the number of times they have made the action. For instance, for Proposals badge +they will receive the first level badge when arriving at 1 follower, the second level at 15 followers, the third level at 30 followers, +the fourth level at 60 and the fifth level at 100. + + +.Badges +|=== +|Image |Title |Description |How it's earned |Levels + +|image:features/badges/accepted_proposals_badge.png[Accepted proposals badge] +|Accepted proposals +|Granted when particiapnts actively participate with new proposals and these are accepted. +|The participant needs to choose the participation space of their interest with submission for proposals enabled and try to +make proposals that can be carried out. This way they are more likely to be accepted. +|1, 5, 15, 30, 50 + +|image:features/badges/attended_meetings_badge.png[Attended meetings badge] +|Attended meetings +|Granted when participants attend several face-to-face meetings. +|The participant needs to register for the meetings they want to attend +|1, 3, 5, 10, 30 + +|image:features/badges/debates_badge.png[Debates badge] +|Debates +|Granted when participants actively participate in the different debates by leaving comments. +|The participant needs to take part in debates. +|1, 5, 10, 30, 50 + +|image:features/badges/followers_badge.png[Followers badge] +|Followers +|Granted when participant reach a certain number of followers. The platform is a social and political network, so +participants ned to weave their web to communicate with other people in the platform. +|The participant needs to be be active and follow other people. That will surely make other people follow them. +|1, 15, 30, 60, 100 + +|image:features/badges/published_initiatives_badge.png[Published initiatives badge] +|Published initiatives +|Granted when a participant launch new initiatives, partnering with others to carry them out. +|The participant needs to go to the participation space of Intiatives and follow the steps to create a new initiative. +|1, 5, 15, 30, 50 + +|image:features/badges/invitations_badge.png[invitations badge] +|Invitations +|Granted when participants invite some people and they have become participants. +|The participant needs to use the “invite friends” link on their user page to invite their friends. They can customize the +message they are sending. They will level up by sending invitations and getting them registered. Note that this feature is disabled +and this badge is not available, so it'll be removed in the future. +|1, 5, 10, 30, 50 + +|image:features/badges/proposal_supports_badge.png[Proposal supports badge] +|Proposal supports +|Granted when participants support other people's proposals. +|The participant needs to browse and spend some time reading other people's proposals and give support to the proposals they like or find interesting. +|5, 15, 50, 100, 500 + +|image:features/badges/proposals_badge.png[Proposals badge] +|Proposals +|Granted when participants actively participate with new proposals. +|The participant needs to choose the participation space of their interest with submission for proposals enabled and create a new proposal. +|1, 5, 10, 30, 60 +|=== \ No newline at end of file diff --git a/docs/de/modules/admin/pages/features/endorsements.adoc b/docs/de/modules/admin/pages/features/endorsements.adoc new file mode 100644 index 0000000000..90b2f56ab5 --- /dev/null +++ b/docs/de/modules/admin/pages/features/endorsements.adoc @@ -0,0 +1,17 @@ += Endorsements + +Through endorsements, participants can publicly show that they want to support a particular content, for instance, a proposal. + +image:features/endorsements/list.png[List of endorsements] + +This is done through the button in the sidebar. Administrators can enable or disable them by step in a given participatory process, and they can also define permissions with authorizations. + +image:features/endorsements/sidebar.png[Endorsement button in sidebar] + +When a participant belongs to a verified group they can also endorse like that group by selecting the identity. + +image:features/endorsements/modal.png[Select identity modal] + +By default the endorsements list is collapsed. To see it fully visitors need too click in the "(see more)" link. + +image:features/endorsements/full_list.png[Full list of endorsements] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/features/my_account.adoc b/docs/de/modules/admin/pages/features/my_account.adoc new file mode 100644 index 0000000000..fa2b664363 --- /dev/null +++ b/docs/de/modules/admin/pages/features/my_account.adoc @@ -0,0 +1,19 @@ += My account + +My account is all the pages where a participant can change their personal data that is displayed in their xref:admin:features/my_public_profile.adoc[My public profile] page, change their notifications settings, see which groups they belong to, etc. + +To go to this section: + +. Sign in as a participant +. Click in the name of the participant in the header +. Click in "My account" + +The actions that they can do are: + +* xref:admin:features/my_account/account.adoc[Account] +* xref:admin:features/my_account/notifications_settings.adoc[Benachrichtigungseinstellungen] +* xref:admin:features/my_account/authorizations.adoc[Authorizations] +* xref:admin:features/my_account/groups.adoc[Groups] +* xref:admin:features/my_account/my_interests.adoc[Meine Interessen] +* xref:admin:features/my_account/my_data.adoc[Meine Daten] +* xref:admin:features/my_account/delete_my_account.adoc[Mein Konto löschen] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/features/my_account/account.adoc b/docs/de/modules/admin/pages/features/my_account/account.adoc new file mode 100644 index 0000000000..115a68a819 --- /dev/null +++ b/docs/de/modules/admin/pages/features/my_account/account.adoc @@ -0,0 +1,47 @@ += Account + +In this section is possible to make modifications that will be visible in the participants xref:features/my_public_profile.adoc[public profile] and also modify the email address or the language that the platform will use with the user. + +. Sign in as a participant +. Click in the name of the participant in the header +. Click in "My account" + +image:features/my_account/account.png[My account form] + + +.Participant settings - My account form +|=== +|Field |Type |Description + +|Avatar +|Optional +|Avatar or picture for the participant. Guidance for image: Preferrably a landscape image that does not have any text. +The service crops the image. Maximum file size: 5MB + +|Your name +|Required +|The name of the participant. + +|Nickname +|Required +|The nickname of the participant. + +|Your email +|Required +|The email of the participant, where they will receive notifications, password recovery, etc. If it's changed it needs to be +confirmed. + +|Personal URL +|Optional +|Metadata that is displayed in the participant's profile. + +|About +|Optional +|Metadata that is displayed in the participant's profile. + +|Locale +|Required +|Choose the language you want to use to browse and receive notifications in Decidim +|=== + +From this page is possible to also modify the participant's password. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/features/my_account/delete_my_account.adoc b/docs/de/modules/admin/pages/features/my_account/delete_my_account.adoc new file mode 100644 index 0000000000..3522a1c183 --- /dev/null +++ b/docs/de/modules/admin/pages/features/my_account/delete_my_account.adoc @@ -0,0 +1,21 @@ += Delete my account + +In this section participants will be able to delete their own accounts. This means that they will be unable to access the system anymore. This action is irreversible. All the contributions will be anonymized. + +image:features/my_account/delete_my_account.png[Delete my account form] + +To delete the account: + +. Sign in as a participant +. Click in the name of the participant in the header +. Click in "My account" +. Click in "Delete my account" in the sidebar +. Optionally, they can provide a reason for the deletion +. Click in "Delete my account" +. Click in "Yes, I want to delete my account" + +image:features/my_account/delete_my_account_confirm.png[Confirm account deletion] + +After the account has been deleted, the contributions (such as comments, proposals, etc), will be still visible but all the authorship information will be anonymized, belonging to an special kind of author called "Participant deleted": + +image:features/my_account/delete_my_account_deleted.png[Deleted participant contribution] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/features/notifications.adoc b/docs/de/modules/admin/pages/features/notifications.adoc new file mode 100644 index 0000000000..63fd21efd8 --- /dev/null +++ b/docs/de/modules/admin/pages/features/notifications.adoc @@ -0,0 +1,230 @@ += Notifications + +== The notification menu + +Most of the actions in the platform generate notifications so particpants can know when there are new things to watch. + +This is accessible from the `Notifications` menu item (image:icon_bell.png[Notification icon]) in the header, after a participant has logged in. + +To see the notifications: + +. Sign in as participant +. Click in the notifications icon in the header + +If there are notifications, then the participant will see the icon with a color image:icon_bell_on.png[Notification icon with color] + +image:features/notifications/notifications.png[Example of notifications page when there are notifications] + +image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] + +== Notifications list + +Below is an exhaustive list of actions that trigger notifications to participants. Participants are divided into three categories: affected users, followers, and administrators. + +[NOTE] +==== +Affected users depend on the notification context. For instance, it could be the author of moderated content, a user that earns a badge, a user that has been mentioned, etc. +==== + +[cols="7,2,1,1,1"] +|=== +|Action |Feature |Affected user |Follower |Administrator + +|A new attachment has been created |Administrator |❌ |✅ |❌ + +|An admin requested an export |Administrator |❌ |❌ |✅ + +|A component has been published in a participatory space |Administrator |❌ |✅ |❌ + +|A participant has tried to verify themself with the data of another participant |Verifications |❌ |❌ |✅ + +|An administrator moderated a resource because it has been reported |Moderation |✅ |❌ |❌ + +|A resource has been reported |Moderation |❌ |❌ |✅ + +|A user confirms the registration (if welcome notification is enabled) |User |✅ |❌ |❌ + +|A user earned a badge (if badges are enabled) |User |✅ |❌ |❌ + +|A user has reached a new badge level (if badges are enabled) |User |✅ |❌ |❌ + +|A user has been officialized |User |❌ |❌ |✅ + +|A user asked their data export |User |✅ |❌ |❌ + +|A user I follow endorsed a resource |User |❌ |✅ |❌ + +|A public profile has been updated |User |❌ |✅ |❌ + +|A new user group has been created |User groupsfootnote:user-group[If user groups are enabled] |❌ |❌ |✅ + +|A user group has updated its profile |User groupsfootnote:user-group[] |❌ |❌ |✅ + +|A user has been invited to join a user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user has been promoted as group admin |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user requested to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request has been accepted to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request to join the user group has been rejected |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The group admin has been demoted |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The user has been removed from the group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|An admin of the assembly has added you as one of its members |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the assembly |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the participatory process |Processes |✅ |❌ |❌ + +|The phases dates have been updated |Processes |❌ |✅ |❌ + +|A new phase has been activated |Processes |❌ |✅ |❌ + +|You have been assigned a role for the conference |Conferences |✅ |❌ |❌ + +|The registration to the conference has been confirmed |Conferences |✅ |❌ |❌ + +|The registration for the conference is open |Conferences |❌ |✅ |❌ + +|The conference occupied slots are over X% |Conferences |❌ |❌ |✅ + +|The conference is taking place in 2 days |Conferences |❌ |✅ |❌ + +|The conference has been updated |Conferences |❌ |✅ |❌ + +|The election is now active for the participatory space |Elections |❌ |✅ |❌ + +|You are added as a trustee for the election |Elections |✅ |❌ |❌ + +|An admin has added you as trustee |Elections |✅ |❌ |❌ + +|Your vote was accepted |Elections |✅ |❌ |❌ + +|You have been assigned a role of the Polling Station |Elections |✅ |❌ |❌ + +|Here is your Access Code |Elections |✅ |❌ |❌ + +|A user I follow created an initiative |Initiatives |❌ |✅ |❌ + +|My initiative has been created |Initiatives |✅ |❌ |❌ + +|A user I follow endorsed an initiative |Initiatives |❌ |✅ |❌ + +|A user sent their initiative to technical validation |Initiatives |❌ |❌ |✅ + +|The initiative has changed its status |Initiatives |✅ |✅ |❌ + +|The signatures end date for the initiative have been extended |Initiatives |❌ |✅ |❌ + +|The request to be part of the promoter committee for the initiative has been accepted |Initiatives |✅ |❌ |❌ + +|The request to be part of the promoter committee for the initiative has been rejected |Initiatives |✅ |❌ |❌ + +|A user wants to join your initiative |Initiatives |✅ |❌ |❌ + +|The initiative has reached the signatures threshold |Initiatives |❌ |❌ |✅ + +|Your initiative has achieved the X% of signatures |Initiatives |❌ |✅ |❌ + +|The initiative has achieved the X% of signatures |Initiatives |✅ |❌ |❌ + +|The proposal has been included in a result |Accountability |❌ |✅ |❌ + +|The result progress has been updated |Accountability |❌ |✅ |❌ + +|A post has been published |Blogs |❌ |✅ |❌ + +|The budget is now active |Budgets |❌ |✅ |❌ + +|A resource has a comment |Comments |❌ |✅ |❌ + +|A user group has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has replied your comment |Comments |✅ |❌ |❌ + +|A group you belong to has been mentioned |Comments |✅ |❌ |❌ + +|You have been mentioned |Comments |✅ |❌ |❌ + +|Your comment in has been upvoted |Comments |✅ |❌ |❌ + +|Your comment in has been downvoted |Comments |✅ |❌ |❌ + +|A debate has been created |Debates |❌ |✅ |❌ + +|Debate creation is enabled for participants |Debates |❌ |✅ |❌ + +|Debate creation is no longer active |Debates |❌ |✅ |❌ + +|The debate was closed |Debates |✅ |✅ |❌ + +|A meeting has been created |Meetings |❌ |✅ |❌ + +|A meeting was closed |Meetings |✅ |✅ |❌ + +|A meeting was updated |Meetings |❌ |✅ |❌ + +|Your meeting's registration has been confirmed |Meetings |✅ |❌ |❌ + +|The allocated slots for the meeting are over X% |Meetings |❌ |❌ |✅ + +|The meeting has enabled registrations |Meetings |❌ |✅ |❌ + +|The registration code for the meeting has been validated. |Meetings |✅ |❌ |❌ + +|The meeting will start in less than 48h |Meetings |❌ |✅ |❌ + +|A new proposal has been published |Proposals |❌ |✅ |❌ + +|Proposal creation is open |Proposals |❌ |✅ |❌ + +|Proposal supports are open |Proposals |❌ |✅ |❌ + +|Proposal endorsements are open |Proposals |❌ |✅ |❌ + +|Someone has left a note on the proposal |Proposals |❌ |❌ |✅ + +|A proposal is currently being evaluated |Proposals |✅ |✅ |❌ + +|A proposal has been rejected |Proposals |✅ |✅ |❌ + +|A proposal has been accepted |Proposals |✅ |✅ |❌ + +|An admin has updated the scope of your proposal |Proposals |✅ |❌ |❌ + +|An admin has updated the category of your proposal |Proposals |✅ |❌ |❌ + +|A proposal has been mentioned |Proposals |✅ |❌ |❌ + +|A user requested access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user withdrawn the collaborative draft |Proposal drafts |✅ |❌ |❌ + +|An amendment has been rejected |Amendmentsfootnote:amendments[If amendments are enabled] |✅ |✅ |❌ + +|An amendment has been accepted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been created |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been promoted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|A sortition has been created |Sortitions |❌ |✅ |❌ + +|A survey has been opened |Surveys |❌ |✅ |❌ + +|A survey has been closed |Surveys |❌ |✅ |❌ +|=== \ No newline at end of file diff --git a/docs/de/modules/admin/pages/global_moderations.adoc b/docs/de/modules/admin/pages/global_moderations.adoc new file mode 100644 index 0000000000..ce8d81dee3 --- /dev/null +++ b/docs/de/modules/admin/pages/global_moderations.adoc @@ -0,0 +1,121 @@ += Global moderations + +The *Global moderations* function allows you to moderate different kind of contents and +ensure that the dialog in your platform is democratic and constructive. Making +use of this function, administrators, collaborators and moderators of a space can +hide the contents/contributions that have been reported, where the complaint is +deemed appropriate, or delete the complaint. + +NOTE: Looking for how to report users? See xref:participants/reported_users.adoc[Reported users]. + +For instance, in the case of https://www.decidim.barcelona/[Decidim Barcelona], +the https://www.decidim.barcelona/pages/terms-and-conditions[Terms of Service] says: + +> It is not allowed to add any illegal or unauthorized content to the site, such +> as information with the following features: +> +> * be it false or misleading; +> * to infringe any law of the City Council or any third party, such as copyright, +> trademarks or other intellectual and industrial property rights or related rights; +> * attacking the privacy of a third party, such as publishing personal details +> of participants, such as name, address, phone number, email, photos or any other +> personal information; +> * containing viruses, Trojans, robots or other programs that may harm the website +> or the City Hall systems, or the website or system of any third party, or which +> intend to circumvent the technical measures designed for the proper functioning +> of the platform; +> * to send spam to users or overload the system; +> * which has the character of message chain, pyramidal game or random game; +> * for commercial purposes, such as publishing job offers or ads; +> * that it is not in keeping with public decency; consequently, content must not +> incite hatred, discriminate, threaten, provoke, have no sexual, violent, coarse or +> offensive meaning or character; +> * to infringe the law or applicable regulation; +> * to campaign by promoting mass voting for other proposals not related to the +> process and the framework for discussion, and +> * to create multiple users by pretending to be different people (astroturfing). + +Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant +profile. After a participant has clicked in this action then they need to provide a +reason why they are making this report: + +* Contains clickbait, advertising, scams or script bots. +* Contains racism, sexism, slurs, personal attacks, death threats, suicide requests or any form of hate speech. +* Contains illegal activity, suicide threats, personal information, or something else you think doesn't belong on [This organization]. + +Participants can also add extra information regarding their report. + +image:moderation_modal.png[Give reason for moderation modal] + +After a participant has reported a content, it'll be shown in two sections of the +administration panel: + +* Global moderations panel +* Participatory space moderation panel + +To go to the Global moderations panel, you need to: + +. Sign in as administrator +. Go to administration panel +. Click in Global moderations in the sidebar + +There you'll find first all the unprocessed reports if there's any: + +image:global_moderations_list_unhidden.png[Show all the moderated content list] + +It's also possible to filter by the type of content that was moderated and the +state of the reported content (if it was hidden or not). + +* *Id*: unique identificator of the reported content. +* *Type*: which kind of content it was reported, for instance a *Proposal* or a *Comment*. +* *Participatory Space*: which space this content belongs to. +* *Count*: Number of times it has been reported by different users. +* *Reported content URL*: link for seeing the content reported and see the context of the complaint. +* *Reports*: why it has been reported. If the participant that made the report has given extra +information it's possible to see it by hovering it. +* *Creation date*: when it was originally reported. +* *Actions*: you can *Expand*, *Unreport* or *Hide*. + +== Actions (when the report wasn't accepted yet) + +|=== +|Icon |Name |Definition + +|image:action_expand.png[Expand icon] +|Expand +|To see the full metadata of the reported content. + +|image:action_hide.png[Hide icon] +|Hide +|Allows an admin or moderator to hide this content (accepting the report). + +|image:action_unreport.png[Unreport icon] +|Unreport +|Allows an admin or moderator to keep showing this content (rejecting the report). +|=== + +== Actions (after the content is hidden) + +|=== +|Icon |Name |Definition + +|image:action_expand.png[Expand icon] +|Expand +|To see the full metadata of the reported content. + +|image:action_unhide.png[Unhide icon] +|Unhide +|Allows an admin or moderator to unhide this content (showing it publicly again). +|=== + +If the report was "Unreported" and it was a mistake, meaning that for instance the +content was spam but it was a mistake not accepting the report, then you'll need +to find that again in the public view and report it yourself so you can moderate it. + +== Expand + +To see all the metadata of a report, you can see it Expanded. + +image:global_moderations_report01.png[Expanded moderation 01] + +image:global_moderations_report02.png[Expanded moderation 02] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/help_sections.adoc b/docs/de/modules/admin/pages/help_sections.adoc new file mode 100644 index 0000000000..9be6d5e3d7 --- /dev/null +++ b/docs/de/modules/admin/pages/help_sections.adoc @@ -0,0 +1,23 @@ += Help sections + +The first time a visitor goes to any Space page they will see an information box about what's this Space about. + +This is how the information box is shown to participants and visitors: + +image:help_sections_frontend.png[Help sections: frontend] + +They can hide this box by clicking in the close button [X]. This gets remembered by the application. They can open this box again by clicking in [Help: ?]. + +image:help_sections_frontend_hide.png[Help sections: hide] + +As this is something that depends on your given installation, an administrator can customize these *Help sections*, adapting them to your needs. + +image:help_sections_backend.png[Help sections: backend] + +== Disable + +You can disable these information boxes by leaving the contents all empty for every language: + +image:help_sections_disable_backend.png[Disable help section in admin] + +image:help_sections_disable_frontend.png[Disabled help section] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/newsletters.adoc b/docs/de/modules/admin/pages/newsletters.adoc new file mode 100644 index 0000000000..cddc909cf4 --- /dev/null +++ b/docs/de/modules/admin/pages/newsletters.adoc @@ -0,0 +1,164 @@ += Newsletters + +Newsletters are emails sent to the organization's participants with the news. They are +sent to participants that have checked the "Receive an occasional newsletter +with relevant information" when the participant signed up or after in their account. + +image::newsletter_contact_permission.png[Contact permission in participant registration] + +image::newsletter_participant_notifications_settings.png[Contact permission in participant account] + +Some examples of when you can and should sent a newsletter are: + +* When a new process could be interesting for all the citizens in a city, +for instance a Participatory Budgeting process. +* When there are the results published for a given process. +* When an assembly has a important point for discussion. +* When there's a new voting planned. +* When there's a new conference published + +To create a new newsletter, as an administrator you need to: + +. Go to newsletter menu +. Click in the button "New newsletter" +. Select the template that you want to use +. Fill the form with the newsletter contents +. Preview the newsletter +. Select recipients to deliver +. Deliver the newsletter + +== 1. Go to newsletter menu + +It's on the main sidebar of the admin panel. + +image::newsletter_menu.png[Newsletter admin menu] + +== 2. Click in the button "New newsletter" + +In this page you'll have a list of all the sent newsletters, along with the status +(if it was sent already or not) and how many participants have received it. + +image::newsletter_list.png[Newsletter list] + +In the secondary sidebar or in the top of the list you have the button for "New +newsletter". + +== 3. Select template of new newsletter + +Depending on what you want to sent, if it's just a quick update or if it's something +a little more elaborated (with an image and a button), then you can choose for +which kind of template you want to use: + +* Basic (only text) +* Text, image and Call to Action button + +image::newsletter_templates.png[Newsletter new templates selection] + +== 2. Fill the form with the newsletter contents + +Depending in which template you've choosen, you have two different forms for +filling: + +=== Basic (only text) newsletter form + +image::newsletter_new_basic.png[Newsletter new template basic form] + +image::newsletter_new_basic_example.png[Newsletter new template basic form filled] + +[NOTE] +==== +You can use "%\{name}" anywhere in the body or subject and it will be +replaced by the recipient's name. +==== + + +.New Newsletter "basic (only text)" form +|=== +|Field |Type |Description + +|Subject +|Required +|Subject of the email. + +|Body +| +|Body of the email. +|=== + +=== Text, image and Call to Action button newsletter form + +image::newsletter_new_cta01.png[Newsletter new template text, image and CTA form 1] + +image::newsletter_new_cta02.png[Newsletter new template text, image and CTA form 2] + + +.New Newsletter "Image, text and Call To Action button" form +|=== +|Field |Type |Description + +|Subject +|Required +|Subject of the email. + +|Introduction +| +|Body of the email. + +|Call To Action button text +| +|What will the button say. For instance, it could be "Participate" + +|Call To Action button URL +| +|Where will the button link to. For instance, it could be the complete URL of a participatory process. + +|Body +| +|Body of the email. + +|Main image +| +|Guidance for image: Preferrably a landscape image that does not have any text. The service crops the image. Allowed file extensions: jpg jpeg gif png bmp ico +|=== + +== 3. Preview the newsletter + +After you've filled the contents of the newsletter, you can preview it. Until you've +sent it you can go back and edit it anytime you want. + +image::newsletter_preview_basic_example.png[Newsletter new template basic form preview] + +== 4. Select recipients to deliver + +If you want to only communicate about a given space, one useful way of doing this +is through the "Select recipients to deliver". Here you can choose between: + +* Sending the newsletter to all confirmed users +* Sending the newsletter to all confirmed users that have participated in any of +the selected participatory spaces in the list +* Sending the newsletter to all confirmed users that have followed any of +the selected participatory spaces in the list +* Sending the newsletter to all the participants that have selected an scope in +their "My interests" settings in their account. + +It's important to note that even if a participant has confirmed their account and +is following the space, the system will not send them a newsletter email if they +haven't activated the "I want to receive newsletters". + +image::newsletter_select_recipients.png[Newsletter select recipients] + +If you select the "Sent do participants" or "Send to followers" of a given space, +then you can choose which spaces are relevant: + +image::newsletter_select_recipients_spaces.png[Newsletter select recipients spaces] + +== 5. Deliver the newsletter + +Finally if you click in the "Deliver newsletter" button, the newsletter will be +sent to all the selected recipients. + +[NOTE] +==== +Once a newsletter was sent it can't be undone nor edited. If you have multiple +languages active, be careful with reviewing all the languages well before sending. +==== \ No newline at end of file diff --git a/docs/de/modules/admin/pages/pages.adoc b/docs/de/modules/admin/pages/pages.adoc new file mode 100644 index 0000000000..7912951b95 --- /dev/null +++ b/docs/de/modules/admin/pages/pages.adoc @@ -0,0 +1,125 @@ += Pages + +You can configure static Pages, which contains general information to the participants of the platform. + +As an example, some of these pages could refer to: + +* What's this platform? Who's the organization? +* How can I participate here? +* How can I create and verify my account? +* What are the terms of conditions and the legal information about this platform? + +These pages will be available to all the participants through the **Help** top menu section and also at the footer sections. You can define **Topics** to categorize all of these pages. + +As the platform enables the Participants to sign up (register) and save some of their personal data, it's important that there's an especial page, called **Terms and Conditions**. This is where you need to put your legal terms, for instance which entity has control of this data, how much time does this data will be saved, etc. This should be (ideally) written and (at least) reviewed by a lawyer. + +== Create a new page + +For creating a new page, you need to: + +. Sign in as admin +. Click in Pages in the sidebar menu +. Click in "Create page" + +image::pages_backend_form.png[Backend: new page form] + + +.New page form +|=== +|Field |Type |Description + +|Title +|Required +|Title of this page. For instance: "How to participate?" + +|URL Slug +|Required +|String that will be used on the URL. Benutze hier partielle Pfade, nicht vollständige URLs. Akzeptiert Buchstaben, Zahlen, Bindestriche und Schrägstriche und muss mit einem Buchstaben beginnen. For instance if the slug is "hello-world" and your domain is "https://example.org", your page will be at "https://example.org/hello-world" + +|Content +|Required +|All the text of the page. + +|Topic +|Optional +|In which Topic it'll be in. + +|Weight +|Optional +|Which order will it have in relation with the other pages. Having a lower number means a higher priority. For instance, if you have two pages, "Page a" with weight "10" and "Page b" with weight "0", then "Page b" will be first when ordering. + +|Show in the footer +|Optional +|Wether you want to show this page in the general footer (available in every page). +|=== + +image::pages_frontend_footer.png[Frontend: example of a page in the footer] + +== Create a new topic + +For creating a new topic, you need to: + +. Sign in as admin +. Click in Pages in the sidebar menu +. Click in "Create topic" + +image::pages_backend_topic_form.png[Backend: new topic form] + + +.New topic form +|=== +|Field |Type |Description + +|Title +|Required +|Title of this topic. For instance: "Help" + +|Description +|Optional +|What's this topic is about. + +|Weight +|Optional +|Which order will it have in relation with the other topics. Having a lower number means a higher priority. For instance, if you have two topics, "Topic a" with weight "10" and "Topic b" with weight "0", then "Topic b" will be first when ordering. + +|Show in the footer +|Optional +|Wether you want to show this topic in the general footer (available in every page). +|=== + +== Special "Terms and Conditions" page + +This is where you need to put your legal terms, for instance which entity has control of this data, how much time does this data will be saved, etc. This should be (ideally) written and (at least) reviewed by a lawyer. + +It's generated by default in a new installation. It can't be deleted, and it has a few special details related with its legal nature: + +. It's shown in the text area sign up form +. If there are meaningful changes, it has a field that can allow an admin when it's necessary that the participants accept the "Terms and Conditions" again, in the next sign in. + +image::pages_backend_tos_change.png[Backend: ToS change] + +image::pages_frontend_tos_change.png[Frontend: ToS change] + +If a participant rejects to accept the terms, then they have three options: + +. To review this again later. It signs them out automatically. +. To download their personal data +. To delete their account + +image::pages_frontend_tos_reject.png[Frontend: ToS reject] + +== Examples + +=== Pages + +image::pages_frontend_show.png[Frontend: show a page] + +image::pages_backend_edit.png[Backend: edit a page] + +image::pages_backend_list.png[Backend: list pages] + +=== Topics + +image::pages_frontend_list_topics.png[Frontend: list topics of pages] + +image::pages_backend_list_topics.png[Backend: list topics of pages] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/admins.adoc b/docs/de/modules/admin/pages/participants/admins.adoc new file mode 100644 index 0000000000..0746ef9183 --- /dev/null +++ b/docs/de/modules/admin/pages/participants/admins.adoc @@ -0,0 +1,21 @@ += Admins + +In the administrator listing page you can see all the administrators of the platform: + +image:admins.png[Admins list] + +Here you can: + +* invite new administrators +* revoke administrators permissions +* see when was the last time an administrator logged in + +For inviting a new administrator, you need to go to the button "New user" and fill +the form with the admin username, email and which role will they have: + +* Admin: to give full access to the platform +* Participant manager: to give permission to only do xref:admin:participants/impersonations.adoc[Impersonations] + +image:admins_invite.png[Invite participant as administrator form] + +You can invite an already registered or a non registered participant. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/authorizations.adoc b/docs/de/modules/admin/pages/participants/authorizations.adoc new file mode 100644 index 0000000000..af3a909045 --- /dev/null +++ b/docs/de/modules/admin/pages/participants/authorizations.adoc @@ -0,0 +1,40 @@ += Authorizations + +This section allows you to manage participants' authorizations. It depends on which Authorizations you have configured and +enabled by your developers. To understand more what are authorizations and how to configure them, please refer to the +xref:customize:authorizations.adoc[Authorizations section in the Customize Guide]. + +With authorizations an administrator can define different permissions so participants can make some actions in a component. +For instance you can configure that only participants who have verified herselves by their identity documents can vote on +proposals in a participatory process. + +A participant can see which authorizations do they have available in their account settings. + +image:authorizations_account.png[Authorizations in participants account] + +== Authorizations revocation + +A default Decidim installation will not have verified participants. + +image:authorizations_admin_default.png[Authorizations in a default installation] + +In the moment that there are some participants verified, an administrator can revoke all the authorizations, as the attributes +that give permissions to those participants could be changed in time and the platform didn't receive these changes in the +participants statuses. For instance, an identity document of a participant could be expired, or if a participant have been +authorized by the "code by postal letter", that participant could move in the meantime. + +image:authorizations_admin_revocation.png[Authorizations revocation] + +It's possible to revoke all the authorizations with "Revoke all", or to only revoke authorizations before a given date. +Another possiblity is to revoke only the xref:admin:participants/impersonations.adoc[impersonated participants]. + +== Verification methods + +Some of the available authorizations by default are: + +* xref:admin:participants/authorizations/identity_documents.adoc[Identifizierungsdokumente] +* xref:admin:participants/authorizations/code_postal_letter.adoc[Code by postal letter] +* xref:admin:participants/authorizations/census.adoc[Organization's census] + +If any of these authorizations are not useful for your needs, talk with your implementer to see other alternatives. Learn +more about xref:customize:authorizations.adoc[Authorizations in the Customize Guide section]. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/authorizations/census.adoc b/docs/de/modules/admin/pages/participants/authorizations/census.adoc new file mode 100644 index 0000000000..bc81ab9578 --- /dev/null +++ b/docs/de/modules/admin/pages/participants/authorizations/census.adoc @@ -0,0 +1,34 @@ += Organization's census authorization + +The process is as follows: + +. Admins upload a CSV with the emails of the accepted participants +. Participants go to its accounts and requests to be verified +. Only participants with an email in that CSV file can get verified + +NOTE: is this too simple and you need more features related to CSV census imports? +Check all the CSV or file based authorizations in our https://decidim.org/modules/[Modules page]. + +== 1. An administrator uploads the CSV of the participants + +In the admin panel, the administrator can review the request by going to the "Organization's census" in the "Participants" section. + +image:authorizations_organization_census.png[Organization's census in admin panel] + +After the CSV is imported then the administrator can see how many participants where imported. They can also delete this +imported census. + +image:authorizations_organization_census_imported.png[Imported CSV] + +== 2. A participant requests to be verified + +By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +a participant can request to be verified. + +image:authorizations_organization_census_account.png[Organization's census in participant's accounts] + +== 3. The participant is verified (or not) + +After is verified, as with other verifications, they can see it in their account settings. + +image:authorizations_organization_census_verified.png[Verified by organization's census] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/authorizations/code_postal_letter.adoc b/docs/de/modules/admin/pages/participants/authorizations/code_postal_letter.adoc new file mode 100644 index 0000000000..7ad078d0f9 --- /dev/null +++ b/docs/de/modules/admin/pages/participants/authorizations/code_postal_letter.adoc @@ -0,0 +1,57 @@ += Code by postal letter authorization + +This authorization allows a participant to request for a verification code to be sent to its address, to confirm that they +live or work in this place. They will need to then fill the code in the platform. + +The process is: + +. Participants request a verification code to be sent to their address. +. An administrator sends the letter to their address with the verification code. +. An administrator marks the letter as sent. +. Once you mark the letter as sent, the participant will be able to introduce the code. +. If this code matchs, then they get verified. + +== 1. A participant request the verification code + +By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +a participant can see the form for filling in their full address to request the verification code. + +image:authorizations_code_postal_letter_request.png[Code by postal letter request by participant] + +If they try to edit it, they will see this message: + +image:authorizations_code_postal_letter_edit.png[Edit the postal letter request] + +This is because the letter could be in the process of being sent. If this needs to be corrected, then the participant needs +to contact to the organization. + +== 2. An administrator review this request and sent the letter + +In the admin panel, the administrator can review the request by going to the "Code by postal letter" in the "Participants" section. + +image:authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in admin] + +Here they can see the verification code and can send it to the participant by mail. After the code is sent they can mark it +as sent with the icon image:action_mark_as_sent.png[Mark as sent]. It'll also show when the letter was sent. + +== 3. A participant fills in the verification code + +After the participant has received the code, they can go to their account settings and click in the "Code by postal letter" +verfication method. + +image:authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account] + +Then they will see the form for confirming the code. + +image:authorizations_code_postal_letter_confirm.png[Code by postal letter confirmation form] + +== 4. The verification code matches or not + +If the verification code matches, then the participant will see the message "Congratulations. You've been successfully verified". + +On the other hand, if the verification code doesn't match, then the participant will see the message "Your verification +code doesn't match ours. Please double-check the letter we sent to you." + +After is verified, as with other verifications, they can see it in their account settings. + +image:authorizations_code_postal_letter_verified.png[Verified by code by postal letter] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/authorizations/identity_documents.adoc b/docs/de/modules/admin/pages/participants/authorizations/identity_documents.adoc new file mode 100644 index 0000000000..bff9992031 --- /dev/null +++ b/docs/de/modules/admin/pages/participants/authorizations/identity_documents.adoc @@ -0,0 +1,141 @@ += Identity documents authorization + +This authorization allows a participant to upload its identity documents. These documents depend on the organization, +they could be a driver's license, a passport, a national identity card, a club membership card, etc. + +These documents will be reviewed by an administrator to accept or reject them. It's possible to do this process in two ways: Online or Offline. + +* Online: the participant will be asked to upload the documents, and the administrator will review these documents. +* Offline: the participant will be asked to fill in some data, and then they will need to go to a presential place to show their documents face to face. + +== Configuration + +By clicking on the btn:[Config] button in this section, an administrator can configure the settings for this authorization. + +image:authorizations_id_document_configuration.png[ID document authorization configuration] + +NOTE: As you can see, this authorization is based in the original implementers reality, in this case in the Spanish identities document types. +For instance, we're giving as options for document types "DNI, NIE or Passport" or we're asking for "Document number (with letter)" +You can change this by xref:customize:code.adoc[code customizing or overriding] these things. We also accept xref:contribute:governance.adoc[Pull Request contributions] +so it's possible to configure this. + + +.ID Documents authorization configuration +|=== +|Field |Type |Description + +|Available methods +|Required +|At least one method must be selected. Options: Online and/or Offline. + +|Instructions for offline verification +|Required (if offline is selected) +|Directions that participants need to follow to verify their documents when offline verification is selected. For instance, +do they need to go to a specific place to show their documents? Is this place open some days of the week? Is it open +for certain hours? +|=== + +== Online + +The process is: + +. Participants fill in their document type and number and upload a copy of their document. +. An administrator fills in the information present in the uploaded image. +. The information should match whatever the user filled in. +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and +the user will be able to fix it. + +=== 1. A participant fill in the document information and uploads a copy of their document + +By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +a participant can see the form for uploading a copy of their document. They also need to fill in their document type and number. + +image:authorizations_id_document_online.png[ID document authorization online form] + +=== 2. An administrator review this document + +After this document is uploaded, an administrator can review it by going to the Identity documents section in the admin +panel. + +image:authorizations_id_document_online_pending.png[ID document authorization pending online verification] + +After clicking on the document, the administrator needs to see the image and fill in the document number. This needs to match +with the one provided by the participant. + +image:authorizations_id_document_online_confirm.png[ID document authorization online confirmation form] + +=== 3. The request is accepted or rejected + +There are two actions an admin can do: + +* Accept: the participant will be fully authorized. +* Reject: the participant will be prompted to amend their documents + +If the request is rejected then the participant can provide other pictures or document. + +image:authorizations_id_document_online_rejected.png[ID document authorization rejected online verification] + +== Offline + +The process is: + +. Participants fill in their document type and number. +. Participants follow the instructions provided to them. For instance, if they need to go to a specific place in a +specific time to show their documents. +. An administrator go to the "Offline verification" panel and fills in the information present in the physical documents. +. The information should match whatever the user filled in. +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and +the user will be able to fix it. + +For this authorization to work, an administrator need to first configure it in the admin panel with the instructions explaining +what the participant need to do to finish the verification process. + +image:authorizations_id_document_configuration_offline.png[ID document authorization configuration: offline instructions] + +=== 1. A participant fill in the document information and follow the instructions + +By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +a participant can see the form for filling in their document type and number. + +image:authorizations_id_document_offline_request.png[ID document authorization offline form] + +=== 2. An administrator review this request + +In the admin panel, the administrator can review the request by clicking in the "Offline verification" button. + +image:authorizations_id_document_offline_button.png[ID document authorization offline button in admin] + +Then they will need to fill some data provided by the participant and by reviewing the document physically provided by them. + +image:authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in admin] + + +.ID Documents authorization offline flow +|=== +|Field |Type |Description + +|Participant email +|Required +|Email of the registered participant + +|Type of the document +|Required +|Can be: DNI, NIE or Passport + +|Document number (with letter) +|Required +|Document number of the participant. For instance, "12345678Z" +|=== + +=== 3. The request is accepted or rejected + +In the cases where the verifications don't match (meaning that the email or the document number provided by the +participant and the ones filled by the administrators aren't the same), then the participant needs to amend it with their +user account. + +== Both + +It's also possible to enable both of these verifications methods. In this case, the participant will be asked to choose +which kind of verification they want to do. + +image:authorizations_id_document_account_choose.png[Choose ID document verification kind] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/groups.adoc b/docs/de/modules/admin/pages/participants/groups.adoc new file mode 100644 index 0000000000..3a40bc859e --- /dev/null +++ b/docs/de/modules/admin/pages/participants/groups.adoc @@ -0,0 +1,116 @@ += User Groups + +An user group is a group of participants. Depending in the installation and the context of the organization it could be disabled. This is enabled or disabled in the administration dashboard, in Settings -> Configuration -> Edit organization -> Enable groups. + +== Creation + +This action is done by **a participant**. They need to go to their profile and in the sidebar there's a button that says "Create group": + +image:user_sidebar.png[User sidebar] + +When clicked it'll open the "New group form": + +image:user_group_new_form.png[New user group form] + + +.New group form +|=== +|Field |Type |Description + +|Name +|Required +|Name of your organization, association, collective, group, etc. + +|Nickname +|Required +|Nickname of your organization, association, collective, group, etc. Do not use spaces nor accents. 20 characters maximum. + +|Email +|Required +|Email of your organization, association, collective, group, etc. + +|Avatar +|Optional +|Guidance for image: Preferably a landscape image that does not have any text. The service crops the image. Maximum file size: 5MB. Allowed file extensions: jpg jpeg gif png bmp ico + +|About +|Optional +|Description of what's this group. + +|Document number +|Optional +|Used for verifications. Do not use dashes nor spaces. + +|Phone +|Optional +|Used for verifications. Do not use dashes nor spaces. +|=== + +== Membership + +After a group has been created, it's possible to invite participants to become members of the group. After a participant has accepted to be part of this group then they can become an admin. + +The actions that can be done by a participant in the user group are: + +* Edit group profile +* Manage members +* Manage admins +* Invite participant +* Leave group + +image:user_group_invite_participant.png[User groups: invite a participant] + +== Group verifications + +image:admin_user_group_verification.png[Admin panel: user group verifications] + +This action is done by **an administrator**. A group can be: +* Pending +* Verified +* Rejected + +This can be done with the buttons at the sidebar: + +image:admin_user_group_verification_actions.png[Admin panel: user group verifications actions] + +When a user group is pending it can be verified or rejected. Once is verified it can be rejected and once is rejected it can be verified. + +If you want to verify multiple user groups at the same time you can do so with the option "Verify via CSV": + +image:admin_user_group_verification_csv.png[Admin panel: user group verifications CSV] + +.... +Upload your CSV file. It must have the official emails of the groups in your organization in the first column of the file, without headers. Only groups that have confirmed their email and that have an email appearing in the CSV file will be validated. +.... + +After a group is verified this is publicly visible in their nickname in the platform and there's a message in its profile: "This group is publicly verified, its name has been verified to correspond with its real name". + +image:user_group_verified.png[User group: verified icon] + +== Actions + +As a verified user group, there's some options that your participant account can do in behalf of the group, such as: + +=== Create a Debate, Proposal or Meeting + +There's a dropdown in the form during the creation process: + +image:user_group_create_debate.png[User group: create a debate] + +=== Make a comment + +There's a dropdown in the form when making a comment: + +image:user_group_make_comment.png[User group: make a comment] + +=== Endorse + +When making an Endorse there's a modal window asking who do you want to make the endorse with: + +image:user_group_endorse.png[User group: endorse] + +=== Conversations + +You can also have Conversations as a group. This is in the group profile page: + +image:user_group_conversation.png[User group: conversations] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/impersonations.adoc b/docs/de/modules/admin/pages/participants/impersonations.adoc new file mode 100644 index 0000000000..05979cfe5f --- /dev/null +++ b/docs/de/modules/admin/pages/participants/impersonations.adoc @@ -0,0 +1,42 @@ += Participants Impersonations + +For participants that don't have the knowledge or don't have an email for registering +an account, there's the Impersonation feature. + +This allows an 'Administrator' or 'Participant manager' to search through a +Verification system for an already existing participant and also to create a +participant without email. + +NOTE: At the code and the User Interface we say both *Impersonation* and *Managed +Participants*. It's the same thing. + +== Panel + +image::participants_impersonations.png[Admin's Impersonations panel] + +This is the panel where you can find all the participants: + +* by filtering by managed or not managed participants +* by searching by name + +After you've clicked in `Manage new participant` you'll go to the form to enter +the personal data to check against the verification: + +image::participants_impersonations_form.png[Admin's Impersonations form] + +NOTE: If you don't see the `Manage new participant` button, is because this feature +only works when you have a Verification of kind `direct` (also known +as `form authorizations`). See in your xref:admin:system.adoc[system panel] which +`Available authorizations` are enabled. You can learn more regarding how to program +your form authorization in https://github.com/decidim/decidim/blob/develop/decidim-verifications/README.md[decidim-verification README]. + +After this data is confirmed then there'll be a session for the participant for +30 minutes: + +image::participants_impersonations_user.png[Impersonated user session] + +Finally, it's also possible to Promote a participant, meaning that after a +participant has been managed, an administrator can add the email and send them +an Invitation: + +image::participants_impersonations_promotion.png[Admin's promotion Impersonations] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/participants.adoc b/docs/de/modules/admin/pages/participants/participants.adoc new file mode 100644 index 0000000000..64e5d2ec77 --- /dev/null +++ b/docs/de/modules/admin/pages/participants/participants.adoc @@ -0,0 +1,90 @@ += Participants + +In this page an administrator can: + +* Block a participant, for instance because they are spamming or acting against the Terms of Service +* Contact a participant with Decidim private messages (Conversations) +* Officialize a participant +* See its email + +image:participants_participants.png[Participants list] + +== Actions + +image:participants_participants_actions.png[Participants actions] + +|=== +|Icon |Name |Definition + +|image:action_block.png[Block user] +|xref:_block_user[Block user] +|To block or moderate a participant. + +|image:action_show_email.png[Show email] +|xref:_show_email_address[Show email address] +|To show an email of a participant. + +|image:action_contact.png[Contact] +|xref:_contact[Contact] +|To contact a participant with Decidim private messages (Conversations) + +|image:action_officialize.png[Officialize] +|xref:_officialize[Officialize] +|To recognize that a participant has a special status in the platform + +|image:action_reofficialize.png[Reoffficialize] +|Reoffficialize +|To change an officialization. See xref:_officialize[Officialize] + +|image:action_unofficialize.png[Unofficialize] +|Unofficialize +|To revoke an officialization. See xref:_officialize[Officialize] +|=== + +=== Block user + +After clicking in this option you'll need to provide a justification why you're +blocking this participant: + +image:participants_block_user_justification.png[Justificate the blocked user action] + +Once a blocked participant tries to log-in they will see an error message: + +image:participants_block_user_alert.png[Message shown to blocked user] + +After a participant was blocked its name is changed to "Blocked user". + +See more at xref:admin:participants/reported_users.adoc[Reported users] + +=== Show email address + +After clicking this option, the admin will see a modal. They will have to click in +button "Show email address". + +image:participants_show_email.png[Modal in show email] +image:participants_showed_email.png[Modal after the email is shown] + +This action will be logged in the Admin actvity log. + +image:participants_showed_email_admin_log.png[Admin activity log for show email] + +=== Contact + +By clicking on this option, it will open the private messaging (Conversation) for +this participant. + +image:participants_conversation.png[Conversation with a participant]. + +=== Officialize + +This option is useful to recognize that a participant has a special status in the +platform. For instance, if someone is the City Mayor, a City Councillor or the +President of an Association in an organization context. + +After Officializing a participant you can: + +- Change the Officialization text with "Reofficialize" +- Revoke the Officialization status with "Unofficialize" + +image:participants_officialize.png[Officialize a participant] +image:participants_participants_actions_officialize.png[Officialize a participant] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/reported_users.adoc b/docs/de/modules/admin/pages/participants/reported_users.adoc new file mode 100644 index 0000000000..855316b7f4 --- /dev/null +++ b/docs/de/modules/admin/pages/participants/reported_users.adoc @@ -0,0 +1,33 @@ += Reported users + +There are cases where participants could go against the Terms of Service of the +platform, so it's useful to have the option for reporting and blocking users. You +can read more about how moderation and reporting contents work in xref:global_moderations.adoc[Global moderations]. + +A participant can be blocked from the xref:participants/participants.adoc[participants +section in the admin panel] or through this "Reported users" section. + +Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant +profile. After a participant has clicked in this action they need to provide a +reason why they are making this report: + +* Contains clickbait, advertising, scams or script bots. +* Contains racism, sexism, slurs, personal attacks, death threats, suicide requests +or any form of hate speech. +* Contains illegal activity, suicide threats, personal information, or something +else you think doesn't belong on Demo. +* Other (and add it) + +image:reported_participant_modal.png[Give reason for reporting a participant modal] +image:reported_participant_flag.png[Flag in sidebar profile] + +After clicking in this option you'll need to provide a justification why you're +blocking this participant: + +image:participants_block_user_justification.png[Justificate the blocked user action] + +Once a blocked participant tries to log-in they will see an error message: + +image:participants_block_user_alert.png[Message shown to blocked user] + +After a participant was blocked its name is changed to "Blocked user". \ No newline at end of file diff --git a/docs/de/modules/admin/pages/participants/verifications_conflicts.adoc b/docs/de/modules/admin/pages/participants/verifications_conflicts.adoc new file mode 100644 index 0000000000..4e6afbfb07 --- /dev/null +++ b/docs/de/modules/admin/pages/participants/verifications_conflicts.adoc @@ -0,0 +1,38 @@ += Verification's conflicts + +There are cases depending on which kind of verifications you've enabled that there could be verification's conflicts. + +For instance: + +. A participant get xref:admin:participants/impersonations.adoc[impersonated], and they don't provide an email +. Then they create an account and try to verify themselves with the Census verification + +For security, we try to be extra cautious in these cases, and we want that an administrator reviews these verifications. +As you can see, this depends a lot on which kind of verifications you've enabled in your organization, so it's easy to say +that most of the time an organization will not see any conflicts in this panel. + +image:verifications_conflicts.png[Verification's conflicts panel] + +== Transfer user + +An administrator can review these conflicts by clicking in the Transfer user image:action_transfer_user.png[Transfer user] icon. + +Then they will see the Transfer user form, where they can provide a reason for the transfer. + +image:verifications_conflicts_transfer_user.png[] + + +.Transfer user form +|=== +|Field |Type |Description + +|Reason +|Required +|Why you want to transfer the user + +|Email +|Required +|The email of the user to transfer +|=== + +After the user is transferred, both accounts (the original and the new one) will be merged. \ No newline at end of file diff --git a/docs/de/modules/admin/pages/scopes.adoc b/docs/de/modules/admin/pages/scopes.adoc new file mode 100644 index 0000000000..afb5b0fb6b --- /dev/null +++ b/docs/de/modules/admin/pages/scopes.adoc @@ -0,0 +1,105 @@ += Scopes + +Scopes are the set of territories or subjects that an Organization has. A scope may have child scopes. + +For instance, in the case of the city of Barcelona the scopes are its districts, and the children of a district are its neighborhoods. They can also have types, so it can be configured, for example, by thematic and also territorial scopes. + +Most of the components and spaces in Decidim allow you to configure Scopes in one way or another. There are mainly three ways of using Scopes: + +To configure Scope on the Decidim platform, go to menu:Settings[Scopes] in the admin sidebar menu. A list will appear with the existing scopes if there are any: + +image:scopes_list.png[Scopes list] + +If you need so, you need to first configure the Scope type. + +== Form + +image:scopes_types_new_form.png[New scope type form] + + +.Admin New Scope Type form +|=== +|Field |Type |Description + +|Singular +|Required +|Name of the scope type in singular. + +|Plural +|Required +|Name of the scope type in plural. +|=== + +image:scopes_new_form.png[New scope form] + + +.Admin New Scope Form +|=== +|Field |Type |Description + +|Name +|Required +|Name of the scope. + +|Code +|Required +|(Internal) name of the scope. + +|Scope type +|Required +|Which type of scope it's. +|=== + +== Actions + +You have 3 possible actions in this list after a Scope is created: + +|=== +|Icon |Name |Definition + +|image:action_browse.png[Browse icon] +|Browse +|See and configure the children scopes for this Scope. + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for a Scope. It's the same form as "Create a new scope". + +|image:action_delete.png[Delete icon] +|Delete +|To delete this scope. +|=== + +== Funktionen + +The main features related with scopes are: + +. Filtering +. User interests and Newsletters + +=== Filtering + +For filtering. Most of the spaces and components allows an administrator or a participant to associate them to a scope. This allows to filter by scopes when exploring them. + +image:scopes_filter_initiatives.png[Initiatives scopes filtering] + +image:scopes_filter_processes.png[Processes scopes filtering] + +Some examples: + +* With Accountability module, so it's possible to filter Results +* Assemblies and Processes can have Scopes. It's used for filtering multiple assemblies in the main listing page (/assemblies or /processes). These can be hidden by unchecking the "Enable participatory space filters" in the xref:admin:configuration.adoc[admin's configuration page]. +* Filtering in the sidebar is possible in Budgets Projects, Initiatives and Proposals. In some of these components you can control if these filters are shown with the "Scopes enabled" checkbox in the component settings. This will also enable or disable the scope selector in the resource creation form. + +You can also configure a participatory space so the filtering will only concern one scope and its children scopes. For example, let's imagine your organization have 3 different scopes for 3 cities, each of them having children scopes for the cities neighbourhoods. +On a participatory space which concerns only one of the cities, you will be able to select only this scope and its children so that users do not see the scopes of other cities in the filter options. + +=== User interests and Newsletters + +A Participant can choose which Scopes they want to follow in its account. + +image:account_my_interests.png[Account: my interests] + +This is used by the xref:admin:newsletters.adoc[Newsletters], in the "Select recipients to deliver" step, "Filter for users having activated any selected scope in their account's My Interests settings." section. + +image:newsletter_select_recipients.png[Newsletter: select recipients] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/spaces/assemblies/members.adoc b/docs/de/modules/admin/pages/spaces/assemblies/members.adoc new file mode 100644 index 0000000000..6668e828db --- /dev/null +++ b/docs/de/modules/admin/pages/spaces/assemblies/members.adoc @@ -0,0 +1,72 @@ += Assembly members + +Assembly members allow showing all the people or groups that belong to a given assembly. It's useful for being transparent. + +You can see an example in https://meta.decidim.org/assemblies/coordination-committee/members[Decidim Coordination Commitee Assembly in Metadecidim]. + +image:assembly_members.png[Assembly members of the Coordination Committee] + +== New assembly member form + +image:assembly_members_list.png[Assembly members admin list] + +For creating a new phase of a participatory process: + +. 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 + +image:assembly_members_new_form.png[Assembly members new form] + + +.New assembly member form +|=== +|Field |Type |Description + +|Participant type +|Required +|Wheter this assembly member is non-participant or existing participant. Do they already have an account created on the platform? + +|Full name +|Required if it's non-participant. +| + +|User or group +|Required if it's an existing participant. +|Type at least three characters to search. + +|Position +|Required +|Choose one of President, Vice president, Secretary, or Other. In case it's other, you can fill in the position title. + +|Weight +|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. + +|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. + +|Ceased date +|Optional +|When was this person or group ceased to be a member of this assembly. Expected format: dd/mm/yyyy + +|Gender +|Optional +|Which gender does this person most identify with. + +|Birthday +|Optional +|When was this person born. Expected format: dd/mm/yyyy + +|Birthplace +|Optional +|Where was this person born. +|=== \ No newline at end of file diff --git a/docs/de/modules/admin/pages/spaces/conferences/registrations/invites.adoc b/docs/de/modules/admin/pages/spaces/conferences/registrations/invites.adoc new file mode 100644 index 0000000000..4ffe30d645 --- /dev/null +++ b/docs/de/modules/admin/pages/spaces/conferences/registrations/invites.adoc @@ -0,0 +1,38 @@ += Invites + +Administrators can invite participants to join the conference. + +image:spaces/conferences/invites.png[Conferences user invites (backend)] + +== Flow + +. An administrator sends an invitation to join the conference to a non-existing or existing participant +. The participant accepts the invitation + +image:spaces/conferences/invite_participant_form.png[Invite a participant form] + + +.Invite participant form +|=== +|Field |Type |Description + +|Attendee type +|Required +|Wheter this invited person is a non-existing or existing participant. Do they already have an account created on the platform? + +|Name +|Required if it's a non-existing participant. +|Name of the invited person. + +|Email +|Required if it's a non-existing participant. +|Email of the invited person. + +|User +|Required if it's an existing participant. +|Type at least three characters to search. + +|xref:admin:spaces/conferences/registrations/types.adoc[Registration type] +|Required +|What xref:admin:spaces/conferences/registrations/types.adoc[registration type] does this participant will have. +|=== \ No newline at end of file diff --git a/docs/de/modules/admin/pages/spaces/conferences/registrations/types.adoc b/docs/de/modules/admin/pages/spaces/conferences/registrations/types.adoc new file mode 100644 index 0000000000..e1756b8391 --- /dev/null +++ b/docs/de/modules/admin/pages/spaces/conferences/registrations/types.adoc @@ -0,0 +1,56 @@ += Registration types + +You can enable registrations in conferences, so it's easier to register to the whole conference, or by days, rather than +going meeting by meeting to enable registration for that particular event. + +After enabling registrations participants will have a button to register to the conference in the landing and the conference's header. + +image:spaces/conferences/registration_landing01.png[Registration button on landing page] + +image:spaces/conferences/registration_landing02.png[Registration button on landing page] + +If you want to enable registration you'll need to define and publish at least one registration type. + +image:spaces/conferences/registration_types_frontend_wo_user.png[Select registration type without a user account] + +== Create a new registration type + +For adding a new registration type, you need to: + +. Sign in as administrator +. Go to the conferences section in the sidebar +. Click on the conference Edit action +. Click on the "Registration types" link in the sidebar +. Click on the "New Registration type" button +. Fill the form +. Publish the registration type + +image:spaces/conferences/new_registration_type.png[Create a new registration type form] + +image:spaces/conferences/registration_types_backend.png[Manage registration types] + + +.Create a new registration type +|=== +|Field |Type |Description + +|Title +|Required +|What is the title of this registration type. + +|Weight +|Which order will it have in relation to the other types. Having a lower number means a higher priority. For instance, if you have two types, "Day 1" with weight "10" and "Day 2" with weight "0", then "Day 2" will be first when ordering. +|Description + +|Required +|Description for this registration type +|Price + +|Optional +|Define a price for this registration type. If you don't define a price, the price will be "Free". +|Select conference meetings +|=== + +If the participant is already logged in then they will see their username and email in the registration page. + +image:spaces/conferences/registration_types_frontend_w_user.png[Select registration type with user account] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/spaces/conferences/registrations/users.adoc b/docs/de/modules/admin/pages/spaces/conferences/registrations/users.adoc new file mode 100644 index 0000000000..24e2468fc2 --- /dev/null +++ b/docs/de/modules/admin/pages/spaces/conferences/registrations/users.adoc @@ -0,0 +1,27 @@ += User registrations + +After participants have registered, they will appear in this section. + +image:spaces/conferences/user_registrations.png[Conferences user registrations (backend)] + +As an administrator, you can: + +* Export the registrations +* Confirm a registration + +== Export + +It's possible to export the registrations in multiple formats: CSV, JSON, and XLSX (Excel). + +== Flow + +. A participant registers to the conference +. They receive a pending registration notification +image:spaces/conferences/user_registration_pending_notification.png[Notification for pending user registration] +. They receive a pending registration email +image:spaces/conferences/user_registration_pending_email.png[Email for pending user registration] +. An administrator reviews and confirms the registration with the image:action_check.png[Confirm] button +. The participant receives a confirmed registration notification +image:spaces/conferences/user_registration_confirmed_notification.png[Notification for confirmed user registration] +. They receive a confirmed registration email with an calendar file (.ICS). +image:spaces/conferences/user_registration_confirmed_email.png[Email for confirmed user registration] \ No newline at end of file diff --git a/docs/de/modules/admin/pages/spaces/conferences/speakers.adoc b/docs/de/modules/admin/pages/spaces/conferences/speakers.adoc new file mode 100644 index 0000000000..339f5a7256 --- /dev/null +++ b/docs/de/modules/admin/pages/spaces/conferences/speakers.adoc @@ -0,0 +1,68 @@ += Speakers + +The speakers are people that are going to talk at the conference. + +image:spaces/conferences/speakers_frontend.png[Conferences speakers (frontend)] + +== Create a new speaker + +image:spaces/conferences/speakers.png[Conferences speakers] + +For creating a new speaker of a conference: + +. Sign in as administrator +. Go to the conferences section in the sidebar +. Click on the conference Edit action +. Click on the Speakers link in the sidebar +. Click on the "New Conference Speaker" button +. Fill the form + +image:spaces/conferences/new_speaker.png[Conferences speakers] + + +.New conference speaker form +|=== +|Field |Type |Description + +|Participant type +|Required +|Wheter this speaker is a non-participant or existing participant. Do they already have an account created on the platform? + +|Full name +|Required if it's non-participant. +|Name of the speaker. + +|User or group +|Required if it's an existing participant. +|Type at least three characters to search. + +|Related meetings +|Optional +|Which meetings does this speaker attend and participates actively? + +|Position +|Required +|Metadata for showing extra information about the speaker. + +|Affiliation +|Required +|Metadata for showing extra information about the speaker. + +|Short Bio +|Optional +|Metadata for showing extra information about the speaker. + +|Twitter handle +|Optional +|Metadata for showing extra information about the speaker. + +|Personal URL +|Optional +|Metadata for showing extra information about the speaker. + +|Avatar +|Optional +|Metadata for showing extra information about the speaker. + +Default image +|=== \ No newline at end of file diff --git a/docs/de/modules/admin/pages/spaces/initiatives.adoc b/docs/de/modules/admin/pages/spaces/initiatives.adoc new file mode 100644 index 0000000000..f9dec1da31 --- /dev/null +++ b/docs/de/modules/admin/pages/spaces/initiatives.adoc @@ -0,0 +1,408 @@ += Initiatives + +An initiative is a special type of participatory process that can be promoted by anyone (independently of other channels or participation spaces) through the collection of (online and in-person) signatures for the organization to carry out a specific action (modify a regulation, initiate a project, change the name of a department or a street, etc.). + +The promoters of an initiative can define its objectives, gather support, debate, disseminate it and define meeting points where signatures can be collected from the attendees or debates open to other participants. + +Examples: An initiative can collect signatures to call for a consultation among all the people of an organization, or to create an assembly, or to call for a process of budget increase for a territory or area of the organization. During the process of collecting signatures, more people can add to this demand and carry it forward in the organization. + +Initiatives are to be distinguished from the other participation spaces because they can be used as a participatory tool or mechanism promoted by participants. In other words, the initiatives are mechanisms for semi-direct democracy through which participants can promote a certain action of common interest to the organization, by collecting a specific number of signatures. In this case, what the organization has to do is enable the promotion of these initiatives and offer the necessary technical support and advice to the people concerned. The role of the platform’s administrator, then, is somewhat different from that of the other participation spaces. + +In the first place, you will have to configure the various forms of initiatives. This could be specified in a regulation (like a municipal normative or state law), specifying the number of signatures required for processing the various types of initiatives. For example, an initiative for incorporating one or several items into the Municipal Council’s agenda evidently requires fewer signatures than another initiative for promoting a binding consultation. + +== 0. Initiative setup + +How initiatives work depends on two things: how the initiative module is configured through the xref:admin:initiatives_initializer.adoc[initializer] (in code) and how the initiative type is configured in the administration panel. + +Regarding initiatives type, **an administrator** needs to define one. For Initiatives to work on an organization there must be at least one initiative type created and configured with at least one initiative type scope. If there's only one type then the participant will not get the possibility to choose the initiative type, this step will be skipped in the initiative creation wizard. + +Some real examples from the city of Barcelona are: + +* To add an item to the Municipal Council or Districts agendas +* To perform a participatory process +* To create a new assembly +* To approve or modify a regulation +* To request the holding of a citizen consultation +* To call for assemblies (neighborhood councils or public audiences) + +=== New initiative type form + +image:admin_initiative_type.png[New initiative type form] + + +.Admin new initiative type form: General information +|=== +|Field |Type |Description + +|Title +|Required +|Title of the initiative type. For instance, "New park at city center". + +|Description +|Required +|Explanation of what can be done with this initiative type. + +|Banner image +|Required +|An image for this initiative type. NOTE: At the moment this is not used. +|=== + + +.Admin new initiative type form: Options +|=== +|Field |Type |Description + +|Signature type +|Optional +|Which kind of signature type will be allowed. Options are: Online, In-person and Mixed. The Mixed option allows a participant to choose which signature type will have the initiative. + +|Enable attachments +|Optional +|Whether it'll allow to upload attachments to initiatives. + +|Enable participants to undo their online signatures +|Optional +|Can a participant undo its signature when they already signed? + +|Enable authors to choose the end of the signature collection period +|Optional +|Can the authors of an initiative change the end of the signature collection period? + +|Enable authors to choose the area for their initiative +|Optional +|Can the authors choose the area of their initiative? + +|Enable child scope signatures +|Optional +|This config flag doesn't support offline votes, it enables sub-scopes and works with an authorization handler that associates a scope to the user, make sure you select that authorization, bellow in authorization settings. For it to work, scopes need to be configured in a hierarchical way : 1 Parent - N Child. + +|Only allow global scope initiatives creation +|Optional +|Tick this flag if you enabled "Child scope signature" and configured the global scope as your parent scope. By enabling this, scope selection will be skipped in the initiative creation wizard. + +|Enable promoting committee +|Optional +|Whether it will only allow individual initiatives (made by only one person) or allow collective initiatives (multiple promoters, being multiple individuals or a user group). + +|Minimum of committee members +|Optional +|When "Enable promoting committee" option is checked, defines the minimum number of promoter's committee member to send the initiative to technical validation + +|Collect participant personal data on signature +|Optional +|Adds a step to the signature process. When a participant clicks on the signature button, they will be redirected to a form asking for some personal data. This will be used with the PDF export action after the recollection period has ended. + +|Legal information about the collection of personal data +|Depends on whether the option "Collect participant personal data on the signature" is checked +|Privacy notice and terms of use for the participant personal data during the signature process. +|=== + + +.Admin new initiative type form: Authorization settings +|=== +|Field |Type |Description + +|Authorization to verify document number on signatures +|Optional +|When a participant is making the signature process, will they be asked for an authorization? + +|Add SMS code validation step to the signature process +| +|During the signature process, will it ask for SMS validation? See xref:services:sms.adoc[configuration of SMS service]. +|=== + +=== New initiative type scope form + +An initiative type can also have scopes associated. For Initiatives it needs at least one scope configured. + +image:admin_initiative_type_scope.png[New initiative type form] + + +.Admin new initiative type scope form +|=== +|Field |Type |Description + +|Scopes +|Required +|A Scope. An author can choose this scope in the creation of the initiative. + +|Signatures required +|Required +|Number of signatures the initiative need to have before the end period so it can be accepted. +|=== + +== 1. Create an initiative + +This action is done by **the author**. The author is a participant that creates the initiative. Depending on how the initiatives module is configured in the initializer or how the initiative type is configured, it may need to ask for authorization, or it will even not show the "New initiative" button. + +image:initiative_list.png[Initiatives list] + +For creating an initiative, a participant must click in the "New initiative" button. Then they will have a wizard with multiple steps: + +=== 1.1 Choose the initiative type + +image:initiative_new_step1.png[Initiative creation: step 1] + +=== 1.2 Add title and description + +image:initiative_new_step2.png[Initiative creation: step 2] + +=== 1.3 [Optional] Similarity comparison + +Checks the rest of the initiatives if there are other similar initiatives. If there are, the system will show them before continuing. This is a way to avoid duplicates. + +=== 1.4 Finish + +image:initiative_new_step3.png[Initiative creation: step 3] + +image:initiative_new_step4.png[Initiative creation: step 4] + +=== Actions after it was created + +After the initiative was created, a participant can see the initiative page, but until the initiative is reviewed and accepted by an administrator, through the technical validation, it will not be published and visible for all the participants. + +image:initiative_show.png[Initiative show] + +In the sidebar a participant can make some actions: Edit, Print and Send to technical validation. + +image:initiative_actions.png[Initiative actions] + +==== Edit + +After the initiative was created and before it was sent to technical validation, **an author** can edit and correct the initiative if it has any error. + +image:initiative_edit.png[Initiative edit] + +==== Print + +An author can also print the initiative. + +image:initiative_print.png[Print an initiative] + +==== Technical validation + +After the author has reviewed how the initiative will look, they can send it to technical validation. + +image:initiative_send_to_technical_validation.png[Send initiative to technical validation] + +== 2. Send initiative to technical validation + +This action is done by **the author**. + +After it has been reviewed by the author, it can be sent to "Technical validation", but it depends in the configuration of the initiative type, in whether the options "Enable promoting committee" and "Minimum of committee members" are configured. + +=== Promoter's committee + +An initiative type can optionally be supported by a promoter's committee, with a minimum number of committee members. Once the user has created the initiative and before it can be sent for technical validation they need to invite committee members to promote it. + +When the user has created the initiative they will be given a link to share with possible committee members, which will look something like `/initiatives/.../committee_requests/new` + +When a prospective committee member opens the link, they can click a button which allows them to request to be part of the committee. The initiative author then needs to approve each request. The author can approve them by clicking on the "Edit" button of their initiative at the bottom of the form they can approve or reject committee members. + +image:initiative_commitee_members_send_to_technical_false.png[Initiative promotor committee: edit screen] + +The initiative cannot be sent to technical validation until it meets the minimum number of committee members required. You can find the invitation link in the edit form. + +image:initiative_edit_commitee_members.png[Initiative promotor committee: edit screen] + +Share the invitation link with the people you'd like to have on your committee. + +image:initiative_commitee_members_ask.png[Initiative promotor committee: edit screen] + +The people invited with the link will be able to read the initiative and ask to be part of the committee. + +image:initiative_commitee_members_sent.png[Initiative promotor committee: edit screen] + +The request is sent and the author can then and accept or refuse it in the initiative edit form. + +image:initiative_commitee_members_approve.png[Initiative promotor committee: edit screen] + +image:initiative_commitee_members_send_to_technical_true.png[Initiative promotor committee: edit screen] + +Once enough people have joined the promoter committee the initiative author can send it for +technical validation. + +== 3. Publish an initiative + +This action is done by **an administrator**. + +After the initiative was sent to technical validation by a participant, an administrator can view all the initiatives in the admin panel and make some corrections. + +image:initiative_admin_list.png[Admin initiatives list] + +=== Actions + +Regarding the actions in an initiative, an administrator can "Preview", "Edit", "Answer" or "Print" an initiative: + +image:initiative_admin_list_actions.png[Initiative admin list actions] + +|=== +|Icon |Name |Definition + +|image:action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for Initiative. + +|image:action_answer.png[Answer icon] +|Answer +|Allows to answer an Initiative. + +|image:action_print.png[Print icon] +|Print +|Allows to print. +|=== + +=== Components + +Once an initiative has been created it gets the Meetings and Page component enabled by +default. The initiative author has no control over these - an admin will need to manage +them. All of the other usual components may be added by an admin too. + +image:initiative_admin_show.png[Admin initiative show page] + +There are also other features inside initiatives, like Attachments and Moderations for the comments. + +image:initiative_admin_sidebar.png[Admin initiative sidebar] + +=== Publish + +After the initiative was reviewed and technically approved by an admin, for instance for checking that what the initiative is asking is legal or abides to the normative (ie it's municipal competency), then it can be published: + +image:initiative_admin_actions.png[Admin initiative actions] + +== 4. Sign an initiative + +This action is done by **a participant**. + +After the initiative was published, it'll be visible in the initiatives listing page (/initiatives): + +image:initiative_list_published.png[Initiative list after it was published] + +image:initiative_admin_show_published.png[Admin initiative show after it was published] +image:initiative_show_published.png[Initiative show after it was published] + +And authorized participants can sign it: + +image:initiative_admin_show_published_detail.png[Admin initiative show after it was published (detail)] + +image:initiative_show_signed.png[Initiative show after it was signed] + +== 5. Export signatures + +This action is done by **an administrator**. After the initiative has started to get signatures, there's an option for exporting a PDF of the signatures: + +image:initiative_actions_export.png[Initiative actions with Export to PDF] + +image:initiative_actions_export_pdf.png[Initiative exported PDF] + +== 6. Answer an initiative + +After the initiative has collected all the signatures then it can be answered by an administrator. An initiative answer don't have different types. + +image:initiative_backend_answer.png[Initiative backend answer] + +image:initiative_frontend_answer.png[Initiative frontend answer] + +== Initiative statuses + +For better understanding all the status, this is a summary: + +|=== +|Status |Explanation + +|Created +|The initiative has been created but is not yet public for every visitor or the rest of the participants. + +|Technical validation +|The initiative needs to be reviewed by an administrator. From here, it can be "discarded" or "published" + +|Expired +|The initiative wasn't reviewed by an administrator and wasn't approved, and the maximum time for validation has passed. + +|Discarded +|The initiative was reviewed by an administrator and was discarded, so it's not published. + +|Published +|The initiative was reviewed by an administrator and was approved, so it's published. + +|Rejected +|The period for signature recollection has ended and there weren't enough signatures. + +|Accepted +|The period for signature recollection has ended and there were enough signatures. +|=== + +[plantuml] +@startuml +:Created; +:Technical validation; +if (has passed the maximum validation time?) then (yes) + #pink:Expired; + kill; +elseif (validated?) then (no) + #pink:Discarded; + kill; +else (yes) + #palegreen:Published; + if (enough signatures?) then (no) + #pink:Rejected + (not enough signatures); + kill; + else (yes) + #palegreen:Accepted + (enough signatures); + stop; + endif; +endif +@enduml + +Finally, these are all the relevant settings in every moment in the initiatives life cicle: + +[plantuml] +@startuml +(*) --> "Create a new initiative" +if "Has only one type?" then +--> [Yes] "Fill initiative form" +else +--> [No] "Select initiative type" +--> "Fill initiative form" +Endif +partition Created { + if "Is the User a UserGroup?" then + --> [Yes] "Send to Technical Validation" + else + --> [No] Collect the minimum number of committee members (2 by default) + --> "Send to Technical Validation" + Endif +} +partition Validating { + if "Has passed the maximum time for validation (60 days by default)?" then + --> [Yes] "Expired" + else + --> [No] if "Is accepted by an administrator?" then + --> [No] "Discarded" + else + --> [Yes] "Publish" + endIf + endIf +} +partition Published { + --> "Signature process" + if "Has passed the configured time window for validation (60 days by default)?" + --> [Yes] "Expired" + else + --> [No] Export PDF to signatures + --> Check signatures with offline signatures for duplicates (if the Initiative has them) + --> if "Has the initiative get the number of signatures required?" then + --> [No] Rejected + else + --> [Yes] Accepted + endIf + endIf +} +--> (*) +@enduml \ No newline at end of file diff --git a/docs/de/modules/admin/pages/spaces/processes/types.adoc b/docs/de/modules/admin/pages/spaces/processes/types.adoc new file mode 100644 index 0000000000..2e1c452b2b --- /dev/null +++ b/docs/de/modules/admin/pages/spaces/processes/types.adoc @@ -0,0 +1,39 @@ += 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. + +Process Types work similarly to xref:admin:spaces/assemblies.adoc#_assemblies_types[Assembly types]. + +== New process type form + +For creating a new process type: + +. 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 + +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"] + + +.New participatory process type form: General information +|=== +|Field |Type |Description + +|Title +|Required +|Title of the participatory process type. For instance, "Consultative". +|=== + +== 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. + +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"] + +== Process type filter + +In the front-end if there is at least one Process Type defined, a filter shows, allowing filtering of Processes. + +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"] \ No newline at end of file diff --git a/docs/de/modules/admin/partials/page_admins.adoc b/docs/de/modules/admin/partials/page_admins.adoc new file mode 100644 index 0000000000..db05cf9da8 --- /dev/null +++ b/docs/de/modules/admin/partials/page_admins.adoc @@ -0,0 +1,67 @@ += Space Admins + +You can give permissions to users with special rights in a space, +so they can only have access to some of the administration pages in this space. +These roles are administrators, moderators, collaborators, or valuators. + +* Administrators: they can administer the space and change the space settings. +* Collaborators: they can see the space and its components before it's published and view the space settings. +They can't change anything. +* Moderators: they can see the reported contents of the space and hide or unhide them. +* Valuators: they can evaluate proposals. Used by participatory budgeting processes. + +To invite them, in the space's submenu, go to *Space admins* and click on *New space admin*. This depends in the kind of space +that you're, for instance for participatory processes it'd be *Process admins* and *New process admin*. + +== New space admin form + +image:spaces/admins_form.png[New space admin form] + + +.New space admin form +|=== +|Field |Type |Description + +|Name +|Required +|What is the name of the new admin. + +|Email +|Required +|What is the email of the new admin, so they can receive the invitation. + +|Role +|Required +|Which role does this admin will have in the participatory process? Can be any of Administrator, Collaborator, Moderator, or Valuator. +|=== + +== Roles + +=== Administrators + +A space administrator can administer the space and change the space settings. It can also invite new space administrators. + +image:spaces/admins_role_admin01.png[Process administrators view 01] + +image:spaces/admins_role_admin02.png[Process administrators view 02] + +=== Collaborators + +A space collaborator can only see the space before it's published. + +image:spaces/admins_role_collaborator.png[Process collaborators view] + +=== Moderators + +A space moderator can review the reported contents of the space and hide or unhide them. + +image:spaces/admins_role_moderator.png[Process moderators view] + +=== Process valuators + +A space valuator can review the proposals of the space. They can: + +* change the status of the proposals, by accepting or rejecting them +* add a monetary value to the proposals, so they can be voted with the budget component. + +image:spaces/admins_role_valuator.png[Process valuators view] \ No newline at end of file diff --git a/docs/de/modules/admin/partials/page_private_participants.adoc b/docs/de/modules/admin/partials/page_private_participants.adoc new file mode 100644 index 0000000000..f5d5983d88 --- /dev/null +++ b/docs/de/modules/admin/partials/page_private_participants.adoc @@ -0,0 +1,75 @@ += Private participants + +There are cases where you want to have a closed census of the participants in a space. For instance this could be a space +for a small group of people, or the members of a comission inside of a big organization. For these cases you can +use the private participants feature. + +image:spaces/private_participants.png[Private participants list] + +For inviting private participants of a space: + +. Sign in as administrator +. Go to the space's section in the sidebar +. Click on the space Edit action +. Click on the "Private participants" link in the sidebar +. Click on the "New participatory space private user" or "Import via CSV" buttons + +== New participatory space private user + +image:spaces/private_participants_new_form.png[New private participant form] + + +.New participatory space private user form +|=== +|Field |Type |Description + +|Name +|Required +|What is the name of the new participant. + +|Email +|Required +|What is the email of the new participant. +|=== + +== Import via CSV + +image:spaces/private_participants_csv_import.png[Import private participants via CSV] + +This form allows you to bulk import the participants of a space. + +It must have two columns with email in the first column of the file and the name in the last column of the file (email, name) +of the users that you want to add to the participatory space. Some tips: + +* The file should not have headers. That means that you do not have to add a column that says "email, name" +* You must avoid using invalid chars like `<>?%&^*#@()[]=+:;"{}\|` in user name. +* The separator between columns must be a comma (",") + +== Actions + +After the participants has been invited, you can resend or delete the invitation. + +image:spaces/private_participants_actions.png[Private participants actions] + +|=== +|Icon |Name |Definition + +|image:action_resend_invitation.png[Resend invitation] +|Resend invitation +|If the invitation wasn't accepted, send it again to the user + +|image:action_delete.png[Delete invitation] +|Delete invitation +|Revoke the invitation sent to the user +|=== + +== Invitation + +When a participant was invited they will get an email with a link for accepting the invitation: + +image:spaces/private_participants_email_invite.png[Email invitation of a private participant] + +After clicking in this email, they will have to fill a form for setting their password, accepting the Terms of Service and giving +their consent if they want to receive newsletters. + +image:spaces/private_participants_user_registration_form.png[User registration form of a private participant] \ No newline at end of file diff --git a/docs/de/modules/features/pages/general-description.adoc b/docs/de/modules/features/pages/general-description.adoc new file mode 100644 index 0000000000..e34d230c73 --- /dev/null +++ b/docs/de/modules/features/pages/general-description.adoc @@ -0,0 +1,63 @@ += General description and introduction to how Decidim works +:page-partial: + +http://decidim.org[Decidim], from the Catalan for "let's decide", is a digital infrastructure for participatory democracy, built entirely and collaboratively as free software. More specifically, Decidim is a web environment (a _framework_) produced in _Ruby on Rails_ that allows users to create and configure a website platform or portal, to be used in the form of a social network, for democratic participation. The portal allows any organization (local city council, association, university, NGO,trade union, neighborhood or cooperative) to create massive democratic processes for strategic planning, participatory budgeting, collaborative regulatory design, urban spaces design and elections. It also enables the organization of in-person meetings, signing up for them, the publication of minutes, proposing points for the agenda and receiving notifications of the results. Decidim can also help organizing governing bodies, councils or assemblies, the convening of consultations and referendums or channeling citizen or member initiatives to impact different decision making processes. All together Decidim makes possible to digitally structure a complete system of participatory democratic governance for any organization. + +To understand in detail how Decidim operates, a distinction must be made between participatory _spaces_ and _components_ (see <>). + +[#functional-architecture-fig] +._Summary diagram of Decidim's functional architecture showing a combination of components in participatory spaces. The "Vote*" component allows a variety of voting systems, expressions of support or allegiance for a proposal._ +image::functional-architecture-en.svg[width=2000] + +* *Participatory spaces.* These are the frameworks that define how participation will be carried out, the _channels_ or means through which citizens or members of an organization can process requests or coordinate proposals and make decisions. _Initiatives_, _Processes_, _Assemblies_ and _Consultations are all participatory spaces. Specific examples of each of these include: a citizen initiative for directly changing a regulation (_Initiative_); a general assembly or workers’ council (_Assembly_); a participatory budgeting, strategic planning, or electoral process (_Processes_); a referendum or a call to vote “Yes” or “No” to change the name of an organization (_Consultation_). +* *Participatory components.* These are the participatory _mechanisms_ that allow a series of operations and interactions between the platform users within each of the participatory spaces. The following are participatory components: _comments, proposals, amendments, votes, results, debates, surveys, sortitions, pages, blogs, newsletters_ and _meetings_. Other components that build on top of basic components are: _participatory texts_, _accountability_ and _conferences_. + +[#spaces-components-fig] +._Decidim displays participatory spaces on the top menu (dark) and components are displayed on the bottom menu (white)._ +image::spaces-components.png[] + +The ways in which spaces and components interact is the following. Users of the platform (participants) interact through participatory mechanisms known as components which afford a variety of features for the various participatory _spaces_. In other words, participatory _spaces_ such as _Initiatives_, _Assemblies_, _Processes_ and _Consultations_ have components at their disposal which work together as participatory mechanisms. The more notable components include in-person _meetings_, _surveys_, _proposals_, _debates_, _results_ and _comments_. So, for example, the various phases of a participatory budgeting process can combine components in the following way: at an early phase public meetings can be opened for citizens to analyze different needs classified by districts. In turn these meetings can lead to the design of a survey. The survey results can then be used to define a set of categories for projects to be proposed. The proposal component can then be activated for participants to create and publish their projects as solutions to the identified needs. These proposals can then be commented and, after two weeks of deliberation, voting can be activated to select among the projects with a budget-expenditure system. Participants can then be called to a public meeting to evaluate the results, and an assessment survey can be launched afterwards for those who could not attend the meeting. Finally, the accountability component may be activated to monitor the degree of execution of the selected projects, and people can comment on it. What makes Decidim particularly powerful is this combination of components within spaces, which provides an organization with a complete toolkit to easily design and deploy a democratic system and adapt it to the organization's needs. + +Decidim's top navigation bar displays the different types of active *spaces* of the platform. *Processes* is a space that allows to create, activate/deactivate, and manage various participatory processes. These are distinguished from other spaces by being structured in different phases within which all of the components can be incorporated. Examples of participatory processes are: an election process for members of a committee, participatory budgeting, a strategic planning process, the collaborative writing of a regulation or norm, the design of an urban space or the production of a public policy plan. *Assemblies* is a space that offers the possibility of setting decision-making bodies or groups (councils, working groups, committees, etc.) that meet up periodically, detailing their composition, listing and geolocating their meetings, and allowing to take part in them (for instance: attending if the seating capacity and nature of the assembly so permits, adding items to the agenda, or commenting on the proposals and decisions taken by that body). *Consultations* is a space that makes it possible to coordinate referendums, trigger discussions and debates, get voting results published; it can be connected to a secure e-voting system. *Initiatives* is a space that allows participants to collaboratively create initiatives, define their trajectory and goals, gather endorsements, discuss, debate and disseminate initiatives and define meeting points where signatures can be collected from attendees or debates opened to other members of the organization. Initiatives is a special kind of space by which members of the organization can trigger actions that are generally restricted to elected bodies or platform administrators, by collecting (digital) signatures. The organization can define the types of initiatives and set up the number of signatures that are required to trigger the expected result (e.g. to call for a consultation). + +The *components* (also called features) are displayed as a second level menu with white background within spaces (as displayed in <>). The *collaborative draft* for proposals facilitates the collaborative creation of proposals as well as the monitoring and control of changes throughout the process. The *proposals* component allows a user to create a proposal using a creation wizard, compare it with existing ones, publish it in the platform and include additional information like geolocation or attached documents and images. This component also makes possible to navigate, filter and interact with a set of proposals. The proposal component has plenty of configuration options, and different features can be activated or de-activated in time. One such feature is *voting* or *support*: it offers organizations the possibility of activating different voting or support systems around proposals: unlimited, limited to a given threshold, weighted, cost-based, etc. Proposals can also be imported to a new phase, so they can be re-written or elaborated in different stages, where they can also be subject to *amends* which can be voted separately, accepted and merged or rejected, to improve proposals democratically. The *results* component is used to turn proposals into results and give official responses concerning their acceptance or rejection, merging various proposals into a single result or creating different results related to the same original proposal. The *accountability* component offers the possibility of subdividing results into projects, defining and applying progress statuses around their implementation, as well as displaying the extent of the results’ implementation grouped by categories and scopes. In this sense the accountability component works like a project management system built into the platform. The *surveys* component can be used to design and publish surveys and to display and download their results. The *sortition* component allows to select a number of proposals (e.g. candidates for a jury) with random, yet reproducible, procedures that guarantees non-biased and uniform distributions. The *comments* component enables users to add comments, to identify the comment as being in favor, against or neutral in relation to the commented object, to vote comments, respond to them and to receive notifications about responses. The *participatory texts* component can be used to convert lengthy text documents into various proposals or results and, vice versa, to compose and display a unified text based on a collection of proposals or results. This makes possible to work with a full document as continuous text in participatory manner. The *pages* component is used to create informative pages with rich text formatting, embedded pictures and videos. The *blog* component makes possible the creation of posts or news, and to navigate them chronologically. The *meeting* component offers organizations and participants the opportunity to convene meetings, determine their location and time, registration and management of attendees, to define the structure and content of the meeting as well as publishing the minutes, and the resulting proposals. The *conference* component allows an organization to create a website for a big event by joining up a series predefined meetings (chats, workshops etc.), putting together a unified program and managing attendees. The *newsletter* component makes possible to send emails to everyone registered in the platform or, more selectively, to those who participate in a specific space. + +Participants can carry on different *types of actions* within the platform: + +[start=0] +. They can *navigate* and search for information +. They can *create* contents of different types (e.g. proposals and debates). +. They can *vote, support or sign* all three modes allow for participants to aggregate their preference or will for a specific consultation question, proposal or initiative respectively (the difference between these three types of actions involve different levels of security and anonymity: signatures can be audited and attributed to a participant, supports cannot, in order to prevent coercion, while votes involve higher cryptographic guarantees than supports). +. They can *comment* on any object of the platform (proposals, debates, results, sortitions, etc.). +. They can *endorse* any content, meaning that they can publicly declare they support it or find it relevant, with the participants following it then receiving notifications. +. They can *follow* other participants, a participatory process, an initiative, a specific proposal, etc. and receive notifications. +. They can *sign up* for a meeting. +. They can also *share* and *embed* content out of the platform, sharing the link to other social networks and embedding content on other sites. + +Component items (e.g. a proposal, a blog post, a meeting) have their individual page but are also displayed as *cards* throughout the platform, cards being a major design interface to interact with components. <> displays a proposal card with the different types of data and interactions identified within the card. + +[#card-anatomy-fig] +._Decidim's proposal card anatomy._ +image::card-anatomy.png[] + +The users who participate in Decidim can be grouped into three different categories: + +* *Visitors* have access to all of the platform's content without having to sign up or provide any information. +* *Registered* participants can create content and comments, sign-up for meetings, endorse content, follow other participants and objects of the platform, customize their profile and receive notifications, mentions and private messages. By choosing a username and password, accepting the user agreement, and providing an email account (or using an account for several social networks) participants become registered. Registered participants can also have their account officialized (meaning their username is accompanied by a special symbol indicating they really are who they claim they are on their profile). +* *Verified* participants can make decisions. In order to fall under this category they must first be verified as members of the organization, citizens of the municipality, or constituents of the decision-making group (an association, community, collective etc.). Decidim offers different ways to carry out this verification. Once verified, participants will be able to take decisions by supporting proposals, signing initiatives and voting in consultations. + +Administrators can *manage permissions* for registered or verified users selectively. For example proposal creation can be activated for both registered and verified users but supports to proposals only for verified users. It is also possible (although rarely recommended) to consider all registered users as verified and to grant them decision making powers. + +There are different types of administrators: *administrators* of the whole platform or of specific spaces and components, they can also be *moderators* (with the exclusive power of moderating proposals, comments or debates) or *collaborators* that can read unpublished content, create notes and responses to proposals. + +Participants can register as an *individual* or as a *collective* (associations, working groups, etc. within the main organization). User *groups* might also be created so that individuals can be associated to a *group*. Decidim allows participants belonging to such a group to express or act individually or embodying the group identity: when an action is carried the platform prompts the participant to choose wether they want to act as themselves or as the group they belong to. + +Participants can not only navigate the content of Decidim through the top menu and move down the architectural hierarchy, from a space to its different components; they can also get information through the *search engine*, or via *notifications*. Participants can also talk to each other by internal messaging or *chat*. + +The participant's *profile* makes possible to read notifications, manage followers, and monitor different gamification and engagement badges. + +The *home page* of the platform is fully customizable: it can display different types of banners, call-to-action buttons, it can also display statistics and interactive visualizations, activity streams, and maps with the upcoming meetings. + +The content of the platform can be classified by different criteria. A participatory space and its contents (e.g. a participatory process or the proposals within) can be (independently) assigned a *scope*. Scopes are defined for the whole platform, and they can be thematic or territorial (for example, an assembly can be assigned to a specific theme or subject, like "ecology", and to a specific territory, like a district within a city). Content within a space-instance can be assigned to a *category* or sub-category (e.g. topics) that are specific for such a space-instance. For example, the categories "sport facilities", "parks" and "schools" can be created for a participatory budgeting process, and proposals will be assigned to these categories. *Hashtags* can also be freely created and introduced in the body text almost anywhere in the platform (proposals, debates, comments, process description, etc), both by participants and administrators, to classify content and make it searchable. + +Unlike other existing platforms, Decidim’s architecture is *modular*, *scalable*, easy to *configure*, and *integrated* with other tools or apps (data analysis, maps, SMS, mail, social networks, etc.). The platform has been designed in such a way that processes, assemblies and mechanisms can be set up easily and deployed from an administration panel. No knowledge of programming is required to install, configure and activate it. The participatory spaces and components can be developed, activated and deactivated independently. \ No newline at end of file diff --git a/docs/de/modules/releases/pages/index.adoc b/docs/de/modules/releases/pages/index.adoc new file mode 100644 index 0000000000..f0af39d4f1 --- /dev/null +++ b/docs/de/modules/releases/pages/index.adoc @@ -0,0 +1,35 @@ += Release notes + +Here you can find all the blog posts for every minor release. + +You can find all the releases (with minor and patches) at +https://rubygems.org/gems/decidim/versions[RubyGems.org] and +https://github.com/decidim/decidim/releases[GitHub]. + +* https://decidim.org/blog/2023-12-20-new-version-0-28-0/[Version 0.28 (2022-12-20)] +* https://decidim.org/blog/2022-09-30-new-version-0-27-0/[Version 0.27 (2022-09-30)] +* https://decidim.org/blog/2022-02-22-new-version-0-26-0/[Version 0.26 (2022-02-22)] +* https://decidim.org/blog/2021-10-07-new-version-0-25-0/[Version 0.25 (2021-10-07)] +** xref:develop:guide_migrate_webpacker_module.adoc[Migrate to Webpacker a module] +** xref:develop:guide_migrate_webpacker_app.adoc[Migrate to Webpacker an instance app] +* https://decidim.org/blog/2021-03-26-new-version-0-24-0/[Version 0.24 (2021-03-26)] +* https://decidim.org/blog/2020-11-12-new-version-0-23-0/[Version 0.23 (2020-11-12)] +* https://decidim.org/blog/2020-09-02-new-version-0-22-0/[Version 0.22 (2020-09-02)] +* https://decidim.org/blog/2020-04-12-new-version-0-21-0/[Version 0.21 (2020-04-12)] +* https://decidim.org/blog/2020-02-06-new-version-0-20-0/[Version 0.20 (2020-02-06)] +* https://decidim.org/blog/2019-10-21-release-0-19-0/[Version 0.19 (2019-10-21)] +* https://decidim.org/blog/2019-07-03-release-0-18-0/[Version 0.18 (2019-07-03)] +* https://decidim.org/blog/2019-03-25-release-0-17-0/[Version 0.17 (2019-03-25)] +* https://decidim.org/blog/2019-01-14-release-0-16-0/[Version 0.16 (2019-01-14)] +* https://decidim.org/blog/2018-12-13-release-0-15-0/[Version 0.15 (2018-12-13)] +* https://decidim.org/blog/2018-08-30-release-0-14-0/[Version 0.14 (2018-08-30)] +* https://decidim.org/blog/2018-07-11-release-0-13-0/[Version 0.13 (2018-07-11)] +* https://decidim.org/blog/2018-06-13-release-0-12-0/[Version 0.12 (2018-06-13)] +* https://decidim.org/blog/2018-04-27-release-0-11-0/[Version 0.11 (2018-04-27)] +* https://decidim.org/blog/2018-03-29-release-0-10-0/[Version 0.10 (2018-03-29)] +* https://decidim.org/blog/2018-02-06-release-0-9-0/[Version 0.9 (2018-02-06)] +* https://decidim.org/blog/2017-12-21-release-0-8-0/[Version 0.8 (2017-12-21)] +* https://decidim.org/blog/2017-11-21-release-0-7-0/[Version 0.7 (2017-11-21)] +* https://decidim.org/blog/2017-09-21-release-0-6-0/[Version 0.6 (2017-09-21)] +* https://decidim.org/blog/2017-08-29-release-0-5-0/[Version 0.5 (2017-08-29)] +* https://decidim.org/blog/2017-07-17-release-0-4-0/[Version 0.4 (2017-07-17)] \ No newline at end of file diff --git a/docs/es/modules/ROOT/nav.adoc b/docs/es/modules/ROOT/nav.adoc index ef8f361fc9..21a5f32d0e 100644 --- a/docs/es/modules/ROOT/nav.adoc +++ b/docs/es/modules/ROOT/nav.adoc @@ -61,6 +61,7 @@ **** 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/assemblies.adoc[Assemblies] **** xref:admin:spaces/assemblies/components.adoc[Components] **** xref:admin:spaces/assemblies/categories.adoc[Categories] @@ -151,6 +152,18 @@ *** xref:develop:guide_architecture.adoc[5. Architecture] ** xref:develop:security.adoc[Security] ** Advanced +*** Creating custom classes +**** xref:develop:classes/cells.adoc[Cells] +**** xref:develop:classes/commands.adoc[Commands] +**** xref:develop:classes/controllers.adoc[Controllers] +**** xref:develop:classes/events.adoc[Events] +**** xref:develop:classes/forms.adoc[Forms] +**** xref:develop:classes/jobs.adoc[Jobs] +**** xref:develop:classes/mailers.adoc[Mailers] +**** xref:develop:classes/models.adoc[Models] +**** xref:develop:classes/permissions.adoc[Permissions] +**** xref:develop:classes/presenters.adoc[Presenters] +**** xref:develop:classes/queries.adoc[Queries] *** Concerns **** xref:develop:authorable.adoc[Authorable] **** xref:develop:embeddable.adoc[Embeddable] @@ -167,16 +180,19 @@ *** xref:develop:deploy.adoc[Deploy] *** xref:develop:docker.adoc[Docker] *** xref:develop:fixing_locales.adoc[Fixing locales] -*** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] *** xref:develop:maps.adoc[Maps] *** xref:develop:managing_translations_i18n.adoc[i18n] +*** xref:develop:maintainers/index.adoc[Maintainers] +**** xref:develop:backports.adoc[Backports] +**** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] +**** xref:develop:maintainers/releases.adoc[Releasing new versionss] +**** xref:develop:maintainers/security.adoc[Security procedures] *** xref:develop:metrics.adoc[Metrics] *** xref:develop:modules.adoc[Modules] *** xref:develop:notifications.adoc[Notifications] *** xref:develop:open-data.adoc[Open Data] *** xref:develop:permissions.adoc[Permissions] *** xref:develop:profiling.adoc[Profiling] -*** xref:develop:releases.adoc[Releases] *** xref:develop:reminders.adoc[Reminders] *** xref:develop:templates.adoc[Templates] *** xref:develop:testing.adoc[Testing] @@ -184,7 +200,6 @@ *** xref:develop:turbolinks.adoc[Turbolinks] *** Views **** xref:develop:content_blocks.adoc[Content Blocks] -**** xref:develop:data-picker.adoc[Data Picker] **** xref:develop:newsletter_templates.adoc[Newsletter Templates] **** xref:develop:view_hooks.adoc[View Hooks] **** xref:develop:view_models_aka_cells.adoc[View Models (Cells)] @@ -215,4 +230,4 @@ *** xref:publications:spanish.adoc[Spanish] ** Whitepaper *** xref:whitepaper:decidim-a-brief-overview.adoc[Decidim: a brief overview] -* xref:releases:index.adoc[Release Notes] \ No newline at end of file +* xref:releases:index.adoc[Release notes] \ No newline at end of file diff --git a/docs/es/modules/ROOT/pages/index.adoc b/docs/es/modules/ROOT/pages/index.adoc index 8ed5c4eb1d..abc8d67629 100644 --- a/docs/es/modules/ROOT/pages/index.adoc +++ b/docs/es/modules/ROOT/pages/index.adoc @@ -8,6 +8,11 @@ Decidim is a framework that allows anybody to create and configure a website pla You’ve found the documentation for Decidim. Learn about the project at https://decidim.org[decidim.org]. +[NOTE] +==== +This is the documentation for the `develop` branch. You can see this same documentation site for other versions: xref:v0.28@ROOT:index.adoc[v0.28] and xref:v0.27@ROOT:index.adoc[v0.27] +==== + // * Read the xref:ROOT:getting-started.adoc[Getting Started guide] The documentation covers xref:install:index.adoc[installing], xref:configure:index.adoc[configuring], and xref:admin:index.adoc[running] your own Decidim site. diff --git a/docs/es/modules/admin/pages/components/accountability.adoc b/docs/es/modules/admin/pages/components/accountability.adoc index 3657f8f81d..2913cb2ce9 100644 --- a/docs/es/modules/admin/pages/components/accountability.adoc +++ b/docs/es/modules/admin/pages/components/accountability.adoc @@ -7,4 +7,4 @@ The Accountability component allows people to follow project implementations. It * defining and applying progress in implementation statuses (0% to 100% implemented) around their implementation * displaying the extent of the results’ implementation grouped by categories and scopes -Results, projects and statuses can be updated through a CVS, or manually by the administration interface. \ No newline at end of file +Results, projects and statuses can be updated through a CSV (comma-separated values), or manually by the administration interface. \ No newline at end of file diff --git a/docs/es/modules/admin/pages/components/budgets.adoc b/docs/es/modules/admin/pages/components/budgets.adoc index e4e986f0b1..93261f865c 100644 --- a/docs/es/modules/admin/pages/components/budgets.adoc +++ b/docs/es/modules/admin/pages/components/budgets.adoc @@ -17,7 +17,7 @@ Some examples of where this component was used: * https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona]. The city of Barcelona (Spain) has allocated a budget of 30.000.000 EUR so people can present, define, prioritize, vote -and choose which investment projects the city goverment should execute. +and choose which investment projects the city government should execute. * https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers (France) has allocated a budget of 1.000.000 EUR so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. * https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million euros to realising @@ -345,7 +345,7 @@ After the voting step has finished, then an administrator need to: . Change the Voting configuration for the Budget component to "Voting finished" . Go to the Budgets and view the results -. On the projects that according to the normative have been selected, she'll need to go to each project, edit it and +. On the projects that according to the normative have been selected, they will need to go to each project, edit it and then check the "Selected for implementation". image:components/budgets/results_unselected.png[Unselected projects after voting] diff --git a/docs/es/modules/admin/pages/components/meetings.adoc b/docs/es/modules/admin/pages/components/meetings.adoc index 96b29fa84e..8b017d8085 100644 --- a/docs/es/modules/admin/pages/components/meetings.adoc +++ b/docs/es/modules/admin/pages/components/meetings.adoc @@ -130,7 +130,7 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we Meetings can be created by participants if the setting is "Participants can create meetings" is checked. -If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create meetings as that group also. +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create meetings as that group also. image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)] image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form (frontend)] @@ -202,7 +202,7 @@ image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting f |Create meeting as |Required if the participant belongs to a group -|With which identity she wants to create this meeting: as her user or as a group that she's reprensenting? +|With which identity they want to create this meeting: as their user or as a group that they are reprensenting? |=== After creating the meeting, participants can also edit and xref:components/meetings/close.adoc[close] it. diff --git a/docs/es/modules/admin/pages/components/meetings/registrations.adoc b/docs/es/modules/admin/pages/components/meetings/registrations.adoc index 71f3b3adb2..b8a7cfd6de 100644 --- a/docs/es/modules/admin/pages/components/meetings/registrations.adoc +++ b/docs/es/modules/admin/pages/components/meetings/registrations.adoc @@ -81,7 +81,7 @@ The exported data will have these fields: * code: the xref:_registration_code[registration code] (if this feature is enabled) * user/name: the name of the user * user/email: the email of the user -* user/user_group: the group of the user if she has selected that's representing a group when registering +* user/user_group: the group of the user if they have selected that's representing a group when registering == Invitations @@ -92,7 +92,7 @@ image:components/meetings/registrations/invite_attendee.png[Invite attendee for == Registration code -This feature allows you to check if the attendee is registered in the meeting. She needs to provide her code, that gets +This feature allows you to check if the attendee is registered in the meeting. They need to provide their code, that gets entered in this form and it's checked against the database. image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting] diff --git a/docs/es/modules/admin/pages/components/proposals.adoc b/docs/es/modules/admin/pages/components/proposals.adoc index 5d2b652324..808fb78693 100644 --- a/docs/es/modules/admin/pages/components/proposals.adoc +++ b/docs/es/modules/admin/pages/components/proposals.adoc @@ -68,8 +68,8 @@ For instance, if you have two components, "Proposals" with weight "10" and "Meet |Minimum supports per user |Optional -|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If she doesn't -reach this number, her supports will not be taken in account. +|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If they don't +reach this number, their supports will not be taken in account. |Proposal limit per participant |Optional @@ -322,7 +322,7 @@ image:components/proposals/new_proposal_frontend.png[New proposal form] Proposals can be created by participants if the setting is "Proposal creation enabled" is checked for the active phase. -If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create proposals as that group also. +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create proposals as that group also. This form depends a lot in which settings you've enabled in this component. It can be really short (with only a Title and Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, Image and Attachment). diff --git a/docs/es/modules/admin/pages/components/proposals/amendments.adoc b/docs/es/modules/admin/pages/components/proposals/amendments.adoc index be89e58eb5..1bc4fd0b75 100644 --- a/docs/es/modules/admin/pages/components/proposals/amendments.adoc +++ b/docs/es/modules/admin/pages/components/proposals/amendments.adoc @@ -42,7 +42,7 @@ image:components/proposals/amendments/amendment_list.png[] image:components/proposals/amendments/amendment_view_side_by_side.png[] . It's also possible to filter the amended proposals image:components/proposals/amendments/amendment_list_filter.png[] -. Alice receives a notification that Bob has proposed an amendment to her original proposal +. Alice receives a notification that Bob has proposed an amendment to their original proposal image:components/proposals/amendments/proposal_amendmed_notification.png[] . Alice can see the amendment proposal image:components/proposals/amendments/proposal_amendmed_to_review.png[] diff --git a/docs/es/modules/admin/pages/components/proposals/collaborative_drafts.adoc b/docs/es/modules/admin/pages/components/proposals/collaborative_drafts.adoc index 9c26ef25e2..ef2c4cb7b3 100644 --- a/docs/es/modules/admin/pages/components/proposals/collaborative_drafts.adoc +++ b/docs/es/modules/admin/pages/components/proposals/collaborative_drafts.adoc @@ -6,7 +6,7 @@ It's useful to propose improvements or corrections. It has similarities with xref:components/proposals/amendments.adoc[Amendments] but the main difference is that with collaborative drafts there is a need to trust other authors, as they can make any change to the original proposal without approval by the -original author, although the original author can decide if she promotes the collaborative draft as a proposal. +original author, although the original author can decide if they promote the collaborative draft as a proposal. image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[Collaborative draft with request access button] @@ -24,7 +24,7 @@ For instance, it could be "Processes", "Assemblies", or "Conferences" == How it works -. A participant (Alice) wants to create a collaborative draft. For that, she goes to the proposals list page. +. A participant (Alice) wants to create a collaborative draft. For that, they go to the proposals list page. . Alice clicks in the "Access collaborative drafts" button image:components/proposals/collaborative_drafts/proposals_list01.png[] . Alice clicks in "New collaborative draft" button @@ -40,7 +40,7 @@ image:components/proposals/collaborative_drafts/collaborative_draft_request_acce image:components/proposals/collaborative_drafts/access_requested.png[] . Alice receives the notification image:components/proposals/collaborative_drafts/notification.png[] -. Alice goes to the collaborative draft. There she can accept or reject the collaboration request +. Alice goes to the collaborative draft. There they can accept or reject the collaboration request image:components/proposals/collaborative_drafts/author_sidebar.png[] . Alice approves the collaboration request. Once a request is approved it can't be rejected . Now the collaborative draft has multiple authors @@ -53,7 +53,7 @@ image:components/proposals/collaborative_drafts/collaborative_draft_edited.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_01.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_02.png[] -. Once Alice is satisfied with the collaborative draft, she can publish it by click in the "Publish" button +. Once Alice is satisfied with the collaborative draft, they can publish it by click in the "Publish" button image:components/proposals/collaborative_drafts/publish_modal.png[] . When it's published it becomes a proposal image:components/proposals/collaborative_drafts/proposal.png[] diff --git a/docs/es/modules/admin/pages/features/badges.adoc b/docs/es/modules/admin/pages/features/badges.adoc index 6cf9a138d3..7d546a113e 100644 --- a/docs/es/modules/admin/pages/features/badges.adoc +++ b/docs/es/modules/admin/pages/features/badges.adoc @@ -5,16 +5,16 @@ and interacting in the platform, they will earn different badges. Here is the li It's a https://en.wikipedia.org/wiki/Gamification[gamification] mechanism to improve the engagement of the participants in a ludic way. -The badges a participant has are visible in her account. There's also a general explanation page with a short description of every badge. +The badges a participant has are visible in their account. There's also a general explanation page with a short description of every badge. image:features/badges/example01.png[Example of badges in profile] -When a participant earns a badge she receives a notification. +When a participant earns a badge they receive a notification. image:features/badges/notification.png[Example of badges notification] -Badges have multiple levels, depending in the number of times she has made the action. For instance, for Proposals badge -she'll receive the first level badge when arriving at 1 follower, the second level at 15 followers, the third level at 30 followers, +Badges have multiple levels, depending in the number of times they have made the action. For instance, for Proposals badge +they will receive the first level badge when arriving at 1 follower, the second level at 15 followers, the third level at 30 followers, the fourth level at 60 and the fifth level at 100. @@ -25,14 +25,14 @@ the fourth level at 60 and the fifth level at 100. |image:features/badges/accepted_proposals_badge.png[Accepted proposals badge] |Accepted proposals |Granted when particiapnts actively participate with new proposals and these are accepted. -|The participant needs to choose the participation space of her interest with submission for proposals enabled and try to +|The participant needs to choose the participation space of their interest with submission for proposals enabled and try to make proposals that can be carried out. This way they are more likely to be accepted. |1, 5, 15, 30, 50 |image:features/badges/attended_meetings_badge.png[Attended meetings badge] |Attended meetings |Granted when participants attend several face-to-face meetings. -|The participant needs to register for the meetings she want to attend +|The participant needs to register for the meetings they want to attend |1, 3, 5, 10, 30 |image:features/badges/debates_badge.png[Debates badge] @@ -45,7 +45,7 @@ make proposals that can be carried out. This way they are more likely to be acce |Followers |Granted when participant reach a certain number of followers. The platform is a social and political network, so participants ned to weave their web to communicate with other people in the platform. -|The participant needs to be be active and follow other people. That will surely make other people follow her. +|The participant needs to be be active and follow other people. That will surely make other people follow them. |1, 15, 30, 60, 100 |image:features/badges/published_initiatives_badge.png[Published initiatives badge] @@ -57,20 +57,20 @@ participants ned to weave their web to communicate with other people in the plat |image:features/badges/invitations_badge.png[invitations badge] |Invitations |Granted when participants invite some people and they have become participants. -|The participant needs to use the “invite friends” link on her user page to invite her friends. She can customize the -message she's sending. She’ll level up by sending invitations and getting them registered. Note that this feature is disabled +|The participant needs to use the “invite friends” link on their user page to invite their friends. They can customize the +message they are sending. They will level up by sending invitations and getting them registered. Note that this feature is disabled and this badge is not available, so it'll be removed in the future. |1, 5, 10, 30, 50 |image:features/badges/proposal_supports_badge.png[Proposal supports badge] |Proposal supports |Granted when participants support other people's proposals. -|The participant needs to browse and spend some time reading other people's proposals and give support to the proposals she like or find interesting. +|The participant needs to browse and spend some time reading other people's proposals and give support to the proposals they like or find interesting. |5, 15, 50, 100, 500 |image:features/badges/proposals_badge.png[Proposals badge] |Proposals |Granted when participants actively participate with new proposals. -|The participant needs to choose the participation space of her interest with submission for proposals enabled and create a new proposal. +|The participant needs to choose the participation space of their interest with submission for proposals enabled and create a new proposal. |1, 5, 10, 30, 60 |=== \ No newline at end of file diff --git a/docs/es/modules/admin/pages/features/endorsements.adoc b/docs/es/modules/admin/pages/features/endorsements.adoc index b407e0ca97..90b2f56ab5 100644 --- a/docs/es/modules/admin/pages/features/endorsements.adoc +++ b/docs/es/modules/admin/pages/features/endorsements.adoc @@ -8,7 +8,7 @@ This is done through the button in the sidebar. Administrators can enable or dis image:features/endorsements/sidebar.png[Endorsement button in sidebar] -When a participant belongs to a verified group she can also endorse like that group by selecting the identity. +When a participant belongs to a verified group they can also endorse like that group by selecting the identity. image:features/endorsements/modal.png[Select identity modal] diff --git a/docs/es/modules/admin/pages/features/my_account.adoc b/docs/es/modules/admin/pages/features/my_account.adoc index f15dc1f51e..67c0baefad 100644 --- a/docs/es/modules/admin/pages/features/my_account.adoc +++ b/docs/es/modules/admin/pages/features/my_account.adoc @@ -1,6 +1,6 @@ = My account -My account is all the pages where a participant can change her personal data that is displayed in her xref:admin:features/my_public_profile.adoc[My public profile] page, change her notifications settings, see which groups she belongs, etc. +My account is all the pages where a participant can change their personal data that is displayed in their xref:admin:features/my_public_profile.adoc[My public profile] page, change their notifications settings, see which groups they belong to, etc. To go to this section: @@ -8,7 +8,7 @@ To go to this section: . Click in the name of the participant in the header . Click in "My account" -The actions that she can do are: +The actions that they can do are: * xref:admin:features/my_account/account.adoc[Account] * xref:admin:features/my_account/notifications_settings.adoc[Notifications settings] diff --git a/docs/es/modules/admin/pages/features/my_account/account.adoc b/docs/es/modules/admin/pages/features/my_account/account.adoc index 9eb98b406b..115a68a819 100644 --- a/docs/es/modules/admin/pages/features/my_account/account.adoc +++ b/docs/es/modules/admin/pages/features/my_account/account.adoc @@ -28,7 +28,7 @@ The service crops the image. Maximum file size: 5MB |Your email |Required -|The email of the participant, where she'll receive notifications, password recovery, etc. If it's changed it needs to be +|The email of the participant, where they will receive notifications, password recovery, etc. If it's changed it needs to be confirmed. |Personal URL diff --git a/docs/es/modules/admin/pages/features/my_account/delete_my_account.adoc b/docs/es/modules/admin/pages/features/my_account/delete_my_account.adoc index 8ba403a53e..3522a1c183 100644 --- a/docs/es/modules/admin/pages/features/my_account/delete_my_account.adoc +++ b/docs/es/modules/admin/pages/features/my_account/delete_my_account.adoc @@ -10,7 +10,7 @@ To delete the account: . Click in the name of the participant in the header . Click in "My account" . Click in "Delete my account" in the sidebar -. Optionally, she can provide a reason for the deletion +. Optionally, they can provide a reason for the deletion . Click in "Delete my account" . Click in "Yes, I want to delete my account" diff --git a/docs/es/modules/admin/pages/features/notifications.adoc b/docs/es/modules/admin/pages/features/notifications.adoc index 18006f9c47..1d5a122581 100644 --- a/docs/es/modules/admin/pages/features/notifications.adoc +++ b/docs/es/modules/admin/pages/features/notifications.adoc @@ -1,5 +1,7 @@ = Notifications +== The notification menu + Most of the actions in the platform generate notifications so particpants can know when there are new things to watch. This is accessible from the `Notifications` menu item (image:icon_bell.png[Notification icon]) in the header, after a participant has logged in. @@ -13,4 +15,216 @@ If there are notifications, then the participant will see the icon with a color image:features/notifications/notifications.png[Example of notifications page when there are notifications] -image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] \ No newline at end of file +image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] + +== Notifications list + +Below is an exhaustive list of actions that trigger notifications to participants. Participants are divided into three categories: affected users, followers, and administrators. + +[NOTE] +==== +Affected users depend on the notification context. For instance, it could be the author of moderated content, a user that earns a badge, a user that has been mentioned, etc. +==== + +[cols="7,2,1,1,1"] +|=== +|Action |Feature |Affected user |Follower |Administrator + +|A new attachment has been created |Admin |❌ |✅ |❌ + +|An admin requested an export |Admin |❌ |❌ |✅ + +|A component has been published in a participatory space |Admin |❌ |✅ |❌ + +|A participant has tried to verify themself with the data of another participant |Verifications |❌ |❌ |✅ + +|An administrator moderated a resource because it has been reported |Moderation |✅ |❌ |❌ + +|A resource has been reported |Moderation |❌ |❌ |✅ + +|A user confirms the registration (if welcome notification is enabled) |User |✅ |❌ |❌ + +|A user earned a badge (if badges are enabled) |User |✅ |❌ |❌ + +|A user has reached a new badge level (if badges are enabled) |User |✅ |❌ |❌ + +|A user has been officialized |User |❌ |❌ |✅ + +|A user asked their data export |User |✅ |❌ |❌ + +|A user I follow endorsed a resource |User |❌ |✅ |❌ + +|A public profile has been updated |User |❌ |✅ |❌ + +|A new user group has been created |User groupsfootnote:user-group[If user groups are enabled] |❌ |❌ |✅ + +|A user group has updated its profile |User groupsfootnote:user-group[] |❌ |❌ |✅ + +|A user has been invited to join a user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user has been promoted as group admin |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user requested to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request has been accepted to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request to join the user group has been rejected |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The group admin has been demoted |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The user has been removed from the group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|An admin of the assembly has added you as one of its members |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the assembly |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the participatory process |Processes |✅ |❌ |❌ + +|The phases dates have been updated |Processes |❌ |✅ |❌ + +|A new phase has been activated |Processes |❌ |✅ |❌ + +|You have been assigned a role for the conference |Conferences |✅ |❌ |❌ + +|The registration to the conference has been confirmed |Conferences |✅ |❌ |❌ + +|The registration for the conference is open |Conferences |❌ |✅ |❌ + +|The conference occupied slots are over X% |Conferences |❌ |❌ |✅ + +|The conference is taking place in 2 days |Conferences |❌ |✅ |❌ + +|The conference has been updated |Conferences |❌ |✅ |❌ + +|The election is now active for the participatory space |Elections |❌ |✅ |❌ + +|You are added as a trustee for the election |Elections |✅ |❌ |❌ + +|An admin has added you as trustee |Elections |✅ |❌ |❌ + +|Your vote was accepted |Elections |✅ |❌ |❌ + +|You have been assigned a role of the Polling Station |Elections |✅ |❌ |❌ + +|Here is your Access Code |Elections |✅ |❌ |❌ + +|A user I follow created an initiative |Initiatives |❌ |✅ |❌ + +|My initiative has been created |Initiatives |✅ |❌ |❌ + +|A user I follow endorsed an initiative |Initiatives |❌ |✅ |❌ + +|A user sent their initiative to technical validation |Initiatives |❌ |❌ |✅ + +|The initiative has changed its status |Initiatives |✅ |✅ |❌ + +|The signatures end date for the initiative have been extended |Initiatives |❌ |✅ |❌ + +|The request to be part of the promoter committee for the initiative has been accepted |Initiatives |✅ |❌ |❌ + +|The request to be part of the promoter committee for the initiative has been rejected |Initiatives |✅ |❌ |❌ + +|A user wants to join your initiative |Initiatives |✅ |❌ |❌ + +|The initiative has reached the signatures threshold |Initiatives |❌ |❌ |✅ + +|Your initiative has achieved the X% of signatures |Initiatives |❌ |✅ |❌ + +|The initiative has achieved the X% of signatures |Initiatives |✅ |❌ |❌ + +|The proposal has been included in a result |Accountability |❌ |✅ |❌ + +|The result progress has been updated |Accountability |❌ |✅ |❌ + +|A post has been published |Blogs |❌ |✅ |❌ + +|The budget is now active |Budgets |❌ |✅ |❌ + +|A resource has a comment |Comments |❌ |✅ |❌ + +|A user group has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has replied your comment |Comments |✅ |❌ |❌ + +|A group you belong to has been mentioned |Comments |✅ |❌ |❌ + +|You have been mentioned |Comments |✅ |❌ |❌ + +|Your comment in has been upvoted |Comments |✅ |❌ |❌ + +|Your comment in has been downvoted |Comments |✅ |❌ |❌ + +|A debate has been created |Debates |❌ |✅ |❌ + +|Debate creation is enabled for participants |Debates |❌ |✅ |❌ + +|Debate creation is no longer active |Debates |❌ |✅ |❌ + +|The debate was closed |Debates |✅ |✅ |❌ + +|A meeting has been created |Meetings |❌ |✅ |❌ + +|A meeting was closed |Meetings |✅ |✅ |❌ + +|A meeting was updated |Meetings |❌ |✅ |❌ + +|Your meeting's registration has been confirmed |Meetings |✅ |❌ |❌ + +|The allocated slots for the meeting are over X% |Meetings |❌ |❌ |✅ + +|The meeting has enabled registrations |Meetings |❌ |✅ |❌ + +|The registration code for the meeting has been validated. |Meetings |✅ |❌ |❌ + +|The meeting will start in less than 48h |Meetings |❌ |✅ |❌ + +|A new proposal has been published |Proposals |❌ |✅ |❌ + +|Proposal creation is open |Proposals |❌ |✅ |❌ + +|Proposal supports are open |Proposals |❌ |✅ |❌ + +|Proposal endorsements are open |Proposals |❌ |✅ |❌ + +|Someone has left a note on the proposal |Proposals |❌ |❌ |✅ + +|A proposal is currently being evaluated |Proposals |✅ |✅ |❌ + +|A proposal has been rejected |Proposals |✅ |✅ |❌ + +|A proposal has been accepted |Proposals |✅ |✅ |❌ + +|An admin has updated the scope of your proposal |Proposals |✅ |❌ |❌ + +|An admin has updated the category of your proposal |Proposals |✅ |❌ |❌ + +|A proposal has been mentioned |Proposals |✅ |❌ |❌ + +|A user requested access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user withdrawn the collaborative draft |Proposal drafts |✅ |❌ |❌ + +|An amendment has been rejected |Amendmentsfootnote:amendments[If amendments are enabled] |✅ |✅ |❌ + +|An amendment has been accepted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been created |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been promoted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|A sortition has been created |Sortitions |❌ |✅ |❌ + +|A survey has been opened |Surveys |❌ |✅ |❌ + +|A survey has been closed |Surveys |❌ |✅ |❌ +|=== \ No newline at end of file diff --git a/docs/es/modules/admin/pages/global_moderations.adoc b/docs/es/modules/admin/pages/global_moderations.adoc index bb3d553310..ce8d81dee3 100644 --- a/docs/es/modules/admin/pages/global_moderations.adoc +++ b/docs/es/modules/admin/pages/global_moderations.adoc @@ -36,8 +36,8 @@ the https://www.decidim.barcelona/pages/terms-and-conditions[Terms of Service] s > * to create multiple users by pretending to be different people (astroturfing). Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant -profile. After a participant has clicked in this action then she needs to provide a -reason why she's making this report: +profile. After a participant has clicked in this action then they need to provide a +reason why they are making this report: * Contains clickbait, advertising, scams or script bots. * Contains racism, sexism, slurs, personal attacks, death threats, suicide requests or any form of hate speech. diff --git a/docs/es/modules/admin/pages/help_sections.adoc b/docs/es/modules/admin/pages/help_sections.adoc index 7e942f55d7..9be6d5e3d7 100644 --- a/docs/es/modules/admin/pages/help_sections.adoc +++ b/docs/es/modules/admin/pages/help_sections.adoc @@ -1,6 +1,6 @@ = Help sections -The first time a visitor goes to any Space page she'll see an information box about what's this Space about. +The first time a visitor goes to any Space page they will see an information box about what's this Space about. This is how the information box is shown to participants and visitors: diff --git a/docs/es/modules/admin/pages/newsletters.adoc b/docs/es/modules/admin/pages/newsletters.adoc index 7c3c069551..cddc909cf4 100644 --- a/docs/es/modules/admin/pages/newsletters.adoc +++ b/docs/es/modules/admin/pages/newsletters.adoc @@ -141,8 +141,8 @@ the selected participatory spaces in the list * Sending the newsletter to all the participants that have selected an scope in their "My interests" settings in their account. -It's important to note that even if a participant has confirmed its account and -is following the space, the system will not send her a newsletter email if she +It's important to note that even if a participant has confirmed their account and +is following the space, the system will not send them a newsletter email if they haven't activated the "I want to receive newsletters". image::newsletter_select_recipients.png[Newsletter select recipients] diff --git a/docs/es/modules/admin/pages/pages.adoc b/docs/es/modules/admin/pages/pages.adoc index 70e77220cd..b68fbc4592 100644 --- a/docs/es/modules/admin/pages/pages.adoc +++ b/docs/es/modules/admin/pages/pages.adoc @@ -100,11 +100,11 @@ image::pages_backend_tos_change.png[Backend: ToS change] image::pages_frontend_tos_change.png[Frontend: ToS change] -If a participant rejects to accept the terms, then she has three options: +If a participant rejects to accept the terms, then they have three options: -. To review this again later. It signs her out automatically. +. To review this again later. It signs them out automatically. . To download their personal data -. To delete her account +. To delete their account image::pages_frontend_tos_reject.png[Frontend: ToS reject] diff --git a/docs/es/modules/admin/pages/participants/admins.adoc b/docs/es/modules/admin/pages/participants/admins.adoc index f88bcff92b..0746ef9183 100644 --- a/docs/es/modules/admin/pages/participants/admins.adoc +++ b/docs/es/modules/admin/pages/participants/admins.adoc @@ -11,7 +11,7 @@ Here you can: * see when was the last time an administrator logged in For inviting a new administrator, you need to go to the button "New user" and fill -the form with the admin username, email and which role will she have: +the form with the admin username, email and which role will they have: * Admin: to give full access to the platform * Participant manager: to give permission to only do xref:admin:participants/impersonations.adoc[Impersonations] diff --git a/docs/es/modules/admin/pages/participants/authorizations.adoc b/docs/es/modules/admin/pages/participants/authorizations.adoc index 3937fffc92..022397e249 100644 --- a/docs/es/modules/admin/pages/participants/authorizations.adoc +++ b/docs/es/modules/admin/pages/participants/authorizations.adoc @@ -8,7 +8,7 @@ With authorizations an administrator can define different permissions so partici For instance you can configure that only participants who have verified herselves by their identity documents can vote on proposals in a participatory process. -A participant can see which authorizations does she have available in her account settings. +A participant can see which authorizations do they have available in their account settings. image:authorizations_account.png[Authorizations in participants account] diff --git a/docs/es/modules/admin/pages/participants/authorizations/census.adoc b/docs/es/modules/admin/pages/participants/authorizations/census.adoc index b7e2cfbb9d..bc81ab9578 100644 --- a/docs/es/modules/admin/pages/participants/authorizations/census.adoc +++ b/docs/es/modules/admin/pages/participants/authorizations/census.adoc @@ -15,7 +15,7 @@ In the admin panel, the administrator can review the request by going to the "Or image:authorizations_organization_census.png[Organization's census in admin panel] -After the CSV is imported then the administrator can see how many participants where imported. She can also delete this +After the CSV is imported then the administrator can see how many participants where imported. They can also delete this imported census. image:authorizations_organization_census_imported.png[Imported CSV] @@ -29,6 +29,6 @@ image:authorizations_organization_census_account.png[Organization's census in pa == 3. The participant is verified (or not) -After is verified, as with other verifications, she can see it in her account settings. +After is verified, as with other verifications, they can see it in their account settings. image:authorizations_organization_census_verified.png[Verified by organization's census] \ No newline at end of file diff --git a/docs/es/modules/admin/pages/participants/authorizations/code_postal_letter.adoc b/docs/es/modules/admin/pages/participants/authorizations/code_postal_letter.adoc index 953c5c0eb0..7ad078d0f9 100644 --- a/docs/es/modules/admin/pages/participants/authorizations/code_postal_letter.adoc +++ b/docs/es/modules/admin/pages/participants/authorizations/code_postal_letter.adoc @@ -1,7 +1,7 @@ = Code by postal letter authorization -This authorization allows a participant to request for a verification code to be sent to its address, to confirm that she -lives or works in this place. She'll need to then fill the code in the platform. +This authorization allows a participant to request for a verification code to be sent to its address, to confirm that they +live or work in this place. They will need to then fill the code in the platform. The process is: @@ -9,16 +9,16 @@ The process is: . An administrator sends the letter to their address with the verification code. . An administrator marks the letter as sent. . Once you mark the letter as sent, the participant will be able to introduce the code. -. If this code matchs, then she gets verified. +. If this code matchs, then they get verified. == 1. A participant request the verification code By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for filling in her full address to request the verification code. +a participant can see the form for filling in their full address to request the verification code. image:authorizations_code_postal_letter_request.png[Code by postal letter request by participant] -If she tries to edit it, she'll see this message: +If they try to edit it, they will see this message: image:authorizations_code_postal_letter_edit.png[Edit the postal letter request] @@ -31,17 +31,17 @@ In the admin panel, the administrator can review the request by going to the "Co image:authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in admin] -Here she can see the verification code and can send it to the participant by mail. After the code is sent she can mark it +Here they can see the verification code and can send it to the participant by mail. After the code is sent they can mark it as sent with the icon image:action_mark_as_sent.png[Mark as sent]. It'll also show when the letter was sent. == 3. A participant fills in the verification code -After the participant has received the code, she can go to it's account settings and click in the "Code by postal letter" +After the participant has received the code, they can go to their account settings and click in the "Code by postal letter" verfication method. image:authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account] -Then she'll see the form for confirming the code. +Then they will see the form for confirming the code. image:authorizations_code_postal_letter_confirm.png[Code by postal letter confirmation form] @@ -52,6 +52,6 @@ If the verification code matches, then the participant will see the message "Con On the other hand, if the verification code doesn't match, then the participant will see the message "Your verification code doesn't match ours. Please double-check the letter we sent to you." -After is verified, as with other verifications, she can see it in her account settings. +After is verified, as with other verifications, they can see it in their account settings. image:authorizations_code_postal_letter_verified.png[Verified by code by postal letter] \ No newline at end of file diff --git a/docs/es/modules/admin/pages/participants/authorizations/identity_documents.adoc b/docs/es/modules/admin/pages/participants/authorizations/identity_documents.adoc index 2502903d6a..bff9992031 100644 --- a/docs/es/modules/admin/pages/participants/authorizations/identity_documents.adoc +++ b/docs/es/modules/admin/pages/participants/authorizations/identity_documents.adoc @@ -6,7 +6,7 @@ they could be a driver's license, a passport, a national identity card, a club m These documents will be reviewed by an administrator to accept or reject them. It's possible to do this process in two ways: Online or Offline. * Online: the participant will be asked to upload the documents, and the administrator will review these documents. -* Offline: the participant will be asked to fill in some data, and then she'll need to go to a presential place to show her documents face to face. +* Offline: the participant will be asked to fill in some data, and then they will need to go to a presential place to show their documents face to face. == Configuration @@ -42,13 +42,13 @@ The process is: . Participants fill in their document type and number and upload a copy of their document. . An administrator fills in the information present in the uploaded image. . The information should match whatever the user filled in. -. If the administrator can't clearly see the information or she can't get it verified, she can reject the request and +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and the user will be able to fix it. -=== 1. A participant fill in the document information and upload a copy of her document +=== 1. A participant fill in the document information and uploads a copy of their document By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for uploading a copy of her document. She also needs to fill in her document type and number. +a participant can see the form for uploading a copy of their document. They also need to fill in their document type and number. image:authorizations_id_document_online.png[ID document authorization online form] @@ -69,7 +69,7 @@ image:authorizations_id_document_online_confirm.png[ID document authorization on There are two actions an admin can do: * Accept: the participant will be fully authorized. -* Reject: the participant will be prompted to amend her documents +* Reject: the participant will be prompted to amend their documents If the request is rejected then the participant can provide other pictures or document. @@ -84,7 +84,7 @@ The process is: specific time to show their documents. . An administrator go to the "Offline verification" panel and fills in the information present in the physical documents. . The information should match whatever the user filled in. -. If the administrator can't clearly see the information or she can't get it verified, she can reject the request and +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and the user will be able to fix it. For this authorization to work, an administrator need to first configure it in the admin panel with the instructions explaining @@ -95,7 +95,7 @@ image:authorizations_id_document_configuration_offline.png[ID document authoriza === 1. A participant fill in the document information and follow the instructions By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for filling in her document type and number. +a participant can see the form for filling in their document type and number. image:authorizations_id_document_offline_request.png[ID document authorization offline form] @@ -105,7 +105,7 @@ In the admin panel, the administrator can review the request by clicking in the image:authorizations_id_document_offline_button.png[ID document authorization offline button in admin] -Then she'll need to fill some data provided by the participant and by reviewing the document physically provided by her. +Then they will need to fill some data provided by the participant and by reviewing the document physically provided by them. image:authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in admin] @@ -130,12 +130,12 @@ image:authorizations_id_document_offline_confirm.png[ID document authorization o === 3. The request is accepted or rejected In the cases where the verifications don't match (meaning that the email or the document number provided by the -participant and the ones filled by the administrators aren't the same), then the participant need to ammend it with her +participant and the ones filled by the administrators aren't the same), then the participant needs to amend it with their user account. == Both It's also possible to enable both of these verifications methods. In this case, the participant will be asked to choose -which kind of verification she wants to do. +which kind of verification they want to do. image:authorizations_id_document_account_choose.png[Choose ID document verification kind] \ No newline at end of file diff --git a/docs/es/modules/admin/pages/participants/groups.adoc b/docs/es/modules/admin/pages/participants/groups.adoc index 3201f6fac9..3a40bc859e 100644 --- a/docs/es/modules/admin/pages/participants/groups.adoc +++ b/docs/es/modules/admin/pages/participants/groups.adoc @@ -4,7 +4,7 @@ An user group is a group of participants. Depending in the installation and the == Creation -This action is done by **a participant**. She needs to go to their profile and in the sidebar there's a button that says "Create group": +This action is done by **a participant**. They need to go to their profile and in the sidebar there's a button that says "Create group": image:user_sidebar.png[User sidebar] @@ -48,7 +48,7 @@ image:user_group_new_form.png[New user group form] == Membership -After a group has been created, it's possible to invite participants to become members of the group. After a participant has accepted to be part of this group then she can become an admin. +After a group has been created, it's possible to invite participants to become members of the group. After a participant has accepted to be part of this group then they can become an admin. The actions that can be done by a participant in the user group are: diff --git a/docs/es/modules/admin/pages/participants/impersonations.adoc b/docs/es/modules/admin/pages/participants/impersonations.adoc index 9cd1788be5..05979cfe5f 100644 --- a/docs/es/modules/admin/pages/participants/impersonations.adoc +++ b/docs/es/modules/admin/pages/participants/impersonations.adoc @@ -36,7 +36,7 @@ After this data is confirmed then there'll be a session for the participant for image::participants_impersonations_user.png[Impersonated user session] Finally, it's also possible to Promote a participant, meaning that after a -participant has been managed, an administrator can add the email and send her +participant has been managed, an administrator can add the email and send them an Invitation: image::participants_impersonations_promotion.png[Admin's promotion Impersonations] \ No newline at end of file diff --git a/docs/es/modules/admin/pages/participants/participants.adoc b/docs/es/modules/admin/pages/participants/participants.adoc index e76ab358b4..64e5d2ec77 100644 --- a/docs/es/modules/admin/pages/participants/participants.adoc +++ b/docs/es/modules/admin/pages/participants/participants.adoc @@ -2,7 +2,7 @@ In this page an administrator can: -* Block a participant, for instance because she's spamming or acting against the Terms of Service +* Block a participant, for instance because they are spamming or acting against the Terms of Service * Contact a participant with Decidim private messages (Conversations) * Officialize a participant * See its email @@ -48,7 +48,7 @@ blocking this participant: image:participants_block_user_justification.png[Justificate the blocked user action] -Once a blocked participant tries to log-in she'll see an error message: +Once a blocked participant tries to log-in they will see an error message: image:participants_block_user_alert.png[Message shown to blocked user] @@ -58,7 +58,7 @@ See more at xref:admin:participants/reported_users.adoc[Reported users] === Show email address -After clicking this option, the admin will see a modal. She'll have to click in +After clicking this option, the admin will see a modal. They will have to click in button "Show email address". image:participants_show_email.png[Modal in show email] diff --git a/docs/es/modules/admin/pages/participants/reported_users.adoc b/docs/es/modules/admin/pages/participants/reported_users.adoc index 6616b10c2b..855316b7f4 100644 --- a/docs/es/modules/admin/pages/participants/reported_users.adoc +++ b/docs/es/modules/admin/pages/participants/reported_users.adoc @@ -8,8 +8,8 @@ A participant can be blocked from the xref:participants/participants.adoc[partic section in the admin panel] or through this "Reported users" section. Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant -profile. After a participant has clicked in this action she needs to provide a -reason why she's making this report: +profile. After a participant has clicked in this action they need to provide a +reason why they are making this report: * Contains clickbait, advertising, scams or script bots. * Contains racism, sexism, slurs, personal attacks, death threats, suicide requests @@ -26,7 +26,7 @@ blocking this participant: image:participants_block_user_justification.png[Justificate the blocked user action] -Once a blocked participant tries to log-in she'll see an error message: +Once a blocked participant tries to log-in they will see an error message: image:participants_block_user_alert.png[Message shown to blocked user] diff --git a/docs/es/modules/admin/pages/participants/verifications_conflicts.adoc b/docs/es/modules/admin/pages/participants/verifications_conflicts.adoc index 1e14b977f6..4e6afbfb07 100644 --- a/docs/es/modules/admin/pages/participants/verifications_conflicts.adoc +++ b/docs/es/modules/admin/pages/participants/verifications_conflicts.adoc @@ -4,8 +4,8 @@ There are cases depending on which kind of verifications you've enabled that the For instance: -. A participant get xref:admin:participants/impersonations.adoc[impersonated], and she doesn't provide an email -. Then she creates an account and tries to verify herself with the Census verification +. A participant get xref:admin:participants/impersonations.adoc[impersonated], and they don't provide an email +. Then they create an account and try to verify themselves with the Census verification For security, we try to be extra cautious in these cases, and we want that an administrator reviews these verifications. As you can see, this depends a lot on which kind of verifications you've enabled in your organization, so it's easy to say @@ -17,7 +17,7 @@ image:verifications_conflicts.png[Verification's conflicts panel] An administrator can review these conflicts by clicking in the Transfer user image:action_transfer_user.png[Transfer user] icon. -Then she'll see the Transfer user form, where she can provide a reason for the transfer. +Then they will see the Transfer user form, where they can provide a reason for the transfer. image:verifications_conflicts_transfer_user.png[] diff --git a/docs/es/modules/admin/pages/scopes.adoc b/docs/es/modules/admin/pages/scopes.adoc index e189ca92cb..a528c1eb9f 100644 --- a/docs/es/modules/admin/pages/scopes.adoc +++ b/docs/es/modules/admin/pages/scopes.adoc @@ -96,7 +96,7 @@ On a participatory space which concerns only one of the cities, you will be able === User interests and Newsletters -A Participant can choose which Scopes she wants to follow in its account. +A Participant can choose which Scopes they want to follow in its account. image:account_my_interests.png[Account: my interests] diff --git a/docs/es/modules/admin/pages/spaces/assemblies/members.adoc b/docs/es/modules/admin/pages/spaces/assemblies/members.adoc index 64a7159a8f..6668e828db 100644 --- a/docs/es/modules/admin/pages/spaces/assemblies/members.adoc +++ b/docs/es/modules/admin/pages/spaces/assemblies/members.adoc @@ -28,7 +28,7 @@ image:assembly_members_new_form.png[Assembly members new form] |Participant type |Required -|Wheter this assembly member is non-participant or existing participant. Does she already have an account created on the platform? +|Wheter this assembly member is non-participant or existing participant. Do they already have an account created on the platform? |Full name |Required if it's non-participant. diff --git a/docs/es/modules/admin/pages/spaces/conferences/registrations/invites.adoc b/docs/es/modules/admin/pages/spaces/conferences/registrations/invites.adoc index bd02c5da95..4ffe30d645 100644 --- a/docs/es/modules/admin/pages/spaces/conferences/registrations/invites.adoc +++ b/docs/es/modules/admin/pages/spaces/conferences/registrations/invites.adoc @@ -18,7 +18,7 @@ image:spaces/conferences/invite_participant_form.png[Invite a participant form] |Attendee type |Required -|Wheter this invited person is a non-existing or existing participant. Does she already have an account created on the platform? +|Wheter this invited person is a non-existing or existing participant. Do they already have an account created on the platform? |Name |Required if it's a non-existing participant. diff --git a/docs/es/modules/admin/pages/spaces/conferences/registrations/types.adoc b/docs/es/modules/admin/pages/spaces/conferences/registrations/types.adoc index 1625887826..e1756b8391 100644 --- a/docs/es/modules/admin/pages/spaces/conferences/registrations/types.adoc +++ b/docs/es/modules/admin/pages/spaces/conferences/registrations/types.adoc @@ -51,6 +51,6 @@ image:spaces/conferences/registration_types_backend.png[Manage registration type |Select conference meetings |=== -If the participant is already logged in then she'll see her username and email in the registration page. +If the participant is already logged in then they will see their username and email in the registration page. image:spaces/conferences/registration_types_frontend_w_user.png[Select registration type with user account] \ No newline at end of file diff --git a/docs/es/modules/admin/pages/spaces/conferences/registrations/users.adoc b/docs/es/modules/admin/pages/spaces/conferences/registrations/users.adoc index 33dc8d6b46..24e2468fc2 100644 --- a/docs/es/modules/admin/pages/spaces/conferences/registrations/users.adoc +++ b/docs/es/modules/admin/pages/spaces/conferences/registrations/users.adoc @@ -16,12 +16,12 @@ It's possible to export the registrations in multiple formats: CSV, JSON, and XL == Flow . A participant registers to the conference -. She receives a pending registration notification +. They receive a pending registration notification image:spaces/conferences/user_registration_pending_notification.png[Notification for pending user registration] -. She receives a pending registration email +. They receive a pending registration email image:spaces/conferences/user_registration_pending_email.png[Email for pending user registration] . An administrator reviews and confirms the registration with the image:action_check.png[Confirm] button . The participant receives a confirmed registration notification image:spaces/conferences/user_registration_confirmed_notification.png[Notification for confirmed user registration] -. She receives a confirmed registration email with an calendar file (.ICS). +. They receive a confirmed registration email with an calendar file (.ICS). image:spaces/conferences/user_registration_confirmed_email.png[Email for confirmed user registration] \ No newline at end of file diff --git a/docs/es/modules/admin/pages/spaces/conferences/speakers.adoc b/docs/es/modules/admin/pages/spaces/conferences/speakers.adoc index f62160a3e8..339f5a7256 100644 --- a/docs/es/modules/admin/pages/spaces/conferences/speakers.adoc +++ b/docs/es/modules/admin/pages/spaces/conferences/speakers.adoc @@ -26,7 +26,7 @@ image:spaces/conferences/new_speaker.png[Conferences speakers] |Participant type |Required -|Wheter this speaker is a non-participant or existing participant. Does she already have an account created on the platform? +|Wheter this speaker is a non-participant or existing participant. Do they already have an account created on the platform? |Full name |Required if it's non-participant. diff --git a/docs/es/modules/admin/pages/spaces/initiatives.adoc b/docs/es/modules/admin/pages/spaces/initiatives.adoc index 7abb57a326..f9dec1da31 100644 --- a/docs/es/modules/admin/pages/spaces/initiatives.adoc +++ b/docs/es/modules/admin/pages/spaces/initiatives.adoc @@ -90,7 +90,7 @@ image:admin_initiative_type.png[New initiative type form] |Collect participant personal data on signature |Optional -|Adds a step to the signature process. When a participant clicks on the signature button, she'll be redirected to a form asking for some personal data. This will be used with the PDF export action after the recollection period has ended. +|Adds a step to the signature process. When a participant clicks on the signature button, they will be redirected to a form asking for some personal data. This will be used with the PDF export action after the recollection period has ended. |Legal information about the collection of personal data |Depends on whether the option "Collect participant personal data on the signature" is checked @@ -104,7 +104,7 @@ image:admin_initiative_type.png[New initiative type form] |Authorization to verify document number on signatures |Optional -|When a participant is making the signature process, will she be asked for an authorization? +|When a participant is making the signature process, will they be asked for an authorization? |Add SMS code validation step to the signature process | @@ -137,7 +137,7 @@ This action is done by **the author**. The author is a participant that creates image:initiative_list.png[Initiatives list] -For creating an initiative, a participant must click in the "New initiative" button. Then she'll have a wizard with multiple steps: +For creating an initiative, a participant must click in the "New initiative" button. Then they will have a wizard with multiple steps: === 1.1 Choose the initiative type @@ -181,7 +181,7 @@ image:initiative_print.png[Print an initiative] ==== Technical validation -After the author has reviewed how the initiative will look, she can send it to technical validation. +After the author has reviewed how the initiative will look, they can send it to technical validation. image:initiative_send_to_technical_validation.png[Send initiative to technical validation] diff --git a/docs/es/modules/admin/pages/spaces/processes/types.adoc b/docs/es/modules/admin/pages/spaces/processes/types.adoc new file mode 100644 index 0000000000..2e1c452b2b --- /dev/null +++ b/docs/es/modules/admin/pages/spaces/processes/types.adoc @@ -0,0 +1,39 @@ += 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. + +Process Types work similarly to xref:admin:spaces/assemblies.adoc#_assemblies_types[Assembly types]. + +== New process type form + +For creating a new process type: + +. 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 + +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"] + + +.New participatory process type form: General information +|=== +|Field |Type |Description + +|Title +|Required +|Title of the participatory process type. For instance, "Consultative". +|=== + +== 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. + +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"] + +== Process type filter + +In the front-end if there is at least one Process Type defined, a filter shows, allowing filtering of Processes. + +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"] \ No newline at end of file diff --git a/docs/es/modules/admin/partials/page_admins.adoc b/docs/es/modules/admin/partials/page_admins.adoc index e4527970ba..db05cf9da8 100644 --- a/docs/es/modules/admin/partials/page_admins.adoc +++ b/docs/es/modules/admin/partials/page_admins.adoc @@ -28,7 +28,7 @@ image:spaces/admins_form.png[New space admin form] |Email |Required -|What is the email of the new admin, so she can receive the invitation. +|What is the email of the new admin, so they can receive the invitation. |Role |Required @@ -59,7 +59,7 @@ image:spaces/admins_role_moderator.png[Process moderators view] === Process valuators -A space valuator can review the proposals of the space. She can: +A space valuator can review the proposals of the space. They can: * change the status of the proposals, by accepting or rejecting them * add a monetary value to the proposals, so they can be voted with the budget component. diff --git a/docs/es/modules/admin/partials/page_private_participants.adoc b/docs/es/modules/admin/partials/page_private_participants.adoc index 90580396be..f5d5983d88 100644 --- a/docs/es/modules/admin/partials/page_private_participants.adoc +++ b/docs/es/modules/admin/partials/page_private_participants.adoc @@ -65,11 +65,11 @@ image:spaces/private_participants_actions.png[Private participants actions] == Invitation -When a participant was invited she'll get an email with a link for accepting the invitation: +When a participant was invited they will get an email with a link for accepting the invitation: image:spaces/private_participants_email_invite.png[Email invitation of a private participant] -After clicking in this email, she'll have to fill a form for setting her password, accepting the Terms of Service and giving -her consent if she wants to receive newsletters. +After clicking in this email, they will have to fill a form for setting their password, accepting the Terms of Service and giving +their consent if they want to receive newsletters. image:spaces/private_participants_user_registration_form.png[User registration form of a private participant] \ No newline at end of file diff --git a/docs/es/modules/features/pages/general-description.adoc b/docs/es/modules/features/pages/general-description.adoc index c54b27a835..e34d230c73 100644 --- a/docs/es/modules/features/pages/general-description.adoc +++ b/docs/es/modules/features/pages/general-description.adoc @@ -50,7 +50,7 @@ Administrators can *manage permissions* for registered or verified users selecti There are different types of administrators: *administrators* of the whole platform or of specific spaces and components, they can also be *moderators* (with the exclusive power of moderating proposals, comments or debates) or *collaborators* that can read unpublished content, create notes and responses to proposals. -Participants can register as an *individual* or as a *collective* (associations, working groups, etc. within the main organization). User *groups* might also be created so that individuals can be associated to a *group*. Decidim allows participants belonging to such a group to express or act individually or embodying the group identity: when an action is carried the platform prompts the participant to choose wether she wants to act as herself or as the group she belong to. +Participants can register as an *individual* or as a *collective* (associations, working groups, etc. within the main organization). User *groups* might also be created so that individuals can be associated to a *group*. Decidim allows participants belonging to such a group to express or act individually or embodying the group identity: when an action is carried the platform prompts the participant to choose wether they want to act as themselves or as the group they belong to. Participants can not only navigate the content of Decidim through the top menu and move down the architectural hierarchy, from a space to its different components; they can also get information through the *search engine*, or via *notifications*. Participants can also talk to each other by internal messaging or *chat*. diff --git a/docs/es/modules/releases/pages/index.adoc b/docs/es/modules/releases/pages/index.adoc index c9f9bc7423..f0af39d4f1 100644 --- a/docs/es/modules/releases/pages/index.adoc +++ b/docs/es/modules/releases/pages/index.adoc @@ -1,4 +1,4 @@ -= Releases += Release notes Here you can find all the blog posts for every minor release. @@ -6,6 +6,9 @@ You can find all the releases (with minor and patches) at https://rubygems.org/gems/decidim/versions[RubyGems.org] and https://github.com/decidim/decidim/releases[GitHub]. +* https://decidim.org/blog/2023-12-20-new-version-0-28-0/[Version 0.28 (2022-12-20)] +* https://decidim.org/blog/2022-09-30-new-version-0-27-0/[Version 0.27 (2022-09-30)] +* https://decidim.org/blog/2022-02-22-new-version-0-26-0/[Version 0.26 (2022-02-22)] * https://decidim.org/blog/2021-10-07-new-version-0-25-0/[Version 0.25 (2021-10-07)] ** xref:develop:guide_migrate_webpacker_module.adoc[Migrate to Webpacker a module] ** xref:develop:guide_migrate_webpacker_app.adoc[Migrate to Webpacker an instance app] diff --git a/docs/fr/modules/ROOT/nav.adoc b/docs/fr/modules/ROOT/nav.adoc new file mode 100644 index 0000000000..3c0908657e --- /dev/null +++ b/docs/fr/modules/ROOT/nav.adoc @@ -0,0 +1,233 @@ +* xref:install:index.adoc[Pour commencer] +** xref:install:manual.adoc[Installation Manuelle] +** xref:install:checklist.adoc[Checklist] +** xref:install:update.adoc[Mise à jour] +* xref:configure:index.adoc[Configurer] +** xref:configure:environment_variables.adoc[Variables d'environnement] +** xref:configure:initializer.adoc[Initializer] +** xref:customize:index.adoc[Customiser] +*** xref:customize:authorizations.adoc[Autorisations] +*** xref:customize:code.adoc[Code] +*** xref:customize:data_consent.adoc[Protection des données] +*** xref:customize:gemfile.adoc[Gemfile] +*** xref:customize:images.adoc[Images] +*** xref:customize:javascript.adoc[Javascript] +*** xref:customize:logic.adoc[Logic] +*** xref:customize:menu.adoc[Menu] +*** xref:customize:oauth.adoc[OAuth] +*** xref:customize:styles.adoc[Styles] +*** xref:customize:texts.adoc[Textes] +*** xref:customize:users_registration_mode.adoc[Mode d'inscription des utilisateurs] +*** xref:customize:views.adoc[Views] +** xref:services:index.adoc[Services] +*** xref:services:activejob.adoc[Active Job] +*** xref:services:activestorage.adoc[Active Storage] +*** xref:services:elections_bulletin_board.adoc[Elections Bulletin Board] +*** xref:services:etherpad.adoc[Etherpad] +*** xref:services:maps.adoc[Cartographies] +*** xref:services:sms.adoc[SMS] +*** xref:services:smtp.adoc[SMTP] +*** xref:services:social_providers.adoc[Fournisseurs d'identité sociaux] +* Administration +** xref:admin:index.adoc[Introduction] +*** xref:admin:system.adoc[Panneau d'administration système] +*** xref:admin:dashboard.adoc[Tableau de bord] +** Paramètres +*** xref:admin:configuration.adoc[Configuration] +*** xref:admin:appearance.adoc[Apparence] +*** xref:admin:homepage.adoc[Page d'accueil] +*** xref:admin:scopes.adoc[Secteurs] +*** xref:admin:areas.adoc[Périmètres d'assemblée] +*** xref:admin:help_sections.adoc[Sections d'aide] +** xref:admin:pages.adoc[Pages] +** xref:admin:participants.adoc[Utilisateurs] +*** xref:admin:participants/admins.adoc[Administrateurs] +*** xref:admin:participants/groups.adoc[Groupes d'utilisateurs] +*** xref:admin:participants/participants.adoc[Participants] +*** xref:admin:participants/impersonations.adoc[Utilisateurs représentés] +**** xref:admin:participants/verifications_conflicts.adoc[Conflits de vérification] +*** xref:admin:participants/reported_users.adoc[Utilisateurs signalés] +*** xref:admin:participants/authorizations.adoc[Autorisations] +**** xref:admin:participants/authorizations/identity_documents.adoc[Documents d'identité] +**** xref:admin:participants/authorizations/code_postal_letter.adoc[Code par lettre postale] +**** xref:admin:participants/authorizations/census.adoc[Recensement de l'organisation] +** xref:admin:spaces.adoc[Espaces] +*** xref:admin:spaces/processes.adoc[Concertations] +**** xref:admin:spaces/processes/phases.adoc[Étapes] +**** 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[Administrateurs de la concertation] +**** xref:admin:spaces/processes/private_participants.adoc[Utilisateurs privés] +**** 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/assemblies.adoc[Assemblies] +**** 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] +*** xref:admin:spaces/initiatives.adoc[Initiatives] +*** xref:admin:spaces/conferences.adoc[Conferences] +**** xref:admin:spaces/conferences/components.adoc[Components] +**** xref:admin:spaces/conferences/categories.adoc[Categories] +**** xref:admin:spaces/conferences/attachments.adoc[Attachments] +**** xref:admin:spaces/conferences/media_links.adoc[Media Links] +**** xref:admin:spaces/conferences/partners.adoc[Partners] +**** xref:admin:spaces/conferences/speakers.adoc[Speakers] +**** xref:admin:spaces/conferences/registrations.adoc[Registrations] +***** xref:admin:spaces/conferences/registrations/types.adoc[Registration Types] +***** xref:admin:spaces/conferences/registrations/users.adoc[User Registrations] +***** xref:admin:spaces/conferences/registrations/invites.adoc[Invites] +***** xref:admin:spaces/conferences/registrations/certificates.adoc[Certificate of Attendance] +**** xref:admin:spaces/conferences/admins.adoc[Conference admins] +**** xref:admin:spaces/conferences/moderations.adoc[Moderations] +*** xref:admin:spaces/consultations.adoc[Consultations] +*** xref:admin:spaces/votings.adoc[Votings] +** xref:admin:components.adoc[Components] +*** xref:admin:components/accountability.adoc[Accountability] +*** xref:admin:components/blog.adoc[Blog] +*** xref:admin:components/budgets.adoc[Budgets] +*** xref:admin:components/debates.adoc[Debates] +*** xref:admin:components/elections.adoc[Elections] +*** xref:admin:components/meetings.adoc[Meetings] +**** xref:admin:components/meetings/registrations.adoc[Registrations] +**** xref:admin:components/meetings/agenda.adoc[Agenda] +**** xref:admin:components/meetings/polls.adoc[Polls] +**** xref:admin:components/meetings/close.adoc[Close] +*** xref:admin:components/pages.adoc[Pages] +*** xref:admin:components/proposals.adoc[Proposals] +**** xref:admin:components/proposals/amendments.adoc[Amendments] +**** xref:admin:components/proposals/answers.adoc[Answers] +**** xref:admin:components/proposals/collaborative_drafts.adoc[Collaborative drafts] +**** xref:admin:components/proposals/participatory_texts.adoc[Participatory texts] +*** xref:admin:components/sortitions.adoc[Sortitions] +*** xref:admin:components/surveys.adoc[Enquêtes] +** Fonctionnalités +*** xref:admin:features/badges.adoc[Badges] +*** xref:admin:features/comments.adoc[Commentaires] +*** xref:admin:features/conversations.adoc[Conversations] +*** xref:admin:features/embed.adoc[Intégration] +*** xref:admin:features/endorsements.adoc[Endorsements] +*** xref:admin:features/fingerprint.adoc[Fingerprint] +*** xref:admin:features/follows.adoc[Follows] +*** xref:admin:features/metrics.adoc[Metrics] +*** xref:admin:features/my_account.adoc[My account] +**** xref:admin:features/my_account/account.adoc[Account] +**** xref:admin:features/my_account/notifications_settings.adoc[Notifications settings] +**** xref:admin:features/my_account/authorizations.adoc[Authorizations] +**** xref:admin:features/my_account/groups.adoc[Groups] +**** xref:admin:features/my_account/my_interests.adoc[My interests] +**** xref:admin:features/my_account/my_data.adoc[My data] +**** xref:admin:features/my_account/delete_my_account.adoc[Delete my account] +*** xref:admin:features/my_public_profile.adoc[My public profile] +**** xref:admin:features/my_public_profile/timeline.adoc[Timeline] +**** xref:admin:features/my_public_profile/activity.adoc[Activity] +**** xref:admin:features/my_public_profile/badges.adoc[Badges] +**** xref:admin:features/my_public_profile/follows.adoc[Follows] +**** xref:admin:features/my_public_profile/followers.adoc[Followers] +**** xref:admin:features/my_public_profile/groups.adoc[Groups] +*** xref:admin:features/notifications.adoc[Notifications] +*** xref:admin:features/search.adoc[Search] +*** xref:admin:features/share.adoc[Share] +*** xref:admin:features/statistics.adoc[Statistics] +*** xref:admin:features/versions.adoc[Versions] +** xref:admin:newsletters.adoc[Newsletters] +** xref:admin:global_moderations.adoc[Global moderations] +** Deprecated +*** xref:admin:information-pages.adoc[Information pages] +* xref:contribute:index.adoc[Contribute] +** xref:contribute:governance.adoc[Governance] +** xref:contribute:translations.adoc[Translations] +** xref:contribute:documentation.adoc[Documentation] +* xref:develop:index.adoc[Develop] +** xref:develop:guide.adoc[Guide] +*** xref:develop:guide_example_apps.adoc[1. Example Applications] +*** xref:develop:guide_development_app.adoc[2. Development App] +*** xref:develop:guide_commands.adoc[3. Commands] +*** xref:develop:guide_conventions.adoc[4. Conventions] +*** xref:develop:guide_architecture.adoc[5. Architecture] +** xref:develop:security.adoc[Security] +** Advanced +*** Creating custom classes +**** xref:develop:classes/cells.adoc[Cells] +**** xref:develop:classes/commands.adoc[Commands] +**** xref:develop:classes/controllers.adoc[Controllers] +**** xref:develop:classes/events.adoc[Events] +**** xref:develop:classes/forms.adoc[Forms] +**** xref:develop:classes/jobs.adoc[Jobs] +**** xref:develop:classes/mailers.adoc[Mailers] +**** xref:develop:classes/models.adoc[Models] +**** xref:develop:classes/permissions.adoc[Permissions] +**** xref:develop:classes/presenters.adoc[Presenters] +**** xref:develop:classes/queries.adoc[Queries] +*** Concerns +**** xref:develop:authorable.adoc[Authorable] +**** xref:develop:embeddable.adoc[Embeddable] +**** xref:develop:endorsable.adoc[Endorsable] +**** xref:develop:followable.adoc[Followable] +**** xref:develop:reportable.adoc[Reportable] +**** xref:develop:traceable.adoc[Traceable] +**** xref:develop:machine_translations.adoc[TranslatableResource aka Machine Translations] +**** xref:develop:share_tokens.adoc[Shareable with Tokens] +*** xref:develop:api.adoc[API] +*** xref:develop:components.adoc[Components] +*** xref:develop:content_processors.adoc[Content Processors] +*** xref:develop:custom_seed_data.adoc[Custom Seed Data] +*** xref:develop:deploy.adoc[Deploy] +*** xref:develop:docker.adoc[Docker] +*** xref:develop:fixing_locales.adoc[Fixing locales] +*** xref:develop:maps.adoc[Maps] +*** xref:develop:managing_translations_i18n.adoc[i18n] +*** xref:develop:maintainers/index.adoc[Maintainers] +**** xref:develop:backports.adoc[Backports] +**** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] +**** xref:develop:maintainers/releases.adoc[Releasing new versionss] +**** xref:develop:maintainers/security.adoc[Security procedures] +*** xref:develop:metrics.adoc[Metrics] +*** xref:develop:modules.adoc[Modules] +*** xref:develop:notifications.adoc[Notifications] +*** xref:develop:open-data.adoc[Open Data] +*** xref:develop:permissions.adoc[Permissions] +*** xref:develop:profiling.adoc[Profiling] +*** xref:develop:reminders.adoc[Reminders] +*** xref:develop:templates.adoc[Templates] +*** xref:develop:testing.adoc[Testing] +*** xref:develop:guide_development_with_localhost_ssl.adoc[Testing SSL and Tenants in Development] +*** xref:develop:turbolinks.adoc[Turbolinks] +*** Vues +**** xref:develop:content_blocks.adoc[Content Blocks] +**** xref:develop:newsletter_templates.adoc[Newsletter Templates] +**** xref:develop:view_hooks.adoc[View Hooks] +**** xref:develop:view_models_aka_cells.adoc[View Models (Cells)] +* Comprendre +** xref:understand:about.adoc[About] +** xref:understand:background.adoc[Background] +** xref:features:general-description.adoc[Features] +*** xref:features:participatory-spaces.adoc[Participatory spaces] +*** xref:features:components.adoc[Components] +*** xref:features:participants.adoc[Participants] +*** xref:features:general-features.adoc[General features] ++ +// ** xref:understand:governance.adoc[Project governance] + +// ** xref:understand:history.adoc[History of the project] + +// ** xref:understand:research.adoc[Research] + +** xref:understand:social-contract.adoc[Social Contract] +*** xref:understand:social-contract-ca.adoc[Català] +*** xref:understand:social-contract-es.adoc[Castellano] +** Publications +*** xref:publications:catalan.adoc[Catalan] +*** xref:publications:english.adoc[English] +*** xref:publications:french.adoc[French] +*** xref:publications:german.adoc[German] +*** xref:publications:italian.adoc[Italian] +*** xref:publications:spanish.adoc[Espagnol] +** Livre blanc +*** xref:whitepaper:decidim-a-brief-overview.adoc[Decidim : un bref aperçu] +* xref:releases:index.adoc[Release notes] \ No newline at end of file diff --git a/docs/fr/modules/ROOT/pages/index.adoc b/docs/fr/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000000..138357d46c --- /dev/null +++ b/docs/fr/modules/ROOT/pages/index.adoc @@ -0,0 +1,24 @@ += Bienvenue dans la documentation de Decidim + +Ceci est le site de documentation de Decidim, une plate-forme de démocratie participative créée initialement par la mairie de Barcelone. + +Decidim is a framework that allows anybody to create and configure a website platform, to be used in the form of a political network for democratic participation. The platform allows any organization (local city council, association, university, NGO, neighbourhood or cooperative) to create mass processes for strategic planning, participatory budgeting, collaborative design for regulations, urban spaces and election processes. + +== New to Decidim? + +You’ve found the documentation for Decidim. Learn about the project at https://decidim.org[decidim.org]. + +[NOTE] +==== +This is the documentation for the `develop` branch. You can see this same documentation site for other versions: xref:v0.28@ROOT:index.adoc[v0.28] and xref:v0.27@ROOT:index.adoc[v0.27] +==== + +// * Read the xref:ROOT:getting-started.adoc[Getting Started guide] + +The documentation covers xref:install:index.adoc[installing], xref:configure:index.adoc[configuring], and xref:admin:index.adoc[running] your own Decidim site. + +If you want to make changes to the source code, we have documentation for xref:develop:guide.adoc[developers] too. + +If you are an organisation who wants to use Decidim, or a developer who is interested in collaborating on the software, please https://decidim.org/contact[get in touch]. + +Decidim is a community effort, as such if you find any errors on these guides please let us know at hola [at] decidim [dot] org. Every help is welcome. If you've a GitHub user then you can even propose changes to this website with the Edit link on every page. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/components/accountability.adoc b/docs/fr/modules/admin/pages/components/accountability.adoc new file mode 100644 index 0000000000..4d7351af05 --- /dev/null +++ b/docs/fr/modules/admin/pages/components/accountability.adoc @@ -0,0 +1,10 @@ += Suivi des réalisations + +La fonctionnalité Suivi permet aux gens de suivre la mise en œuvre des projets. Elle fonctionne comme un système de gestion de projet intégré à la plateforme. Elle offre les possibilités suivantes : + +* créer des réalisations qui présentent les projets à mettre en œuvre +* subdiviser les réalisations en projets ou sous-projets +* définir et appliquer les mesures des progrès dans la mise en œuvre (de 0 % à 100 % mis en œuvre) des réalisations +* afficher l'avancement de l'implémentation des réalisations regroupées par catégories et secteurs + +Results, projects and statuses can be updated through a CSV (comma-separated values), or manually by the administration interface. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/components/budgets.adoc b/docs/fr/modules/admin/pages/components/budgets.adoc new file mode 100644 index 0000000000..0a293416cb --- /dev/null +++ b/docs/fr/modules/admin/pages/components/budgets.adoc @@ -0,0 +1,355 @@ += Budgets + +:page-toclevels: 4 + +The Budgets component allows people to vote by selecting projects of their choosing. Depending on the needs and normative +of the organization, this could be configured so people have assigned a total budget (for instance, 100.000 EUR) and then +every project has assigned a value (for instance, 10.000 EUR). Then when people vote on projects, they have a progress bar +where they see how much remaining budget they have to allocate in this voting. + +From this starting point, there could be other configurations, such as: + +* A minimum percentage of budget to be allocated +* A minimum number of projects to be allocated +* Multiple budgets, one for each district or neighborhood + +Some examples of where this component was used: + +* https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona]. +The city of Barcelona (Spain) has allocated a budget of 30.000.000 EUR so people can present, define, prioritize, vote +and choose which investment projects the city government should execute. +* https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers (France) has allocated +a budget of 1.000.000 EUR so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. +* https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million euros to realising +residents’ wishes. The ideas are developed together into proposals that Helsinki residents can vote on. The proposals with the +most votes are realised by the City. + +image:components/budgets/example01.png[Budgets example voting] +image:components/budgets/example02.png[Budgets example error messagge when exceding the amount of budget] +image:components/budgets/example03.png[Budgets vote confirmation] +image:components/budgets/example04.png[Budgets after voting] + +To configure the Budgets component: + +. Sign in as admin +. Go to admin panel +. Dans la barre latérale principale, cliquez sur le bouton de l'espace dont vous voulez configurer la fonctionnalité. +Par exemple, il peut s'agir de "Concertations", d'"Assemblées" ou de "Conférences". +. Aller dans les fonctionnalités +. Cliquez sur le bouton "Ajouter une fonctionnalité" +. Click on "Budgets" +. Remplissez le formulaire xref:_add_component[Ajouter une fonctionnalité] + +== Ajouter une fonctionnalité + +image:components/budgets/component.png[Add component form] + + +.Add component: Budgets form +|=== +|Champ |Type |Description + +|Nom +|Obligatoire +|Quel est le titre de cette fonctionnalité. For instance, "Budgets" + +|Rang d'affichage +|Facultatif +|Which order will it have in relation to the other budgets. Avoir un nombre inférieur signifie un rang d'affichage plus élevé. +For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0", then "Budget b" will be first when ordering. +|=== + + +.Add component: Budgets form - Global settings +|=== +|Champ |Type |Description + +|Scopes enabled +|Facultatif +|Check if you want to have Scopes filtering in this component. + +|Secteur +|Facultatif +|Which xref:admin:scopes.adoc[Scope] does this component belongs to. + +|Portée générale +|Facultatif +| + +|xref:_workflows[Workflow] +|Obligatoire +|How the participants can vote if there are multiple budget sets. You can define your own xref:_workflows[Workflow] or use one of the availables. + +|Projets par page +|Obligatoire +|Combien de projets sont affichés par page. + +|Activer la règle : Pourcentage de budget minimum +|Optional, but incompatible with "Minimum number of projects to be voted on" and "Selected projects with minimum and maximum number of projects to be voted on" +|Allows to define a "Vote threshold percent", a percent of the total budget that participants must reach to be able to vote. + +|Activer la règle : Nombre minimum de projets à voter +|Optional, but incompatible with "Minimum budget percentage" and "Selected projects with minimum and maximum number of projects to be voted on" +|Allows to define a "Minimum number of projects to vote", a number of projects that participants must reach to be able to vote. + +|Enable rule: Selected projects with minimum and maximum number of projects to be voted on +|Optional, but incompatible with "Minimum budget percentage" and "Minimum number of projects to be voted on" +|Allows to define a "Minimum amount of projects to be selected" and a "Maximum amount of projects to be selected", the number of projects +that participants will need to vote as a minimum and maximum. + +|Commentaires activés +|Facultatif +|Si vous voulez avoir des commentaires dans les rencontres. + +|Longueur maximale des commentaires +|Facultatif +|Quelle est la limite de caractères que les participants auront quand ils feront des commentaires. Laisser 0 pour la valeur par défaut. + +|Actions permissions can be set for each project +|Facultatif +|Whether you want to be able to set permissions for every one of the projects. Most of the time you will want to leave this option disabled. + +|Annonce +|Facultatif +|A general announcement that'll be visible on the general budgets landing page. + +|Budgets landing page +|Facultatif +|What message will be shown in the Budgets landing page when there are multiple budgets. + +|More information modal +|Facultatif +|What message will be shown when clicking on the "More information" link. +|=== + +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: Budgets form - Step settings +|=== +|Champ |Type |Description + +|Commentaires désactivés +|Facultatif +|Whether you want to enable comments for this phase. + +|Voting +|Obligatoire +|Choose one of the following options depending in the moment of the process: Voting disabled, Voting enabled or Voting finished. + +|Show votes +|Facultatif +|Wheter the votes will be shown. We strongly recommend that you only check this option after the voting is finished. + +|Annonce +|Facultatif +|A general announcement that'll be visible on the general budgets landing page. + +|Budgets landing page +|Facultatif +|What message will be shown in the Budgets landing page when there are multiple budgets. + +|More information modal +|Facultatif +|What message will be shown when clicking on the "More information" link. +|=== + +== Autorisations + +Edit permissions + +* Vote +* Commenter + +== Workflows + +One neat feature of the Budgets component is the ability to define your own workflows. + +This means that you can define multiple Budgets, for instance one for every Neighberhood or District that a City has, and +you can also define multiple rullings regarding how people can vote on those Budgets. By default you have these workflows: + +* Vote in one: allows participants to vote in any budget, but only in one. +* Vote in all: allows participants to vote in all budgets. +* Vote in a random component: allows participants to vote only in one budget, selected randomly. + +But this can be extended in your application by a developer, by making your own Workflows. For instance for the +https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona], +the people could vote in two districts: the one where they lived and one of their choosing. This was defined in the +https://github.com/AjuntamentdeBarcelona/decidim-barcelona/blob/743be2a210e8745d2dc443166642b285aed2b356/lib/budgets_workflow_pam2021.rb[decidim-barcelona application itself]. + +You can read more about Worfklows in https://github.com/decidim/decidim/blob/1ab5cd8fdabef48f5be94ff9c30c6bb3bc9a2f8f/decidim-budgets/README.md#budget-workflows[decidim-budgets README.md]. + +NOTE: You only want to have a voting without much complications? Like a city-wide vote? Don't worry: if you define only one +Budget, then people will go there directly when click in the Budgets section. + +== Manage budgets + +image:components/budgets/manage_budgets.png[Manage budgets table] + +This window also lets you see the votes that the various projects have received. (Number of votes) and the total number of votes (*Finished votes* and *Pending votes*, that is, that a participant has started voting but has still not cast their vote). + +=== Export all + +Allows to export the projects for this budget in different formats. + +* Projects as CSV +* Projects as JSON +* Projects as Excel + +=== New budget form + +image:components/budgets/new_budget.png[New budget form] + + +.New budget form +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|What is the title of this budget. For instance, "District A" + +|Rang d'affichage +|Facultatif +|Which order will it have in relation to the other budgets. Avoir un nombre inférieur signifie un rang d'affichage plus élevé. +For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0", then "Budget b" will be first when ordering. + +|Description +|Facultatif +|What is the description of this budget. + +|Total budget +|Obligatoire +|What is the total amount of money that people will have for assigning. +|=== + +==== Actions + + +.Actions +|=== +|Icône |Nom |Definition + +|image:action_preview.png[Preview icon] +|Preview +|Pour voir comment il est montré dans le frontend aux participants. + +|image:action_list.png[Gérer l'icône des projets] +|xref:_manage_projects[Gérer les projets] +|Vous permet de gérer les projets d'un budget. + +|image:action_edit.png[Edit icon] +|Edit +|Modifier un budget. C'est le même formulaire que "Nouveau budget". + +|image:action_delete.png[Delete icon] +|Delete +|Pour supprimer le budget. Peut être fait unquement quand il n'y a pas de projets dans ce budget. +|=== + +==== Gérer les projets + +===== Importer des propositions dans des projets + +Selon votre concertation, vous pourriez vouloir avoir une première étape pendant laquelle les participants créent des propositions, puis ces propositions sont sélectionnés (par le vote ou par une revue technique), enfin vous pouvez importer ces propositions et les convertir en projets. + +Pour que cela fonctionne : + +. Les paramètres suivants doivent être activés dans la fonctionnalité de propositions : +.. Réponses aux propositions activées +.. Activer les coûts sur les réponses aux propositions +. Un évaluateur ou un administrateur doit répondre aux propositions : +.. Relire les propositions +.. Acceptez ou rejetez les en fonction de votre règlement +.. Ajouter des coûts aux propositions si elles ont été acceptées +. Un administrateur peut importer des propositions vers des projets + +image:components/budgets/import_proposals.png[Importer des propositions dans les projets] + +===== Export all + +Allows to export the projects for this budget in different formats. + +* Projects as CSV +* Projects as JSON +* Projects as Excel + +===== Formulaire de création d'un projet + +image:components/budgets/new_project.png[Nouveau formulaire de projet pour un budget] + + +.Formulaire de création d'un projet +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|Le titre pour ce projet. + +|Description +|Obligatoire +|Une description de l'objet de ce projet. + +|Montant du budget +|Obligatoire +|Le montant du budget pour ce projet. Combien coûte la mise en œuvre de ce projet ? + +|Catégorie +|Facultatif +|La catégorie du projet. Utilisé pour les filtres dans la liste des projets. + +|Propositions +|Facultatif +|Choisissez des propositions liées à ce projet. Auto-assignation lors de l'importation des propositions. + +|Ajouter une galerie d'images +|Facultatif +|Ajoutez plusieurs images illustrant en quoi consiste ce projet, ou où il sera implémenté. +|=== + +===== Actions + + +.Actions +|=== +|Icône |Nom |Definition + +|image:action_preview.png[Preview icon] +|Preview +|Pour voir comment il est montré dans le frontend aux participants. + +|image:action_edit.png[Edit icon] +|Edit +|Modifier un projet. C'est le même formulaire que "Nouveau projet". + +|image:action_folder.png[Icône des dossiers] +|Dossiers +|For classifying Attachments. + +|image:action_attachments.png[Attachments icon] +|Attachments +|Documents liés au projet. + +|image:action_delete.png[Delete icon] +|Delete +|Pour supprimer le projet. +|=== + +== Results + +After the voting step has finished, then an administrator need to: + +. Change the Voting configuration for the Budget component to "Voting finished" +. Go to the Budgets and view the results +. On the projects that according to the normative have been selected, they will need to go to each project, edit it and +then check the "Selected for implementation". + +image:components/budgets/results_unselected.png[Unselected projects after voting] +image:components/budgets/results_select_project.png[Select a project for implementation] +image:components/budgets/results_selected.png[Selected projects after voting] +image:components/budgets/results_selected_frontend.png[Selected projects after voting in the frontend] + +We strongly recommend that after you have selected projects then you enable the xref:components/accountability.adoc[Accountability] +component so participants can see the grade of impementation. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/components/meetings.adoc b/docs/fr/modules/admin/pages/components/meetings.adoc new file mode 100644 index 0000000000..e0482056c3 --- /dev/null +++ b/docs/fr/modules/admin/pages/components/meetings.adoc @@ -0,0 +1,411 @@ += Meetings + +Meetings are where people come together to discuss or inform about a given topic. All the meetings have a given location +(where the meeting will happen) and start and end date and time (when the meeting will happen). + +Some examples of where this component was used are: + +* https://www.decidim.barcelona/processes/PAM2020/f/3734/[Procés participatiu del Programa d'Actuació Municipal (PAM) 2020-2023] +in https://www.decidim.barcelona/[Decidim Barcelona] +* https://lejourdapres.parlement-ouvert.fr/processes/ateliers/f/14/[Les ateliers] in https://lejourdapres.parlement-ouvert.fr/[Le jour d'après] + +image:components/meetings/example01.png[Meetings list in Decidim Barcelona] +image:components/meetings/example02.png[Example meeting detail 01 in Decidim Barcelona] +image:components/meetings/example03.png[Example meeting detail 02 in Decidim Barcelona] +image:components/meetings/example04.png[Meetings list in Le jour d'après] + +== Types + +Regarding the *location*, depending on the configuration of the component, you can have: + +* In-person meetings: where you get together in a given location +* Online meetings: where you get together using an external service (for instance Jitsi Meet) + +Depending in the *author* (who's the person that's making the call): + +* Official meetings: meetings created by the organization (created by an administrator through the panel) +* Citizens meetings: meetings created by a User participant (a User or an UserGroup). + +== Add the component + +image:components/meetings/component.png[Add a meetings component] + +For adding the component, you need to: + +. Sign in as admin +. Go to admin panel +. Dans la barre latérale principale, cliquez sur le bouton de l'espace dont vous voulez configurer la fonctionnalité. +For instance, it could be "Processes", "Assemblies", or "Conferences" +. Aller dans les fonctionnalités +. Cliquez sur le bouton "Ajouter une fonctionnalité" +. Click on "Meetings" +. Remplissez le formulaire xref:_add_component[Ajouter une fonctionnalité] + +== Ajouter une fonctionnalité + +For configuring the meeting component you have these settings: + + +.Add component - Meetings form +|=== +|Champ |Type |Description + +|Nom +|Obligatoire +|What is the name of this component. + +|Rang d'affichage +|Facultatif +|Which order will it have in relation with the other components. Avoir un nombre inférieur signifie un rang d'affichage plus élevé. For instance, +if you have two components, "Proposals" with weight "10" and "Meetiings" with weight "0", then "Meetings" will be first when ordering. +|=== + + +.Add component - Meetings form: Global settings +|=== +|Champ |Type |Description + +|Scopes enabled +|Facultatif +|Check if you want to have Scopes filtering in this process. + +|Secteur +|Facultatif +|Which scope will be used for this component. + +|Annonce +|Facultatif +|A general announcement that'll be visible in the general meetings list. + +|Default registration terms +|Facultatif +|What'll be the registration terms of service that the participant would need to accept when registering. + +|Commentaires activés +|Facultatif +|Si vous voulez avoir des commentaires dans les rencontres. + +|Longueur maximale des commentaires +|Facultatif +|Quelle est la limite de caractères que les participants auront quand ils feront des commentaires. Laisser 0 pour la valeur par défaut. + +|Registration code enabled +|Facultatif +|Check if you want to give registration codes to participants. Learn more in xref:components/meetings/registrations.adoc[Registrations]. + +|Actions permissions can be set for each meeting +|Facultatif +|If you want more granular permissions inside of every one of the Meetings. + +|Enable pads creation +|Facultatif +|If you want an Etherpad embedded in your meetings. Must have the xref:services:etherpad.adoc[Etherpad] integration configurated. + +|Participants can create meetings +|Facultatif +|Allows participants to create new meetings. See xref:_citizens_meetings[Citizens meetings] + +|Maps enabled +|Facultatif +|Wheter you want to show a map in the meetings in the meeting detail. +|=== + + +.Add component - Meetings form: Step settings +|=== +|Champ |Type |Description + +|Annonce +|Facultatif +|A general announcement that'll be visible in the general meetings list. + +|Commentaires activés +|Facultatif +|Si vous voulez avoir des commentaires dans les rencontres. +|=== + +== Create a new meeting + +=== Citizens meetings + +Meetings can be created by participants if the setting is "Participants can create meetings" is checked. + +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create meetings as that group also. + +image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)] +image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form (frontend)] + + +.Create meeting - Frontend form +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|What is the title for this meeting. + +|Description +|Obligatoire +|A description of what will be discussed in this meeting, like the topics. + +|Type +|Obligatoire +|Choose one option between "In person", "Online" or "Booth" + +|Address +|Required if meeting type is "In person" or "Booth" +|Address: used by Geocoder to find the location + +|Location +|Obligatoire +|Location: message directed to the users implying the spot to meet at + +|Location hints +|Facultatif +|Location hints: additional info. Example: the floor of the building + +|Online meeting URL +|Facultatif +|Which URL will the meeting be held. + +|Show embedded iframe for this URL +|Facultatif +|Whether or not embed the iframe for this videoconference URL. Only a few services allow embedding (i.e. YouTube, Twitch...) + +|Start Time +|Obligatoire +|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii + +|End Time +|Obligatoire +|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii + +|Catégorie +|Facultatif +|Which Category has the meeting. Used for filtering in the meetings list. + +|Registration type +|Obligatoire +|Choose one option between "Registration disabled", "On this platform", or "On a different platform" + +|Available slots for this meeting +|Required if "Registration type" is "On this platform" +|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available + +|Registration terms +|Required if "Registration type" is "On this platform" +|What terms of services participants need to accept to register or join the meeting. Specific to "Citizens meetings" + +|Registration URL +|Required if "Registration type" is "On a different platform" +|Must be an URL. Link to go on the external service that you are using for registrations. + +|Create meeting as +|Required if the participant belongs to a group +|With which identity they want to create this meeting: as their user or as a group that they are reprensenting? +|=== + +After creating the meeting, participants can also edit and xref:components/meetings/close.adoc[close] it. + +=== Official meetings + +image:components/meetings/new_meeting_form_backend.png[Create a new meeting form (backend)] + + +.Create meeting - Backend form +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|What is the title for this meeting. + +|Description +|Obligatoire +|A description of what will be discussed in this meeting, like the topics. + +|Type +|Obligatoire +|Choose one option between "In person", "Online" or "Booth" + +|Address +|Required if meeting type is "In person" or "Booth" +|Address: used by Geocoder to find the location + +|Location +|Obligatoire +|Location: message directed to the users implying the spot to meet at + +|Location hints +|Facultatif +|Location hints: additional info. Example: the floor of the building + +|Online meeting URL +|Facultatif +|Which URL will the meeting be held. + +|Show embedded iframe for this URL +|Facultatif +|Whether or not embed the iframe for this videoconference URL. Only a few services allow embedding (i.e. YouTube, Twitch...) + +|Start Time +|Obligatoire +|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii + +|End Time +|Obligatoire +|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii + +|Catégorie +|Facultatif +|Which Category has the meeting. Used for filtering in the meetings list. + +|Registration type +|Obligatoire +|Choose one option between "Registration disabled", "On this platform", or "On a different platform" + +|Available slots for this meeting +|Required if "Registration type" is "On this platform" +|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available + +|Registration URL +|Required if "Registration type" is "On a different platform" +|Must be an URL. Link to go on the external service that you are using for registrations. + +|Private meeting +|Facultatif +|Check if the meeting shouldn't be visible for all the visitors. Specific to "Official meetings". + +|Transparent +|Facultatif +|Related to "Private meeting", check if the meeting should be visible for all the visitors but they shouldn't be able to +participate in. Specific to "Official meetings". Specific to "Official meetings". + +|Customize registration email +|Facultatif +|Wheter you want to add a message in the registration email. Specific to "Official meetings". + +|Registration email custom content +|Required if "Customize registration email" is checked +|The content of the customized email. This text will appear in the middle of the registration confirmation email. Just +after the registration code. Specific to "Official meetings". +|=== + +You can also define *Services* inside of a Meeting. These are metadata that allows to comunicate, for instance, if there's +a place for children, deaf assistance, translations, etc. You can have multiple services inside of a meeting. + + +.Create meeting - Services +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|Title of the service. + +|Description +|Facultatif +|Description of the service. +|=== + +== Actions + +=== Citizens meetings + + +.Actions - Citizens meetings +|=== +|Icône |Nom |Definition + +|image:action_preview.png[Preview icon] +|Preview +|Pour voir comment il est montré dans le frontend aux participants. + +|image:action_permissions.png[Permissions icon] +|Autorisations +|To handle the permissions of this meeting, depending on the verification a participant has. Allows an admin to configure +who can *Join* a meeting. +|=== + +=== Official meetings + + +.Actions - Official meetings +|=== +|Icône |Nom |Definition + +|image:action_publish.png[Publish icon] +|Publish +|To show publicly the meeting. + +|image:action_publish.png[Unpublish icon] +|Unpublish +|To not show publicly the meeting. + +|image:action_preview.png[Preview icon] +|Preview +|Pour voir comment il est montré dans le frontend aux participants. + +|image:action_duplicate.png[Duplicate icon] +|Duplicate +|Allows an admin to duplicate a meeting. + +|image:action_registrations.png[Registrations icon] +|xref:admin:components/meetings/registrations.adoc[Registrations] +|Allows to define who can register for attending to the meeting. + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for a Meeting. It's the same form as "Create a new meeting". + +|image:action_agenda.png[Agenda icon] +|xref:admin:components/meetings/agenda.adoc[Agenda] +|To add the topics that will be discussed in the meeting. + +|image:action_list.png[Poll icon] +|xref:admin:components/meetings/polls.adoc[Polls] +|To manage the polls for this online meeting. + +|image:action_close.png[Close icon] +|xref:admin:components/meetings/close.adoc[Close] +|Allows and admin to Close the meeting and add extra information. + +|image:action_folder.png[Icône des dossiers] +|Dossiers +|For classifying Attachments. + +|image:action_attachments.png[Attachments icon] +|Attachments +|Documents that are related to the meeting. + +|image:action_permissions.png[Permissions icon] +|Autorisations +|To handle the permissions of this meeting, depending on the verification a participant has. Allows an admin to configure +who can *Join* a meeting. + +|image:action_delete.png[Delete icon] +|Delete +|To delete this meeting. +|=== + +== Meetings features + +There are different kinds of features that can be enabled in meetings, such as: + +* xref:admin:components/meetings/registrations.adoc[Registrations]: for managing how particpant can register to attend the meeting. +* xref:admin:components/meetings/agenda.adoc[Agenda]: for seeing the topics that will be discussed in the meeting by minutes. +* xref:admin:components/meetings/polls.adoc[Polls]: for quick voting during an online meeting. +* xref:admin:components/meetings/close.adoc[Close]: for adding the final report on what was discussed in the meeting. + +== Online meetings + +Depending in the moment and configuration of the meeting, there could be different messages that will be shown to the participants. + +. If the "Online meeting URL" ins't set, there'll be a message that says "Link available soon" +image:components/meetings/online_meeting_available_soon.png[Online meeting available soon] +. If the "Online meeting URL" is set, and a few minutes before the meeting start, the mesage will say "The link to join +the meeting will be available a few minutes before it starts" +image:components/meetings/online_meeting_available_before.png[Online meeting available before it starts] +. If the "Online meeting URL" is set, and the start time of the meeting has arrived, then there'll be a message that says +that "the meeting is happening right now", with a link to join the meeting. +image:components/meetings/online_meeting_happening.png[Online meeting available before it starts] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/components/meetings/registrations.adoc b/docs/fr/modules/admin/pages/components/meetings/registrations.adoc new file mode 100644 index 0000000000..bfb094072b --- /dev/null +++ b/docs/fr/modules/admin/pages/components/meetings/registrations.adoc @@ -0,0 +1,105 @@ += Registrations + +Through registrations you can have capacity control of the attendance for a meeting. With this feature for instance you can +limit how many people could attend to the meeting, or you can know before the start of a meeting if you need to find a bigger +room to have the meeting. + +Enabling this feature will add a button so that participants can express their wish to go to the meeting. Depending in how +this feature is configured, then: + +. it's possible to define how many slots are available for controling the maximum capacity for this meeting +. a xref:_registration_form[custom registration form] for asking information to participants can be configured +. administrators can make xref:_invitations[invitations] to other participants or people that isn't registered in the platform +. it's possible to control attendance to the meeting through xref:_registration_code[registration codes] + +image:components/meetings/registrations/frontend_join_meeting.png[Join a meeting sidebar button] + +Once participants confirm joining a meeting they get asked if they're reprensenting a group and if they want to show publicly that they're attending. + +image:components/meetings/registrations/frontend_confirm.png[Join a meeting confirm modal] + +== Enable registrations for a meeting + +To enable registrations for a meeting: + +. Sign in as admin +. Go to admin panel +. Dans la barre latérale principale, cliquez sur le bouton de l'espace dont vous voulez configurer la fonctionnalité. +For instance, it could be "Processes", "Assemblies", or "Conferences" +. Click on "Meetings" +. Search the meeting that you want to enable registrations for +. Click on the "Edit" button image:action_edit.png[Edit button] +. Change the "Registration type" field to "On this platform" +. Define how many slots are available in "Available slots for this meeting" +. Click on the "Update" button +. Click on the "Registrations" button image:action_registrations.png[Registrations button] +. Check the "Registrations enabled" checkbox +. Remplissez le formulaire + +== Registrations settings form + +image:components/meetings/registrations/backend.png[Registrations settings in a meeting] + + +.Registrations settings form +|=== +|Champ |Type |Description + +|Registrations enabled +|Obligatoire +|Check to enable the registration for this meeting. + +|Registration form enabled +|Facultatif +|Check if you want to enable the registration form + +|Available slots for this meeting +|Obligatoire +|How many slots are available. Leave it to 0 if you have unlimited slots available. + +|Reserved slots +|Obligatoire +|How many slots are already reserved. Leave it to 0 if you don't have reserved slots + +|Registration terms +|Obligatoire +|What terms of services participants need to accept to register or join the meeting. +|=== + +== Registration form + +This feature allows you to define a custom form like the xref:admin:components/surveys.adoc[Surveys] component to ask participants +for registration information. + +== Export all + +It's possible to export registrations in multiple formats: CSV, JSON and XLSX (Excel). + +The exported data will have these fields: + +* id: The registration id +* code: the xref:_registration_code[registration code] (if this feature is enabled) +* user/name: the name of the user +* user/email: the email of the user +* user/user_group: the group of the user if they have selected that's representing a group when registering + +== Invitations + +This feature allows you to invite attendes to a meeting. These could be already registered or non-existing participants +in the platform. + +image:components/meetings/registrations/invite_attendee.png[Invite attendee for registration in a meeting] + +== Registration code + +This feature allows you to check if the attendee is registered in the meeting. They need to provide their code, that gets +entered in this form and it's checked against the database. + +image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting] + +image:components/meetings/registrations/frontend_confirmed_w_code.png[Registration code in a meeting frontend] + +It can receive two kind of responses: + +* Registration code successfully validated. +* This registration code is invalid. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/components/proposals.adoc b/docs/fr/modules/admin/pages/components/proposals.adoc new file mode 100644 index 0000000000..6fbab92cff --- /dev/null +++ b/docs/fr/modules/admin/pages/components/proposals.adoc @@ -0,0 +1,445 @@ += Propositions + +The Proposals component allows people to create, comment, endorse, and give support to proposals. + +From this starting point, there could be other configurations, such as: + +* combien de propositions un participant peut créer +* le nombre maximum de votes qu'un participant peut attribuer aux propositions +* how many supports as a minimum a participant must give to proposals so their supports are valid +* whether you want to enable that participants comment on proposals +* whether you want that proposals have images, attachments, WYSIWYG editor, geolocated address, scopes, etc. + +Some examples of where this component was used: + +* https://futureu.europa.eu/[Conference of the Future of Europe] +* https://meta.decidim.org/processes/roadmap/f/122/[Propose new functionalities for Decidim software] in https://meta.decidim.org/[Metadecidim] + +image:components/proposals/example01.png[Proposals list example in COFE] +image:components/proposals/example02.png[Proposals list example in Metadecidim] +image:components/proposals/example03.png[Proposal detail example in Metadecidim] + +Pour configurer la fonctionnalité Propositions : + +. Sign in as admin +. Go to admin panel +. Dans la barre latérale principale, cliquez sur le bouton de l'espace dont vous voulez configurer la fonctionnalité. +For instance, it could be "Processes", "Assemblies", or "Conferences" +. Aller dans les fonctionnalités +. Cliquez sur le bouton "Ajouter une fonctionnalité" +. Cliquer sur "Propositions" +. Remplissez le formulaire xref:_add_component[Ajouter une fonctionnalité] + +== Ajouter une fonctionnalité + +image:components/proposals/component.png[Add component form] + + +.Add component: Proposals form +|=== +|Champ |Type |Description + +|Nom +|Obligatoire +|Quel est le titre de cette fonctionnalité. Par exemple, "Proposions" + +|Rang d'affichage +|Facultatif +|Which order will it have in relation to the other components. Avoir un nombre inférieur signifie un rang d'affichage plus élevé. +For instance, if you have two components, "Proposals" with weight "10" and "Meetings" with weight "0", then "Meetings" will be first when ordering. +|=== + + +.Add component: Proposals form - Global settings +|=== +|Champ |Type |Description + +|Scopes enabled +|Facultatif +|Check if you want to have Scopes filtering in this component. + +|Secteur +|Facultatif +|Which xref:admin:scopes.adoc[Scope] does this component belongs to. + +|Limite de votes par utilisateur +|Facultatif +|Must be a number. How much supports a participant can give to proposals. + +|Nombre minimum de votes par utilisateur +|Facultatif +|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If they don't +reach this number, their supports will not be taken in account. + +|Limite de proposition par participant +|Facultatif +|Must be a number. Combien de propositions un participant peut créer. + +|Longueur maximale du corps de la proposition +|Facultatif +|Must be a number. How many characters a proposal body can have as maximum. + +|Proposal editing +|Obligatoire +|Choose one of these two options: "Allow editing of proposals within a specific timeframe" or "Allow editing proposals +for an infinite amount of time". In case it's within a specific timeframe, you must specify the time in "Proposals can be +edited by authors before this many minutes passes". Note that if you xref:components/proposals/answers.adoc[answer a proposal] +then it can't be edited anymore. + +|Délai (en minutes) après lequel les auteurs ne peuvent plus modifier leurs propositions +|Required if "Proposal editing" is "Allow editing of proposals within a specific timeframe" +|Must be a number. How many minutes after the creation of a proposal it can be edited by its author. + +|Seuil par proposition +|Facultatif +|Must be a number. Combien de votes une proposition doit avoir pour être considérée comme "acceptée". See <>. + +|Peut accumuler des supports au-delà du seuil +|Facultatif. Ne s'applique que si "Seuil par proposition" est configuré. +|Whether the proposal can accumulate more supports than the threshold. + +|Réponses aux propositions activées +|Facultatif +|Whether administrators or valuators can answer proposals. + +|Propositions officielles activées +|Facultatif +|Wheter administrators can create official proposals. + +|Commentaires activés +|Facultatif +|Si vous voulez avoir des commentaires dans les rencontres. + +|Longueur maximale des commentaires +|Facultatif +|What are the characters limit that participants will have when making comments. Leave 0 for the default value. + +|Géocodage activé +|Facultatif +|Wheter participants can define a geocoding address for their proposals. Need to have xref:configure:geocoding[Geocoding] enabled. See <>. + +|Allow attachments +|Facultatif +|Check to allow participants to attach files to their proposals. + +|Allow card image +|Facultatif +|Check to show a card image when participants attach images to their proposals. See <>. + +|Actions permissions can be set for each proposal +|Facultatif +|Whether you want to be able to set permissions for every one of the proposals. Most of the time you will want to leave this option disabled. + +|Collaborative drafts enabled +|Facultatif +|Check to enable xref:components/proposals/collaborative_drafts.adoc[collaborative drafts] in proposals. + +|Participatory texts enabled +|Facultatif +|Check to enable xref:components/proposals/participatory_texts.adoc[participatory texts] in proposals. + +|Amendments enabled +|Facultatif +|Check to enable xref:components/proposals/amendments.adoc[amendments] in proposals. If active, configure Amendment features for each step. + +|Amendments Wizard help text +|Facultatif. Visible if the "Amendments enabled" option is checked. +|What's the help text visible when creating new amendments. + +|Annonce +|Facultatif +|A general announcement that'll be visible on the general proposals landing page. + +|New proposal body template +|Facultatif +|A pre-defined text that will be used when creating new proposals. Useful if you want to define a format that participants need to +follow when creating new proposals. + +|New proposal help text +|Facultatif +|What's the help text visible when creating new proposals. + +|Proposal wizard "Create" step help text +|Facultatif +|What's the help text visible when creating new proposals in the "Create" step. + +|Proposal wizard "Compare" step help text +|Facultatif +|What's the help text visible when creating new proposals in the "Compare" step. + +|Proposal wizard "Complete" step help text +|Facultatif +|What's the help text visible when creating new proposals in the "Complete" step. + +|Proposal wizard "Publish" step help text +|Facultatif +|What's the help text visible when creating new proposals in the "Publish" step. +|=== + +[#setting-threshold] +*Example of threshold setting* + +image::components/proposals/setting_threshold01.png[Example of threshold setting] + +image::components/proposals/setting_threshold02.png[Example of threshold setting] + +[#setting-card-image] +*Example of card image setting* + +image::components/proposals/setting_card_image.png[Example of card image setting] + +[#setting-geocoding] +*Example of geocoding setting* + +image::components/proposals/setting_geocoding.png[Example of geocoding setting] + +--- + +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: Proposals form - Step settings +|=== +|Champ |Type |Description + +|Annonce +|Facultatif +|A general announcement that'll be visible on the general proposal landing page. + +|Soutiens activés +|Facultatif +|Check if you want that participants show public support for these proposals. + +|Soutiens bloqués +|Facultatif +|Whether participants will be able to see the endorsments but don't make any. + +|Activer le module de vote simple +|Facultatif +|Whether participants will be able to support proposals in this step. + +|Bloquer les votes +|Facultatif +|Whether participants will be able to support proposals in this step. + +|Supports hidden +|Facultatif +|If supports are enabled, checking this will hide the number of supports. + +|Commentaires désactivés +|Facultatif +|Whether you want to enable comments for this phase. + +|Proposal creation enabled +|Facultatif +|Whether you want to enable proposal creation by participants for this phase. See xref:_new_proposal_form[New proposal form] + +|Réponses aux propositions activées +|Facultatif +|Whether you want to enable xref:components/proposals/answers.adoc[proposal answering]. + +|Publish proposal answers immediately +|Facultatif +|Wheter you want that the answers of proposals are published at the same time that you're xref:components/proposals/answers.adoc[answering] them or you want to control when to publish the answers. + +|Activer les coûts sur les réponses aux propositions +|Facultatif +|Wheter you want to add economical costs to proposal answers. Useful for importing to xref:components/budgets.adoc[budgets]. + +|Création d'amendement activée +|Facultatif. Visible si l'option "Amendements activés" est cochée. +|Participant can amend proposals. See xref:components/proposals/amendments.adoc[Amendments]. + +|Amendment reaction enabled +|Facultatif. Visible si l'option "Amendements activés" est cochée. +|Proposal's authors will be able to accept or reject Participant's emendations. + +|Amendment promotion enabled +|Facultatif. Visible si l'option "Amendements activés" est cochée. +|Emandation authors will be able to promote to Proposal the rejected emendation. + +|Amendments visibility +|Required. Visible si l'option "Amendements activés" est cochée. +|Choose one of "Amendments are visible to all" or "Amendments are visible only to their authors" + +|Annonce +|Facultatif +|A general announcement that'll be visible on the general proposals landing page. + +|Hashtags added to all proposals +|Facultatif +|Automatically add a hashtag to every proposal. See <>. + +|Hashtags suggested to participants for new proposals +|Facultatif +|Suggest hashtags to participants for new proposals. Participants can select more than one hashtag. See <>. +|=== + +[#setting-hashtags] +*Example of hashtags setting* + +image::components/proposals/setting_hashtag.png[Example of hashtag setting] + +== Autorisations + +An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make +certain actions in the proposals: + +* Soutenir +* Support +* Create +* Withdraw +* Amend +* Commenter +* Vote comment + +== Manage proposals + +image:components/proposals/manage_proposals.png[Manage proposals table] + +=== Export + +Allows exporting the proposals in different formats. + +* Proposals as CSV +* Proposals as JSON +* Proposals as Excel +* Comments as CSV +* Comments as JSON +* Comments as Excel + +=== Import + +* Import from another component +* Import from a file + +=== New proposal form + +==== Citizens proposals + +image:components/proposals/new_proposal_frontend.png[New proposal form] + +Proposals can be created by participants if the setting is "Proposal creation enabled" is checked for the active phase. + +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create proposals as that group also. + +This form depends a lot in which settings you've enabled in this component. It can be really short (with only a Title and +Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, Image and Attachment). + + +.New proposal form - default (by a participant) +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|What is the title of this proposal. For instance, "Bike lane in Main Street". Must have at least 15 characters as minimum +and 150 characters as maximum. Must start with a capital letter. + +|Body +|Facultatif +|What is the full description for this proposal. Must have at least 15 characters as minimum and 450 characters as maximum +by default but can be changed with the setting "Maximum proposal body length". +|=== + +To detect duplicated proposals before publishing them, the proposal creation has a wizard form with multiple steps. This also +allows participants to save proposals drafts (unpublished) in case they need to fill too many fields. + +image:components/proposals/new_proposal_frontend_compare.png[New proposal form (by a participant) - Compare] + +As an example of what the form could look depending in the settings enabled, here's a screenshot of the form for a proposal +with the following settings: "Hashtags added to all proposals", "Hashtags suggested to participants for new proposals", +"Geocoding enabled", "Allow attachments", "Allow card image" and "Scopes enabled". + +image:components/proposals/new_proposal_frontend_complete.png[New proposal form (by a participant) - Complete] + +After completing these fields the participant can see a preview of their proposal before publishing. They can also modify +the proposal before publishing it. + +image:components/proposals/new_proposal_frontend_publish.png[New proposal form (by a participant) - Publish] + +image:components/proposals/new_proposal_frontend_published.png[Published proposal made by a participant] + +==== Official proposals + +Administrators can create official proposals. There will be a filter to show only official proposals in the proposals navigation page. + +image:components/proposals/new_proposal_backend01.png[New proposal form - default (official proposals)] + + +.New proposal form - default (official proposals) +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|What is the title of this proposal. For instance, "Bike lane in Main Street". Must have at least 15 characters as minimum +and 150 characters as maximum. Must start with a capital letter. + +|Body +|Facultatif +|What is the full description of this proposal. Must have at least 15 characters as minimum and 450 characters as maximum +by default but can be changed with the setting "Maximum proposal body length". + +|This proposal comes from a meeting +|Facultatif +|Check if this proposal comes from a meeting. + +|Select a meeting +|Required if the "This proposal comes from a meeting" checkbox is checked +|Dropdown selector with all the meetings of this space. The author of the proposal will be the meeting. +|=== + +As an example of what the form could look like depending on the settings enabled, here's a screenshot of the form for a proposal +with the following settings: "Hashtags added to all proposals", "Hashtags suggested to participants for new proposals", +"Geocoding enabled", "Allow attachments", "Allow card image" and "Scopes enabled". + +image:components/proposals/new_proposal_backend02.png[New proposal form - with multiple settings (official proposals)] + +==== Actions + + +.Actions +|=== +|Icône |Nom |Definition + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for a proposal. It's the same form as "New proposal". Only visible when the proposal is an xref:_official_proposals["Official proposal"]. + +|image:action_answer.png[Answer proposal icon] +|xref:components/proposals/answers.adoc[Answer proposal] +|Allows you to answer a proposal. + +|image:action_permissions.png[Permissions icon] +|Autorisations +| + +|image:action_preview.png[Preview icon] +|Preview +|Pour voir comment il est montré dans le frontend aux participants. +|=== + +== Origin filter + +When navigating in the proposals listing, you can filter the proposals by origin. + +image:components/proposals/origin_filter.png[Proposals origin filter] + +There are five origin options: + +* All: select all the origins +* xref:_official_proposals[Official]: proposals created by administrators +* xref:_citizens_proposals[Citizens]: proposals created by participants +* Groups: proposals created by participants that belong to a user group and choose that option when creating the proposal +* Meetings: proposals created by administrators that have checked this option when creating the proposal + +== Proposal types and mechanisms + +There are different kind of proposals mechanisms that can be enabled in proposals, such as: + +* xref:admin:components/proposals/amendments.adoc[Amendments] +* xref:admin:components/proposals/answers.adoc[Answers] +* xref:admin:components/proposals/collaborative_drafts.adoc[Collaborative drafts] +* xref:admin:components/proposals/participatory_texts.adoc[Participatory texts] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/components/proposals/amendments.adoc b/docs/fr/modules/admin/pages/components/proposals/amendments.adoc new file mode 100644 index 0000000000..c5c1406b69 --- /dev/null +++ b/docs/fr/modules/admin/pages/components/proposals/amendments.adoc @@ -0,0 +1,93 @@ += Amendements + +Grâce à la fonctionnalité d'amendement, les participants peuvent proposer des modifications à une proposition déjà publiée. + +Il est utile de proposer des améliorations ou des corrections, particulièrement utile lors de la rédaction de lois ou autre avec xref:components/propositions/participatory_texts.adoc[Textes participatifs]. + +Il y a des similitudes avec les xref:components/proposals/collaborative_drafts. doc[Brouillons collaboratifs], mais la principale différence +est qu'avec les amendements chaque changement est relu et doit être +approuvé par l'auteur de la proposition. + +image:composents/propositions/amendements/amendement.png[Amendement d'une proposition] + +Pour configurer les "Amendements" dans le module de propositions: + +. Sign in as admin +. Go to admin panel +. Dans la barre latérale principale, cliquez sur le bouton de l'espace dont vous voulez configurer la fonctionnalité. +For instance, it could be "Processes", "Assemblies", or "Conferences" +. Aller dans les fonctionnalités +. Cliquez sur le bouton "Ajouter une fonctionnalité" +. Cliquer sur "Propositions" +. Cochez la case de configuration "Amendements activés" +. Examinez et configurez les paramètres de configuration suivants : "Texte d'aide de l'assistant" dans les paramètres globaux des composants et "Création d'amendement activée","Réaction aux amendements activée", "Promotion d'amendement activée" et "Visibilité des amendements" dans les paramètres du composant d'étape. +. Enregistrez le composant + +== Comment ça marche + +. Une participante (Alice) a créé une proposition +. Un autre participant (Bob) a vu la proposition et veut apporter des modifications +image:composents/propositions/amendements/proposal_to_amende.png[Proposition à amender] +. Bob clique sur le bouton "Amender" +. Bob fait les modifications dans le formulaire "Créer un brouillon d'amendement" +image:composents/propositions/amendements/create_amendement_draft.png[] +. Bob vérifie qu'il n'y ait pas d'amendement similaire +. Bob modifie le brouillon d'amendement +image:components/proposs/amendements/edit_amendement_draft.png[] +. Bob publie le brouillon d'amendement +image:components/proposs/amendements/publish_amendement_draft.png[] +. Tout le monde peut voir la proposition d'amendement +image:components/proposals/amendements/amendements/amendemed.png[] +image:components/proposals/amendements/amendements/amendement_list.png[] +image:components/proposals/amendements/amendements/amendement_view_side_by_side.png[] +. Il est également possible de filtrer les propositions amendées +image:composents/propositions/amendements/amendement_list_filter.png[] +. Alice receives a notification that Bob has proposed an amendment to their original proposal +image:components/proposals/amendments/proposal_amendmed_notification.png[] +. Alice peut voir la proposition d'amendement +image:components/proposs/amendements/proposal_amendemed_to_review.png[] +. Alice peut examiner la proposition d'amendement +image:components/proposs/amendements/proposal_amendemed_review.png[] +. Alice peut approuver la proposition d'amendement +image:components/proposs/amendements/proposal_amendemed_accepted.png[] +. Tout le monde peut voir la proposition finale +image:components/proposs/amendements/amendements/proposal_amendemed_final.png[] +image:components/proposals/amendements/amendement_amendement_list.png[] +. Tout le monde peut voir l'historique des versions de la proposition +image:composents/propositions/amendements/proposal_amendemed_versions.png[] + +== Paramètres pertinents du composant + + +.Formulaire du module Propositions - Paramètres liés aux amendements +|=== +|Champ |Type |Description + +|Amendments enabled +|Global +|Check to enable xref:components/proposals/amendments.adoc[amendments] in proposals. Autres paramètres visibles en activant un. + +|Amendments Wizard help text +|Global +|What's the help text visible when creating new amendments. + +|Création d'amendement activée +|Étape +|Participant can amend proposals. See xref:components/proposals/amendments.adoc[Amendments]. + +|Amendment reaction enabled +|Étape +|Proposal's authors will be able to accept or reject Participant's emendations. + +|Amendment promotion enabled +|Étape +|Emandation authors will be able to promote to Proposal the rejected emendation. + +|Amendments visibility +|Étape +|Choose one of "Amendments are visible to all" or "Amendments are visible only to their authors" +|=== + +== Promotion + +Si une proposition est rejetée et que la fonction "Promotion d'amendements activée" est activée, alors l'auteur de l'amendement rejeté pourra le promouvoir en tant que nouvelle proposition. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/components/proposals/collaborative_drafts.adoc b/docs/fr/modules/admin/pages/components/proposals/collaborative_drafts.adoc new file mode 100644 index 0000000000..c08a151c44 --- /dev/null +++ b/docs/fr/modules/admin/pages/components/proposals/collaborative_drafts.adoc @@ -0,0 +1,70 @@ += Collaborative draft + +With the collaborative draft feature participants can make a proposal with multiple authors. + +It's useful to propose improvements or corrections. + +It has similarities with xref:components/proposals/amendments.adoc[Amendments] but the main difference is that with collaborative +drafts there is a need to trust other authors, as they can make any change to the original proposal without approval by the +original author, although the original author can decide if they promote the collaborative draft as a proposal. + +image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[Collaborative draft with request access button] + +To configure "Collaborative Drafts" in Proposals component: + +. Sign in as admin +. Go to admin panel +. Dans la barre latérale principale, cliquez sur le bouton de l'espace dont vous voulez configurer la fonctionnalité. +For instance, it could be "Processes", "Assemblies", or "Conferences" +. Aller dans les fonctionnalités +. Cliquez sur le bouton "Ajouter une fonctionnalité" +. Cliquer sur "Propositions" +. Check the "Collaborative drafts enabled" setting +. Enregistrez le composant + +== Comment ça marche + +. A participant (Alice) wants to create a collaborative draft. For that, they go to the proposals list page. +. Alice clicks in the "Access collaborative drafts" button +image:components/proposals/collaborative_drafts/proposals_list01.png[] +. Alice clicks in "New collaborative draft" button +image:components/proposals/collaborative_drafts/list_empty.png[] +. Alice fills the form and submits it +image:components/proposals/collaborative_drafts/create_form.png[] +. Once the collaborative draft is created, Alice can: edit, withdraw or publish the collaborative draft and approve or +reject collaboration requests +image:components/proposals/collaborative_drafts/collaborative_draft.png[] +. Another participant (Bob) has seen the collaborative draft and wants to make some changes +image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[] +. Bob clicks in the "Request access" button +image:components/proposals/collaborative_drafts/access_requested.png[] +. Alice receives the notification +image:components/proposals/collaborative_drafts/notification.png[] +. Alice goes to the collaborative draft. There they can accept or reject the collaboration request +image:components/proposals/collaborative_drafts/author_sidebar.png[] +. Alice approves the collaboration request. Once a request is approved it can't be rejected +. Now the collaborative draft has multiple authors +image:components/proposals/collaborative_drafts/multiple_authors.png[] +. Bob can edit the collaborative draft by clicking in the "Edit collaborative draft" button +image:components/proposals/collaborative_drafts/edit_collaborative_draft.png[] +image:components/proposals/collaborative_drafts/edit_form.png[] +. Once the collabrative draft is edited, then it's possible to see the old versions and its changes +image:components/proposals/collaborative_drafts/collaborative_draft_edited.png[] +image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions.png[] +image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_01.png[] +image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_02.png[] +. Once Alice is satisfied with the collaborative draft, they can publish it by click in the "Publish" button +image:components/proposals/collaborative_drafts/publish_modal.png[] +. When it's published it becomes a proposal +image:components/proposals/collaborative_drafts/proposal.png[] +image:components/proposals/collaborative_drafts/proposals_list02.png[] +. And the collaborative draft is still visible although it can't be edited anymore +image:components/proposals/collaborative_drafts/collaborative_draft_published.png[] + +== Important aspects + +- A collaborative draft can has any number of authors. +- Only the original author can approve or reject the collaboration requests. +- Only the original author can publish the collaborative draft. +- Only the original author can withdraw the collaborative draft. +- Once a collaboration request is approved, it can't be rejected. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/features/badges.adoc b/docs/fr/modules/admin/pages/features/badges.adoc new file mode 100644 index 0000000000..bf600e7325 --- /dev/null +++ b/docs/fr/modules/admin/pages/features/badges.adoc @@ -0,0 +1,76 @@ += Badges + +Badges are recognitions to participant actions and progress in the platform. As participants start discovering, participating +and interacting in the platform, they will earn different badges. Here is the list of badges and some ways participants can earn them. + +It's a https://en.wikipedia.org/wiki/Gamification[gamification] mechanism to improve the engagement of the participants in a ludic way. + +The badges a participant has are visible in their account. There's also a general explanation page with a short description of every badge. + +image:features/badges/example01.png[Example of badges in profile] + +When a participant earns a badge they receive a notification. + +image:features/badges/notification.png[Example of badges notification] + +Badges have multiple levels, depending in the number of times they have made the action. For instance, for Proposals badge +they will receive the first level badge when arriving at 1 follower, the second level at 15 followers, the third level at 30 followers, +the fourth level at 60 and the fifth level at 100. + + +.Badges +|=== +|Image |Titre |Description |How it's earned |Levels + +|image:features/badges/accepted_proposals_badge.png[Accepted proposals badge] +|Accepted proposals +|Granted when particiapnts actively participate with new proposals and these are accepted. +|The participant needs to choose the participation space of their interest with submission for proposals enabled and try to +make proposals that can be carried out. This way they are more likely to be accepted. +|1, 5, 15, 30, 50 + +|image:features/badges/attended_meetings_badge.png[Attended meetings badge] +|Attended meetings +|Granted when participants attend several face-to-face meetings. +|The participant needs to register for the meetings they want to attend +|1, 3, 5, 10, 30 + +|image:features/badges/debates_badge.png[Debates badge] +|Debates +|Granted when participants actively participate in the different debates by leaving comments. +|The participant needs to take part in debates. +|1, 5, 10, 30, 50 + +|image:features/badges/followers_badge.png[Followers badge] +|Followers +|Granted when participant reach a certain number of followers. The platform is a social and political network, so +participants ned to weave their web to communicate with other people in the platform. +|The participant needs to be be active and follow other people. That will surely make other people follow them. +|1, 15, 30, 60, 100 + +|image:features/badges/published_initiatives_badge.png[Published initiatives badge] +|Published initiatives +|Granted when a participant launch new initiatives, partnering with others to carry them out. +|The participant needs to go to the participation space of Intiatives and follow the steps to create a new initiative. +|1, 5, 15, 30, 50 + +|image:features/badges/invitations_badge.png[invitations badge] +|Invitations +|Granted when participants invite some people and they have become participants. +|The participant needs to use the “invite friends” link on their user page to invite their friends. They can customize the +message they are sending. They will level up by sending invitations and getting them registered. Note that this feature is disabled +and this badge is not available, so it'll be removed in the future. +|1, 5, 10, 30, 50 + +|image:features/badges/proposal_supports_badge.png[Proposal supports badge] +|Proposal supports +|Granted when participants support other people's proposals. +|The participant needs to browse and spend some time reading other people's proposals and give support to the proposals they like or find interesting. +|5, 15, 50, 100, 500 + +|image:features/badges/proposals_badge.png[Proposals badge] +|Propositions +|Granted when participants actively participate with new proposals. +|The participant needs to choose the participation space of their interest with submission for proposals enabled and create a new proposal. +|1, 5, 10, 30, 60 +|=== \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/features/endorsements.adoc b/docs/fr/modules/admin/pages/features/endorsements.adoc new file mode 100644 index 0000000000..90b2f56ab5 --- /dev/null +++ b/docs/fr/modules/admin/pages/features/endorsements.adoc @@ -0,0 +1,17 @@ += Endorsements + +Through endorsements, participants can publicly show that they want to support a particular content, for instance, a proposal. + +image:features/endorsements/list.png[List of endorsements] + +This is done through the button in the sidebar. Administrators can enable or disable them by step in a given participatory process, and they can also define permissions with authorizations. + +image:features/endorsements/sidebar.png[Endorsement button in sidebar] + +When a participant belongs to a verified group they can also endorse like that group by selecting the identity. + +image:features/endorsements/modal.png[Select identity modal] + +By default the endorsements list is collapsed. To see it fully visitors need too click in the "(see more)" link. + +image:features/endorsements/full_list.png[Full list of endorsements] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/features/my_account.adoc b/docs/fr/modules/admin/pages/features/my_account.adoc new file mode 100644 index 0000000000..67c0baefad --- /dev/null +++ b/docs/fr/modules/admin/pages/features/my_account.adoc @@ -0,0 +1,19 @@ += My account + +My account is all the pages where a participant can change their personal data that is displayed in their xref:admin:features/my_public_profile.adoc[My public profile] page, change their notifications settings, see which groups they belong to, etc. + +To go to this section: + +. Sign in as a participant +. Click in the name of the participant in the header +. Click in "My account" + +The actions that they can do are: + +* xref:admin:features/my_account/account.adoc[Account] +* xref:admin:features/my_account/notifications_settings.adoc[Notifications settings] +* xref:admin:features/my_account/authorizations.adoc[Authorizations] +* xref:admin:features/my_account/groups.adoc[Groups] +* xref:admin:features/my_account/my_interests.adoc[My interests] +* xref:admin:features/my_account/my_data.adoc[My data] +* xref:admin:features/my_account/delete_my_account.adoc[Delete my account] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/features/my_account/account.adoc b/docs/fr/modules/admin/pages/features/my_account/account.adoc new file mode 100644 index 0000000000..753209afc5 --- /dev/null +++ b/docs/fr/modules/admin/pages/features/my_account/account.adoc @@ -0,0 +1,47 @@ += Account + +In this section is possible to make modifications that will be visible in the participants xref:features/my_public_profile.adoc[public profile] and also modify the email address or the language that the platform will use with the user. + +. Sign in as a participant +. Click in the name of the participant in the header +. Click in "My account" + +image:features/my_account/account.png[My account form] + + +.Participant settings - My account form +|=== +|Champ |Type |Description + +|Avatar +|Facultatif +|Avatar or picture for the participant. Guidance for image: Preferrably a landscape image that does not have any text. +The service crops the image. Maximum file size: 5MB + +|Your name +|Obligatoire +|The name of the participant. + +|Nickname +|Obligatoire +|The nickname of the participant. + +|Your email +|Obligatoire +|The email of the participant, where they will receive notifications, password recovery, etc. If it's changed it needs to be +confirmed. + +|Personal URL +|Facultatif +|Metadata that is displayed in the participant's profile. + +|About +|Facultatif +|Metadata that is displayed in the participant's profile. + +|Locale +|Obligatoire +|Choose the language you want to use to browse and receive notifications in Decidim +|=== + +From this page is possible to also modify the participant's password. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/features/my_account/delete_my_account.adoc b/docs/fr/modules/admin/pages/features/my_account/delete_my_account.adoc new file mode 100644 index 0000000000..3522a1c183 --- /dev/null +++ b/docs/fr/modules/admin/pages/features/my_account/delete_my_account.adoc @@ -0,0 +1,21 @@ += Delete my account + +In this section participants will be able to delete their own accounts. This means that they will be unable to access the system anymore. This action is irreversible. All the contributions will be anonymized. + +image:features/my_account/delete_my_account.png[Delete my account form] + +To delete the account: + +. Sign in as a participant +. Click in the name of the participant in the header +. Click in "My account" +. Click in "Delete my account" in the sidebar +. Optionally, they can provide a reason for the deletion +. Click in "Delete my account" +. Click in "Yes, I want to delete my account" + +image:features/my_account/delete_my_account_confirm.png[Confirm account deletion] + +After the account has been deleted, the contributions (such as comments, proposals, etc), will be still visible but all the authorship information will be anonymized, belonging to an special kind of author called "Participant deleted": + +image:features/my_account/delete_my_account_deleted.png[Deleted participant contribution] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/features/notifications.adoc b/docs/fr/modules/admin/pages/features/notifications.adoc new file mode 100644 index 0000000000..878bc0c236 --- /dev/null +++ b/docs/fr/modules/admin/pages/features/notifications.adoc @@ -0,0 +1,230 @@ += Notifications + +== The notification menu + +Most of the actions in the platform generate notifications so particpants can know when there are new things to watch. + +This is accessible from the `Notifications` menu item (image:icon_bell.png[Notification icon]) in the header, after a participant has logged in. + +To see the notifications: + +. Sign in as participant +. Click in the notifications icon in the header + +If there are notifications, then the participant will see the icon with a color image:icon_bell_on.png[Notification icon with color] + +image:features/notifications/notifications.png[Example of notifications page when there are notifications] + +image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] + +== Notifications list + +Below is an exhaustive list of actions that trigger notifications to participants. Participants are divided into three categories: affected users, followers, and administrators. + +[NOTE] +==== +Affected users depend on the notification context. For instance, it could be the author of moderated content, a user that earns a badge, a user that has been mentioned, etc. +==== + +[cols="7,2,1,1,1"] +|=== +|Action |Feature |Affected user |Follower |Administrator + +|A new attachment has been created |Administration |❌ |✅ |❌ + +|An admin requested an export |Administration |❌ |❌ |✅ + +|A component has been published in a participatory space |Administration |❌ |✅ |❌ + +|A participant has tried to verify themself with the data of another participant |Verifications |❌ |❌ |✅ + +|An administrator moderated a resource because it has been reported |Moderation |✅ |❌ |❌ + +|A resource has been reported |Moderation |❌ |❌ |✅ + +|A user confirms the registration (if welcome notification is enabled) |User |✅ |❌ |❌ + +|A user earned a badge (if badges are enabled) |User |✅ |❌ |❌ + +|A user has reached a new badge level (if badges are enabled) |User |✅ |❌ |❌ + +|A user has been officialized |User |❌ |❌ |✅ + +|A user asked their data export |User |✅ |❌ |❌ + +|A user I follow endorsed a resource |User |❌ |✅ |❌ + +|A public profile has been updated |User |❌ |✅ |❌ + +|A new user group has been created |User groupsfootnote:user-group[If user groups are enabled] |❌ |❌ |✅ + +|A user group has updated its profile |User groupsfootnote:user-group[] |❌ |❌ |✅ + +|A user has been invited to join a user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user has been promoted as group admin |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user requested to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request has been accepted to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request to join the user group has been rejected |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The group admin has been demoted |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The user has been removed from the group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|An admin of the assembly has added you as one of its members |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the assembly |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the participatory process |Processes |✅ |❌ |❌ + +|The phases dates have been updated |Processes |❌ |✅ |❌ + +|A new phase has been activated |Processes |❌ |✅ |❌ + +|You have been assigned a role for the conference |Conferences |✅ |❌ |❌ + +|The registration to the conference has been confirmed |Conferences |✅ |❌ |❌ + +|The registration for the conference is open |Conferences |❌ |✅ |❌ + +|The conference occupied slots are over X% |Conferences |❌ |❌ |✅ + +|The conference is taking place in 2 days |Conferences |❌ |✅ |❌ + +|The conference has been updated |Conferences |❌ |✅ |❌ + +|The election is now active for the participatory space |Elections |❌ |✅ |❌ + +|You are added as a trustee for the election |Elections |✅ |❌ |❌ + +|An admin has added you as trustee |Elections |✅ |❌ |❌ + +|Your vote was accepted |Elections |✅ |❌ |❌ + +|You have been assigned a role of the Polling Station |Elections |✅ |❌ |❌ + +|Here is your Access Code |Elections |✅ |❌ |❌ + +|A user I follow created an initiative |Initiatives |❌ |✅ |❌ + +|My initiative has been created |Initiatives |✅ |❌ |❌ + +|A user I follow endorsed an initiative |Initiatives |❌ |✅ |❌ + +|A user sent their initiative to technical validation |Initiatives |❌ |❌ |✅ + +|The initiative has changed its status |Initiatives |✅ |✅ |❌ + +|The signatures end date for the initiative have been extended |Initiatives |❌ |✅ |❌ + +|The request to be part of the promoter committee for the initiative has been accepted |Initiatives |✅ |❌ |❌ + +|The request to be part of the promoter committee for the initiative has been rejected |Initiatives |✅ |❌ |❌ + +|A user wants to join your initiative |Initiatives |✅ |❌ |❌ + +|The initiative has reached the signatures threshold |Initiatives |❌ |❌ |✅ + +|Your initiative has achieved the X% of signatures |Initiatives |❌ |✅ |❌ + +|The initiative has achieved the X% of signatures |Initiatives |✅ |❌ |❌ + +|The proposal has been included in a result |Suivi des réalisations |❌ |✅ |❌ + +|The result progress has been updated |Suivi des réalisations |❌ |✅ |❌ + +|A post has been published |Blogs |❌ |✅ |❌ + +|The budget is now active |Budgets |❌ |✅ |❌ + +|A resource has a comment |Comments |❌ |✅ |❌ + +|A user group has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has replied your comment |Comments |✅ |❌ |❌ + +|A group you belong to has been mentioned |Comments |✅ |❌ |❌ + +|You have been mentioned |Comments |✅ |❌ |❌ + +|Your comment in has been upvoted |Comments |✅ |❌ |❌ + +|Your comment in has been downvoted |Comments |✅ |❌ |❌ + +|A debate has been created |Debates |❌ |✅ |❌ + +|Debate creation is enabled for participants |Debates |❌ |✅ |❌ + +|Debate creation is no longer active |Debates |❌ |✅ |❌ + +|The debate was closed |Debates |✅ |✅ |❌ + +|A meeting has been created |Meetings |❌ |✅ |❌ + +|A meeting was closed |Meetings |✅ |✅ |❌ + +|A meeting was updated |Meetings |❌ |✅ |❌ + +|Your meeting's registration has been confirmed |Meetings |✅ |❌ |❌ + +|The allocated slots for the meeting are over X% |Meetings |❌ |❌ |✅ + +|The meeting has enabled registrations |Meetings |❌ |✅ |❌ + +|The registration code for the meeting has been validated. |Meetings |✅ |❌ |❌ + +|The meeting will start in less than 48h |Meetings |❌ |✅ |❌ + +|A new proposal has been published |Propositions |❌ |✅ |❌ + +|Proposal creation is open |Propositions |❌ |✅ |❌ + +|Proposal supports are open |Propositions |❌ |✅ |❌ + +|Proposal endorsements are open |Propositions |❌ |✅ |❌ + +|Someone has left a note on the proposal |Propositions |❌ |❌ |✅ + +|A proposal is currently being evaluated |Propositions |✅ |✅ |❌ + +|A proposal has been rejected |Propositions |✅ |✅ |❌ + +|A proposal has been accepted |Propositions |✅ |✅ |❌ + +|An admin has updated the scope of your proposal |Propositions |✅ |❌ |❌ + +|An admin has updated the category of your proposal |Propositions |✅ |❌ |❌ + +|A proposal has been mentioned |Propositions |✅ |❌ |❌ + +|A user requested access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user withdrawn the collaborative draft |Proposal drafts |✅ |❌ |❌ + +|An amendment has been rejected |Amendmentsfootnote:amendments[If amendments are enabled] |✅ |✅ |❌ + +|An amendment has been accepted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been created |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been promoted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|A sortition has been created |Sortitions |❌ |✅ |❌ + +|A survey has been opened |Surveys |❌ |✅ |❌ + +|A survey has been closed |Surveys |❌ |✅ |❌ +|=== \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/global_moderations.adoc b/docs/fr/modules/admin/pages/global_moderations.adoc new file mode 100644 index 0000000000..0b56fd2db7 --- /dev/null +++ b/docs/fr/modules/admin/pages/global_moderations.adoc @@ -0,0 +1,121 @@ += Global moderations + +The *Global moderations* function allows you to moderate different kind of contents and +ensure that the dialog in your platform is democratic and constructive. Making +use of this function, administrators, collaborators and moderators of a space can +hide the contents/contributions that have been reported, where the complaint is +deemed appropriate, or delete the complaint. + +NOTE: Looking for how to report users? See xref:participants/reported_users.adoc[Reported users]. + +For instance, in the case of https://www.decidim.barcelona/[Decidim Barcelona], +the https://www.decidim.barcelona/pages/terms-and-conditions[Terms of Service] says: + +> It is not allowed to add any illegal or unauthorized content to the site, such +> as information with the following features: +> +> * be it false or misleading; +> * to infringe any law of the City Council or any third party, such as copyright, +> trademarks or other intellectual and industrial property rights or related rights; +> * attacking the privacy of a third party, such as publishing personal details +> of participants, such as name, address, phone number, email, photos or any other +> personal information; +> * containing viruses, Trojans, robots or other programs that may harm the website +> or the City Hall systems, or the website or system of any third party, or which +> intend to circumvent the technical measures designed for the proper functioning +> of the platform; +> * to send spam to users or overload the system; +> * which has the character of message chain, pyramidal game or random game; +> * for commercial purposes, such as publishing job offers or ads; +> * that it is not in keeping with public decency; consequently, content must not +> incite hatred, discriminate, threaten, provoke, have no sexual, violent, coarse or +> offensive meaning or character; +> * to infringe the law or applicable regulation; +> * to campaign by promoting mass voting for other proposals not related to the +> process and the framework for discussion, and +> * to create multiple users by pretending to be different people (astroturfing). + +Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant +profile. After a participant has clicked in this action then they need to provide a +reason why they are making this report: + +* Contains clickbait, advertising, scams or script bots. +* Contains racism, sexism, slurs, personal attacks, death threats, suicide requests or any form of hate speech. +* Contains illegal activity, suicide threats, personal information, or something else you think doesn't belong on [This organization]. + +Participants can also add extra information regarding their report. + +image:moderation_modal.png[Give reason for moderation modal] + +After a participant has reported a content, it'll be shown in two sections of the +administration panel: + +* Global moderations panel +* Participatory space moderation panel + +To go to the Global moderations panel, you need to: + +. Sign in as administrator +. Go to administration panel +. Click in Global moderations in the sidebar + +There you'll find first all the unprocessed reports if there's any: + +image:global_moderations_list_unhidden.png[Show all the moderated content list] + +It's also possible to filter by the type of content that was moderated and the +state of the reported content (if it was hidden or not). + +* *Id*: unique identificator of the reported content. +* *Type*: which kind of content it was reported, for instance a *Proposal* or a *Comment*. +* *Participatory Space*: which space this content belongs to. +* *Count*: Number of times it has been reported by different users. +* *Reported content URL*: link for seeing the content reported and see the context of the complaint. +* *Reports*: why it has been reported. If the participant that made the report has given extra +information it's possible to see it by hovering it. +* *Creation date*: when it was originally reported. +* *Actions*: you can *Expand*, *Unreport* or *Hide*. + +== Actions (when the report wasn't accepted yet) + +|=== +|Icône |Nom |Definition + +|image:action_expand.png[Expand icon] +|Expand +|To see the full metadata of the reported content. + +|image:action_hide.png[Hide icon] +|Hide +|Allows an admin or moderator to hide this content (accepting the report). + +|image:action_unreport.png[Unreport icon] +|Unreport +|Allows an admin or moderator to keep showing this content (rejecting the report). +|=== + +== Actions (after the content is hidden) + +|=== +|Icône |Nom |Definition + +|image:action_expand.png[Expand icon] +|Expand +|To see the full metadata of the reported content. + +|image:action_unhide.png[Unhide icon] +|Unhide +|Allows an admin or moderator to unhide this content (showing it publicly again). +|=== + +If the report was "Unreported" and it was a mistake, meaning that for instance the +content was spam but it was a mistake not accepting the report, then you'll need +to find that again in the public view and report it yourself so you can moderate it. + +== Expand + +To see all the metadata of a report, you can see it Expanded. + +image:global_moderations_report01.png[Expanded moderation 01] + +image:global_moderations_report02.png[Expanded moderation 02] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/help_sections.adoc b/docs/fr/modules/admin/pages/help_sections.adoc new file mode 100644 index 0000000000..9be6d5e3d7 --- /dev/null +++ b/docs/fr/modules/admin/pages/help_sections.adoc @@ -0,0 +1,23 @@ += Help sections + +The first time a visitor goes to any Space page they will see an information box about what's this Space about. + +This is how the information box is shown to participants and visitors: + +image:help_sections_frontend.png[Help sections: frontend] + +They can hide this box by clicking in the close button [X]. This gets remembered by the application. They can open this box again by clicking in [Help: ?]. + +image:help_sections_frontend_hide.png[Help sections: hide] + +As this is something that depends on your given installation, an administrator can customize these *Help sections*, adapting them to your needs. + +image:help_sections_backend.png[Help sections: backend] + +== Disable + +You can disable these information boxes by leaving the contents all empty for every language: + +image:help_sections_disable_backend.png[Disable help section in admin] + +image:help_sections_disable_frontend.png[Disabled help section] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/newsletters.adoc b/docs/fr/modules/admin/pages/newsletters.adoc new file mode 100644 index 0000000000..bb68d8d15b --- /dev/null +++ b/docs/fr/modules/admin/pages/newsletters.adoc @@ -0,0 +1,164 @@ += Newsletters + +Newsletters are emails sent to the organization's participants with the news. They are +sent to participants that have checked the "Receive an occasional newsletter +with relevant information" when the participant signed up or after in their account. + +image::newsletter_contact_permission.png[Contact permission in participant registration] + +image::newsletter_participant_notifications_settings.png[Contact permission in participant account] + +Some examples of when you can and should sent a newsletter are: + +* When a new process could be interesting for all the citizens in a city, +for instance a Participatory Budgeting process. +* When there are the results published for a given process. +* When an assembly has a important point for discussion. +* When there's a new voting planned. +* When there's a new conference published + +To create a new newsletter, as an administrator you need to: + +. Go to newsletter menu +. Click in the button "New newsletter" +. Select the template that you want to use +. Fill the form with the newsletter contents +. Preview the newsletter +. Select recipients to deliver +. Deliver the newsletter + +== 1. Go to newsletter menu + +It's on the main sidebar of the admin panel. + +image::newsletter_menu.png[Newsletter admin menu] + +== 2. Click in the button "New newsletter" + +In this page you'll have a list of all the sent newsletters, along with the status +(if it was sent already or not) and how many participants have received it. + +image::newsletter_list.png[Newsletter list] + +In the secondary sidebar or in the top of the list you have the button for "New +newsletter". + +== 3. Select template of new newsletter + +Depending on what you want to sent, if it's just a quick update or if it's something +a little more elaborated (with an image and a button), then you can choose for +which kind of template you want to use: + +* Basic (only text) +* Text, image and Call to Action button + +image::newsletter_templates.png[Newsletter new templates selection] + +== 2. Fill the form with the newsletter contents + +Depending in which template you've choosen, you have two different forms for +filling: + +=== Basic (only text) newsletter form + +image::newsletter_new_basic.png[Newsletter new template basic form] + +image::newsletter_new_basic_example.png[Newsletter new template basic form filled] + +[NOTE] +==== +You can use "%\{name}" anywhere in the body or subject and it will be +replaced by the recipient's name. +==== + + +.New Newsletter "basic (only text)" form +|=== +|Champ |Type |Description + +|Subject +|Obligatoire +|Subject of the email. + +|Body +| +|Body of the email. +|=== + +=== Text, image and Call to Action button newsletter form + +image::newsletter_new_cta01.png[Newsletter new template text, image and CTA form 1] + +image::newsletter_new_cta02.png[Newsletter new template text, image and CTA form 2] + + +.New Newsletter "Image, text and Call To Action button" form +|=== +|Champ |Type |Description + +|Subject +|Obligatoire +|Subject of the email. + +|Introduction +| +|Body of the email. + +|Call To Action button text +| +|What will the button say. For instance, it could be "Participate" + +|Call To Action button URL +| +|Where will the button link to. For instance, it could be the complete URL of a participatory process. + +|Body +| +|Body of the email. + +|Main image +| +|Guidance for image: Preferrably a landscape image that does not have any text. The service crops the image. Allowed file extensions: jpg jpeg gif png bmp ico +|=== + +== 3. Preview the newsletter + +After you've filled the contents of the newsletter, you can preview it. Until you've +sent it you can go back and edit it anytime you want. + +image::newsletter_preview_basic_example.png[Newsletter new template basic form preview] + +== 4. Select recipients to deliver + +If you want to only communicate about a given space, one useful way of doing this +is through the "Select recipients to deliver". Here you can choose between: + +* Sending the newsletter to all confirmed users +* Sending the newsletter to all confirmed users that have participated in any of +the selected participatory spaces in the list +* Sending the newsletter to all confirmed users that have followed any of +the selected participatory spaces in the list +* Sending the newsletter to all the participants that have selected an scope in +their "My interests" settings in their account. + +It's important to note that even if a participant has confirmed their account and +is following the space, the system will not send them a newsletter email if they +haven't activated the "I want to receive newsletters". + +image::newsletter_select_recipients.png[Newsletter select recipients] + +If you select the "Sent do participants" or "Send to followers" of a given space, +then you can choose which spaces are relevant: + +image::newsletter_select_recipients_spaces.png[Newsletter select recipients spaces] + +== 5. Deliver the newsletter + +Finally if you click in the "Deliver newsletter" button, the newsletter will be +sent to all the selected recipients. + +[NOTE] +==== +Once a newsletter was sent it can't be undone nor edited. If you have multiple +languages active, be careful with reviewing all the languages well before sending. +==== \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/pages.adoc b/docs/fr/modules/admin/pages/pages.adoc new file mode 100644 index 0000000000..33847bb576 --- /dev/null +++ b/docs/fr/modules/admin/pages/pages.adoc @@ -0,0 +1,125 @@ += Pages + +You can configure static Pages, which contains general information to the participants of the platform. + +As an example, some of these pages could refer to: + +* What's this platform? Who's the organization? +* How can I participate here? +* How can I create and verify my account? +* What are the terms of conditions and the legal information about this platform? + +These pages will be available to all the participants through the **Help** top menu section and also at the footer sections. You can define **Topics** to categorize all of these pages. + +As the platform enables the Participants to sign up (register) and save some of their personal data, it's important that there's an especial page, called **Terms and Conditions**. This is where you need to put your legal terms, for instance which entity has control of this data, how much time does this data will be saved, etc. This should be (ideally) written and (at least) reviewed by a lawyer. + +== Create a new page + +For creating a new page, you need to: + +. Sign in as admin +. Click in Pages in the sidebar menu +. Click in "Create page" + +image::pages_backend_form.png[Backend: new page form] + + +.New page form +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|Title of this page. For instance: "How to participate?" + +|URL Slug +|Obligatoire +|String that will be used on the URL. Use partial paths, not full URLs here. Accepts letters, numbers, dashes and slashes, and must start with a letter. For instance if the slug is "hello-world" and your domain is "https://example.org", your page will be at "https://example.org/hello-world" + +|Content +|Obligatoire +|All the text of the page. + +|Topic +|Facultatif +|In which Topic it'll be in. + +|Weight +|Facultatif +|Which order will it have in relation with the other pages. Avoir un nombre inférieur signifie un rang d'affichage plus élevé. For instance, if you have two pages, "Page a" with weight "10" and "Page b" with weight "0", then "Page b" will be first when ordering. + +|Show in the footer +|Facultatif +|Wether you want to show this page in the general footer (available in every page). +|=== + +image::pages_frontend_footer.png[Frontend: example of a page in the footer] + +== Create a new topic + +For creating a new topic, you need to: + +. Sign in as admin +. Click in Pages in the sidebar menu +. Click in "Create topic" + +image::pages_backend_topic_form.png[Backend: new topic form] + + +.New topic form +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|Title of this topic. For instance: "Help" + +|Description +|Facultatif +|What's this topic is about. + +|Weight +|Facultatif +|Which order will it have in relation with the other topics. Avoir un nombre inférieur signifie un rang d'affichage plus élevé. For instance, if you have two topics, "Topic a" with weight "10" and "Topic b" with weight "0", then "Topic b" will be first when ordering. + +|Show in the footer +|Facultatif +|Wether you want to show this topic in the general footer (available in every page). +|=== + +== Special "Terms and Conditions" page + +This is where you need to put your legal terms, for instance which entity has control of this data, how much time does this data will be saved, etc. This should be (ideally) written and (at least) reviewed by a lawyer. + +It's generated by default in a new installation. It can't be deleted, and it has a few special details related with its legal nature: + +. It's shown in the text area sign up form +. If there are meaningful changes, it has a field that can allow an admin when it's necessary that the participants accept the "Terms and Conditions" again, in the next sign in. + +image::pages_backend_tos_change.png[Backend: ToS change] + +image::pages_frontend_tos_change.png[Frontend: ToS change] + +If a participant rejects to accept the terms, then they have three options: + +. To review this again later. It signs them out automatically. +. To download their personal data +. To delete their account + +image::pages_frontend_tos_reject.png[Frontend: ToS reject] + +== Examples + +=== Pages + +image::pages_frontend_show.png[Frontend: show a page] + +image::pages_backend_edit.png[Backend: edit a page] + +image::pages_backend_list.png[Backend: list pages] + +=== Topics + +image::pages_frontend_list_topics.png[Frontend: list topics of pages] + +image::pages_backend_list_topics.png[Backend: list topics of pages] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/admins.adoc b/docs/fr/modules/admin/pages/participants/admins.adoc new file mode 100644 index 0000000000..0746ef9183 --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/admins.adoc @@ -0,0 +1,21 @@ += Admins + +In the administrator listing page you can see all the administrators of the platform: + +image:admins.png[Admins list] + +Here you can: + +* invite new administrators +* revoke administrators permissions +* see when was the last time an administrator logged in + +For inviting a new administrator, you need to go to the button "New user" and fill +the form with the admin username, email and which role will they have: + +* Admin: to give full access to the platform +* Participant manager: to give permission to only do xref:admin:participants/impersonations.adoc[Impersonations] + +image:admins_invite.png[Invite participant as administrator form] + +You can invite an already registered or a non registered participant. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/authorizations.adoc b/docs/fr/modules/admin/pages/participants/authorizations.adoc new file mode 100644 index 0000000000..f518678be5 --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/authorizations.adoc @@ -0,0 +1,40 @@ += Authorizations + +This section allows you to manage participants' authorizations. It depends on which Authorizations you have configured and +enabled by your developers. To understand more what are authorizations and how to configure them, please refer to the +xref:customize:authorizations.adoc[Authorizations section in the Customize Guide]. + +With authorizations an administrator can define different permissions so participants can make some actions in a component. +For instance you can configure that only participants who have verified herselves by their identity documents can vote on +proposals in a participatory process. + +A participant can see which authorizations do they have available in their account settings. + +image:authorizations_account.png[Authorizations in participants account] + +== Authorizations revocation + +A default Decidim installation will not have verified participants. + +image:authorizations_admin_default.png[Authorizations in a default installation] + +In the moment that there are some participants verified, an administrator can revoke all the authorizations, as the attributes +that give permissions to those participants could be changed in time and the platform didn't receive these changes in the +participants statuses. For instance, an identity document of a participant could be expired, or if a participant have been +authorized by the "code by postal letter", that participant could move in the meantime. + +image:authorizations_admin_revocation.png[Authorizations revocation] + +It's possible to revoke all the authorizations with "Revoke all", or to only revoke authorizations before a given date. +Another possiblity is to revoke only the xref:admin:participants/impersonations.adoc[impersonated participants]. + +== Verification methods + +Some of the available authorizations by default are: + +* xref:admin:participants/authorizations/identity_documents.adoc[Documents d'identité] +* xref:admin:participants/authorizations/code_postal_letter.adoc[Code par lettre postale] +* xref:admin:participants/authorizations/census.adoc[Recensement de l'organisation] + +If any of these authorizations are not useful for your needs, talk with your implementer to see other alternatives. Learn +more about xref:customize:authorizations.adoc[Authorizations in the Customize Guide section]. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/authorizations/census.adoc b/docs/fr/modules/admin/pages/participants/authorizations/census.adoc new file mode 100644 index 0000000000..bc81ab9578 --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/authorizations/census.adoc @@ -0,0 +1,34 @@ += Organization's census authorization + +The process is as follows: + +. Admins upload a CSV with the emails of the accepted participants +. Participants go to its accounts and requests to be verified +. Only participants with an email in that CSV file can get verified + +NOTE: is this too simple and you need more features related to CSV census imports? +Check all the CSV or file based authorizations in our https://decidim.org/modules/[Modules page]. + +== 1. An administrator uploads the CSV of the participants + +In the admin panel, the administrator can review the request by going to the "Organization's census" in the "Participants" section. + +image:authorizations_organization_census.png[Organization's census in admin panel] + +After the CSV is imported then the administrator can see how many participants where imported. They can also delete this +imported census. + +image:authorizations_organization_census_imported.png[Imported CSV] + +== 2. A participant requests to be verified + +By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +a participant can request to be verified. + +image:authorizations_organization_census_account.png[Organization's census in participant's accounts] + +== 3. The participant is verified (or not) + +After is verified, as with other verifications, they can see it in their account settings. + +image:authorizations_organization_census_verified.png[Verified by organization's census] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/authorizations/code_postal_letter.adoc b/docs/fr/modules/admin/pages/participants/authorizations/code_postal_letter.adoc new file mode 100644 index 0000000000..7ad078d0f9 --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/authorizations/code_postal_letter.adoc @@ -0,0 +1,57 @@ += Code by postal letter authorization + +This authorization allows a participant to request for a verification code to be sent to its address, to confirm that they +live or work in this place. They will need to then fill the code in the platform. + +The process is: + +. Participants request a verification code to be sent to their address. +. An administrator sends the letter to their address with the verification code. +. An administrator marks the letter as sent. +. Once you mark the letter as sent, the participant will be able to introduce the code. +. If this code matchs, then they get verified. + +== 1. A participant request the verification code + +By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +a participant can see the form for filling in their full address to request the verification code. + +image:authorizations_code_postal_letter_request.png[Code by postal letter request by participant] + +If they try to edit it, they will see this message: + +image:authorizations_code_postal_letter_edit.png[Edit the postal letter request] + +This is because the letter could be in the process of being sent. If this needs to be corrected, then the participant needs +to contact to the organization. + +== 2. An administrator review this request and sent the letter + +In the admin panel, the administrator can review the request by going to the "Code by postal letter" in the "Participants" section. + +image:authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in admin] + +Here they can see the verification code and can send it to the participant by mail. After the code is sent they can mark it +as sent with the icon image:action_mark_as_sent.png[Mark as sent]. It'll also show when the letter was sent. + +== 3. A participant fills in the verification code + +After the participant has received the code, they can go to their account settings and click in the "Code by postal letter" +verfication method. + +image:authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account] + +Then they will see the form for confirming the code. + +image:authorizations_code_postal_letter_confirm.png[Code by postal letter confirmation form] + +== 4. The verification code matches or not + +If the verification code matches, then the participant will see the message "Congratulations. You've been successfully verified". + +On the other hand, if the verification code doesn't match, then the participant will see the message "Your verification +code doesn't match ours. Please double-check the letter we sent to you." + +After is verified, as with other verifications, they can see it in their account settings. + +image:authorizations_code_postal_letter_verified.png[Verified by code by postal letter] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/authorizations/identity_documents.adoc b/docs/fr/modules/admin/pages/participants/authorizations/identity_documents.adoc new file mode 100644 index 0000000000..0cead76506 --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/authorizations/identity_documents.adoc @@ -0,0 +1,141 @@ += Identity documents authorization + +This authorization allows a participant to upload its identity documents. These documents depend on the organization, +they could be a driver's license, a passport, a national identity card, a club membership card, etc. + +These documents will be reviewed by an administrator to accept or reject them. It's possible to do this process in two ways: Online or Offline. + +* Online: the participant will be asked to upload the documents, and the administrator will review these documents. +* Offline: the participant will be asked to fill in some data, and then they will need to go to a presential place to show their documents face to face. + +== Configuration + +By clicking on the btn:[Config] button in this section, an administrator can configure the settings for this authorization. + +image:authorizations_id_document_configuration.png[ID document authorization configuration] + +NOTE: As you can see, this authorization is based in the original implementers reality, in this case in the Spanish identities document types. +For instance, we're giving as options for document types "DNI, NIE or Passport" or we're asking for "Document number (with letter)" +You can change this by xref:customize:code.adoc[code customizing or overriding] these things. We also accept xref:contribute:governance.adoc[Pull Request contributions] +so it's possible to configure this. + + +.ID Documents authorization configuration +|=== +|Champ |Type |Description + +|Available methods +|Obligatoire +|At least one method must be selected. Options: Online and/or Offline. + +|Instructions for offline verification +|Required (if offline is selected) +|Directions that participants need to follow to verify their documents when offline verification is selected. For instance, +do they need to go to a specific place to show their documents? Is this place open some days of the week? Is it open +for certain hours? +|=== + +== Online + +The process is: + +. Participants fill in their document type and number and upload a copy of their document. +. An administrator fills in the information present in the uploaded image. +. The information should match whatever the user filled in. +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and +the user will be able to fix it. + +=== 1. A participant fill in the document information and uploads a copy of their document + +By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +a participant can see the form for uploading a copy of their document. They also need to fill in their document type and number. + +image:authorizations_id_document_online.png[ID document authorization online form] + +=== 2. An administrator review this document + +After this document is uploaded, an administrator can review it by going to the Identity documents section in the admin +panel. + +image:authorizations_id_document_online_pending.png[ID document authorization pending online verification] + +After clicking on the document, the administrator needs to see the image and fill in the document number. This needs to match +with the one provided by the participant. + +image:authorizations_id_document_online_confirm.png[ID document authorization online confirmation form] + +=== 3. The request is accepted or rejected + +There are two actions an admin can do: + +* Accept: the participant will be fully authorized. +* Reject: the participant will be prompted to amend their documents + +If the request is rejected then the participant can provide other pictures or document. + +image:authorizations_id_document_online_rejected.png[ID document authorization rejected online verification] + +== Offline + +The process is: + +. Participants fill in their document type and number. +. Participants follow the instructions provided to them. For instance, if they need to go to a specific place in a +specific time to show their documents. +. An administrator go to the "Offline verification" panel and fills in the information present in the physical documents. +. The information should match whatever the user filled in. +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and +the user will be able to fix it. + +For this authorization to work, an administrator need to first configure it in the admin panel with the instructions explaining +what the participant need to do to finish the verification process. + +image:authorizations_id_document_configuration_offline.png[ID document authorization configuration: offline instructions] + +=== 1. A participant fill in the document information and follow the instructions + +By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +a participant can see the form for filling in their document type and number. + +image:authorizations_id_document_offline_request.png[ID document authorization offline form] + +=== 2. An administrator review this request + +In the admin panel, the administrator can review the request by clicking in the "Offline verification" button. + +image:authorizations_id_document_offline_button.png[ID document authorization offline button in admin] + +Then they will need to fill some data provided by the participant and by reviewing the document physically provided by them. + +image:authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in admin] + + +.ID Documents authorization offline flow +|=== +|Champ |Type |Description + +|Participant email +|Obligatoire +|Email of the registered participant + +|Type of the document +|Obligatoire +|Can be: DNI, NIE or Passport + +|Document number (with letter) +|Obligatoire +|Document number of the participant. For instance, "12345678Z" +|=== + +=== 3. The request is accepted or rejected + +In the cases where the verifications don't match (meaning that the email or the document number provided by the +participant and the ones filled by the administrators aren't the same), then the participant needs to amend it with their +user account. + +== Both + +It's also possible to enable both of these verifications methods. In this case, the participant will be asked to choose +which kind of verification they want to do. + +image:authorizations_id_document_account_choose.png[Choose ID document verification kind] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/groups.adoc b/docs/fr/modules/admin/pages/participants/groups.adoc new file mode 100644 index 0000000000..ea7fb4075f --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/groups.adoc @@ -0,0 +1,116 @@ += User Groups + +An user group is a group of participants. Depending in the installation and the context of the organization it could be disabled. This is enabled or disabled in the administration dashboard, in Settings -> Configuration -> Edit organization -> Enable groups. + +== Creation + +This action is done by **a participant**. They need to go to their profile and in the sidebar there's a button that says "Create group": + +image:user_sidebar.png[User sidebar] + +When clicked it'll open the "New group form": + +image:user_group_new_form.png[New user group form] + + +.New group form +|=== +|Champ |Type |Description + +|Nom +|Obligatoire +|Name of your organization, association, collective, group, etc. + +|Nickname +|Obligatoire +|Nickname of your organization, association, collective, group, etc. Do not use spaces nor accents. 20 characters maximum. + +|Email +|Obligatoire +|Email of your organization, association, collective, group, etc. + +|Avatar +|Facultatif +|Guidance for image: Preferably a landscape image that does not have any text. The service crops the image. Maximum file size: 5MB. Allowed file extensions: jpg jpeg gif png bmp ico + +|About +|Facultatif +|Description of what's this group. + +|Document number +|Facultatif +|Used for verifications. Do not use dashes nor spaces. + +|Phone +|Facultatif +|Used for verifications. Do not use dashes nor spaces. +|=== + +== Membership + +After a group has been created, it's possible to invite participants to become members of the group. After a participant has accepted to be part of this group then they can become an admin. + +The actions that can be done by a participant in the user group are: + +* Edit group profile +* Manage members +* Manage admins +* Invite participant +* Leave group + +image:user_group_invite_participant.png[User groups: invite a participant] + +== Group verifications + +image:admin_user_group_verification.png[Admin panel: user group verifications] + +This action is done by **an administrator**. A group can be: +* Pending +* Verified +* Rejected + +This can be done with the buttons at the sidebar: + +image:admin_user_group_verification_actions.png[Admin panel: user group verifications actions] + +When a user group is pending it can be verified or rejected. Once is verified it can be rejected and once is rejected it can be verified. + +If you want to verify multiple user groups at the same time you can do so with the option "Verify via CSV": + +image:admin_user_group_verification_csv.png[Admin panel: user group verifications CSV] + +.... +Upload your CSV file. It must have the official emails of the groups in your organization in the first column of the file, without headers. Only groups that have confirmed their email and that have an email appearing in the CSV file will be validated. +.... + +After a group is verified this is publicly visible in their nickname in the platform and there's a message in its profile: "This group is publicly verified, its name has been verified to correspond with its real name". + +image:user_group_verified.png[User group: verified icon] + +== Actions + +As a verified user group, there's some options that your participant account can do in behalf of the group, such as: + +=== Create a Debate, Proposal or Meeting + +There's a dropdown in the form during the creation process: + +image:user_group_create_debate.png[User group: create a debate] + +=== Make a comment + +There's a dropdown in the form when making a comment: + +image:user_group_make_comment.png[User group: make a comment] + +=== Soutenir + +When making an Endorse there's a modal window asking who do you want to make the endorse with: + +image:user_group_endorse.png[User group: endorse] + +=== Conversations + +You can also have Conversations as a group. This is in the group profile page: + +image:user_group_conversation.png[User group: conversations] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/impersonations.adoc b/docs/fr/modules/admin/pages/participants/impersonations.adoc new file mode 100644 index 0000000000..05979cfe5f --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/impersonations.adoc @@ -0,0 +1,42 @@ += Participants Impersonations + +For participants that don't have the knowledge or don't have an email for registering +an account, there's the Impersonation feature. + +This allows an 'Administrator' or 'Participant manager' to search through a +Verification system for an already existing participant and also to create a +participant without email. + +NOTE: At the code and the User Interface we say both *Impersonation* and *Managed +Participants*. It's the same thing. + +== Panel + +image::participants_impersonations.png[Admin's Impersonations panel] + +This is the panel where you can find all the participants: + +* by filtering by managed or not managed participants +* by searching by name + +After you've clicked in `Manage new participant` you'll go to the form to enter +the personal data to check against the verification: + +image::participants_impersonations_form.png[Admin's Impersonations form] + +NOTE: If you don't see the `Manage new participant` button, is because this feature +only works when you have a Verification of kind `direct` (also known +as `form authorizations`). See in your xref:admin:system.adoc[system panel] which +`Available authorizations` are enabled. You can learn more regarding how to program +your form authorization in https://github.com/decidim/decidim/blob/develop/decidim-verifications/README.md[decidim-verification README]. + +After this data is confirmed then there'll be a session for the participant for +30 minutes: + +image::participants_impersonations_user.png[Impersonated user session] + +Finally, it's also possible to Promote a participant, meaning that after a +participant has been managed, an administrator can add the email and send them +an Invitation: + +image::participants_impersonations_promotion.png[Admin's promotion Impersonations] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/participants.adoc b/docs/fr/modules/admin/pages/participants/participants.adoc new file mode 100644 index 0000000000..e751febf80 --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/participants.adoc @@ -0,0 +1,90 @@ += Participants + +In this page an administrator can: + +* Block a participant, for instance because they are spamming or acting against the Terms of Service +* Contact a participant with Decidim private messages (Conversations) +* Officialize a participant +* See its email + +image:participants_participants.png[Participants list] + +== Actions + +image:participants_participants_actions.png[Participants actions] + +|=== +|Icône |Nom |Definition + +|image:action_block.png[Block user] +|xref:_block_user[Block user] +|To block or moderate a participant. + +|image:action_show_email.png[Show email] +|xref:_show_email_address[Show email address] +|To show an email of a participant. + +|image:action_contact.png[Contact] +|xref:_contact[Contact] +|To contact a participant with Decidim private messages (Conversations) + +|image:action_officialize.png[Officialize] +|xref:_officialize[Officialize] +|To recognize that a participant has a special status in the platform + +|image:action_reofficialize.png[Reoffficialize] +|Reoffficialize +|To change an officialization. See xref:_officialize[Officialize] + +|image:action_unofficialize.png[Unofficialize] +|Unofficialize +|To revoke an officialization. See xref:_officialize[Officialize] +|=== + +=== Block user + +After clicking in this option you'll need to provide a justification why you're +blocking this participant: + +image:participants_block_user_justification.png[Justificate the blocked user action] + +Once a blocked participant tries to log-in they will see an error message: + +image:participants_block_user_alert.png[Message shown to blocked user] + +After a participant was blocked its name is changed to "Blocked user". + +See more at xref:admin:participants/reported_users.adoc[Reported users] + +=== Show email address + +After clicking this option, the admin will see a modal. They will have to click in +button "Show email address". + +image:participants_show_email.png[Modal in show email] +image:participants_showed_email.png[Modal after the email is shown] + +This action will be logged in the Admin actvity log. + +image:participants_showed_email_admin_log.png[Admin activity log for show email] + +=== Contact + +By clicking on this option, it will open the private messaging (Conversation) for +this participant. + +image:participants_conversation.png[Conversation with a participant]. + +=== Officialize + +This option is useful to recognize that a participant has a special status in the +platform. For instance, if someone is the City Mayor, a City Councillor or the +President of an Association in an organization context. + +After Officializing a participant you can: + +- Change the Officialization text with "Reofficialize" +- Revoke the Officialization status with "Unofficialize" + +image:participants_officialize.png[Officialize a participant] +image:participants_participants_actions_officialize.png[Officialize a participant] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/reported_users.adoc b/docs/fr/modules/admin/pages/participants/reported_users.adoc new file mode 100644 index 0000000000..855316b7f4 --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/reported_users.adoc @@ -0,0 +1,33 @@ += Reported users + +There are cases where participants could go against the Terms of Service of the +platform, so it's useful to have the option for reporting and blocking users. You +can read more about how moderation and reporting contents work in xref:global_moderations.adoc[Global moderations]. + +A participant can be blocked from the xref:participants/participants.adoc[participants +section in the admin panel] or through this "Reported users" section. + +Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant +profile. After a participant has clicked in this action they need to provide a +reason why they are making this report: + +* Contains clickbait, advertising, scams or script bots. +* Contains racism, sexism, slurs, personal attacks, death threats, suicide requests +or any form of hate speech. +* Contains illegal activity, suicide threats, personal information, or something +else you think doesn't belong on Demo. +* Other (and add it) + +image:reported_participant_modal.png[Give reason for reporting a participant modal] +image:reported_participant_flag.png[Flag in sidebar profile] + +After clicking in this option you'll need to provide a justification why you're +blocking this participant: + +image:participants_block_user_justification.png[Justificate the blocked user action] + +Once a blocked participant tries to log-in they will see an error message: + +image:participants_block_user_alert.png[Message shown to blocked user] + +After a participant was blocked its name is changed to "Blocked user". \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/participants/verifications_conflicts.adoc b/docs/fr/modules/admin/pages/participants/verifications_conflicts.adoc new file mode 100644 index 0000000000..fff49b3ee0 --- /dev/null +++ b/docs/fr/modules/admin/pages/participants/verifications_conflicts.adoc @@ -0,0 +1,38 @@ += Verification's conflicts + +There are cases depending on which kind of verifications you've enabled that there could be verification's conflicts. + +For instance: + +. A participant get xref:admin:participants/impersonations.adoc[impersonated], and they don't provide an email +. Then they create an account and try to verify themselves with the Census verification + +For security, we try to be extra cautious in these cases, and we want that an administrator reviews these verifications. +As you can see, this depends a lot on which kind of verifications you've enabled in your organization, so it's easy to say +that most of the time an organization will not see any conflicts in this panel. + +image:verifications_conflicts.png[Verification's conflicts panel] + +== Transfer user + +An administrator can review these conflicts by clicking in the Transfer user image:action_transfer_user.png[Transfer user] icon. + +Then they will see the Transfer user form, where they can provide a reason for the transfer. + +image:verifications_conflicts_transfer_user.png[] + + +.Transfer user form +|=== +|Champ |Type |Description + +|Reason +|Obligatoire +|Why you want to transfer the user + +|Email +|Obligatoire +|The email of the user to transfer +|=== + +After the user is transferred, both accounts (the original and the new one) will be merged. \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/scopes.adoc b/docs/fr/modules/admin/pages/scopes.adoc new file mode 100644 index 0000000000..69391b726f --- /dev/null +++ b/docs/fr/modules/admin/pages/scopes.adoc @@ -0,0 +1,105 @@ += Scopes + +Scopes are the set of territories or subjects that an Organization has. A scope may have child scopes. + +For instance, in the case of the city of Barcelona the scopes are its districts, and the children of a district are its neighborhoods. They can also have types, so it can be configured, for example, by thematic and also territorial scopes. + +Most of the components and spaces in Decidim allow you to configure Scopes in one way or another. There are mainly three ways of using Scopes: + +To configure Scope on the Decidim platform, go to menu:Settings[Scopes] in the admin sidebar menu. A list will appear with the existing scopes if there are any: + +image:scopes_list.png[Scopes list] + +If you need so, you need to first configure the Scope type. + +== Form + +image:scopes_types_new_form.png[New scope type form] + + +.Admin New Scope Type form +|=== +|Champ |Type |Description + +|Singular +|Obligatoire +|Name of the scope type in singular. + +|Plural +|Obligatoire +|Name of the scope type in plural. +|=== + +image:scopes_new_form.png[New scope form] + + +.Admin New Scope Form +|=== +|Champ |Type |Description + +|Nom +|Obligatoire +|Name of the scope. + +|Code +|Obligatoire +|(Internal) name of the scope. + +|Scope type +|Obligatoire +|Which type of scope it's. +|=== + +== Actions + +You have 3 possible actions in this list after a Scope is created: + +|=== +|Icône |Nom |Definition + +|image:action_browse.png[Browse icon] +|Browse +|See and configure the children scopes for this Scope. + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for a Scope. It's the same form as "Create a new scope". + +|image:action_delete.png[Delete icon] +|Delete +|To delete this scope. +|=== + +== Fonctionnalités + +The main features related with scopes are: + +. Filtering +. User interests and Newsletters + +=== Filtering + +For filtering. Most of the spaces and components allows an administrator or a participant to associate them to a scope. This allows to filter by scopes when exploring them. + +image:scopes_filter_initiatives.png[Initiatives scopes filtering] + +image:scopes_filter_processes.png[Processes scopes filtering] + +Some examples: + +* With Accountability module, so it's possible to filter Results +* Assemblies and Processes can have Scopes. It's used for filtering multiple assemblies in the main listing page (/assemblies or /processes). These can be hidden by unchecking the "Enable participatory space filters" in the xref:admin:configuration.adoc[admin's configuration page]. +* Filtering in the sidebar is possible in Budgets Projects, Initiatives and Proposals. In some of these components you can control if these filters are shown with the "Scopes enabled" checkbox in the component settings. This will also enable or disable the scope selector in the resource creation form. + +You can also configure a participatory space so the filtering will only concern one scope and its children scopes. For example, let's imagine your organization have 3 different scopes for 3 cities, each of them having children scopes for the cities neighbourhoods. +On a participatory space which concerns only one of the cities, you will be able to select only this scope and its children so that users do not see the scopes of other cities in the filter options. + +=== User interests and Newsletters + +A Participant can choose which Scopes they want to follow in its account. + +image:account_my_interests.png[Account: my interests] + +This is used by the xref:admin:newsletters.adoc[Newsletters], in the "Select recipients to deliver" step, "Filter for users having activated any selected scope in their account's My Interests settings." section. + +image:newsletter_select_recipients.png[Newsletter: select recipients] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/spaces/assemblies/members.adoc b/docs/fr/modules/admin/pages/spaces/assemblies/members.adoc new file mode 100644 index 0000000000..4388385a8d --- /dev/null +++ b/docs/fr/modules/admin/pages/spaces/assemblies/members.adoc @@ -0,0 +1,72 @@ += Assembly members + +Assembly members allow showing all the people or groups that belong to a given assembly. It's useful for being transparent. + +You can see an example in https://meta.decidim.org/assemblies/coordination-committee/members[Decidim Coordination Commitee Assembly in Metadecidim]. + +image:assembly_members.png[Assembly members of the Coordination Committee] + +== New assembly member form + +image:assembly_members_list.png[Assembly members admin list] + +For creating a new phase of a participatory process: + +. 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 +. Remplissez le formulaire + +image:assembly_members_new_form.png[Assembly members new form] + + +.New assembly member form +|=== +|Champ |Type |Description + +|Participant type +|Obligatoire +|Wheter this assembly member is non-participant or existing participant. Do they already have an account created on the platform? + +|Full name +|Required if it's non-participant. +| + +|User or group +|Required if it's an existing participant. +|Type at least three characters to search. + +|Position +|Obligatoire +|Choose one of President, Vice president, Secretary, or Other. In case it's other, you can fill in the position title. + +|Weight +|Facultatif +|Which order will it have in relation to the other members. Avoir un nombre inférieur signifie un rang d'affichage plus élevé. 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. + +|Designation date +|Obligatoire +|When was this person or group assigned as a member of this assembly. Expected format: dd/mm/yyyy + +|Designation mode +|Facultatif +|How was this person designed. + +|Ceased date +|Facultatif +|When was this person or group ceased to be a member of this assembly. Expected format: dd/mm/yyyy + +|Gender +|Facultatif +|Which gender does this person most identify with. + +|Birthday +|Facultatif +|When was this person born. Expected format: dd/mm/yyyy + +|Birthplace +|Facultatif +|Where was this person born. +|=== \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/spaces/conferences/registrations/invites.adoc b/docs/fr/modules/admin/pages/spaces/conferences/registrations/invites.adoc new file mode 100644 index 0000000000..0bfbc30c9f --- /dev/null +++ b/docs/fr/modules/admin/pages/spaces/conferences/registrations/invites.adoc @@ -0,0 +1,38 @@ += Invites + +Administrators can invite participants to join the conference. + +image:spaces/conferences/invites.png[Conferences user invites (backend)] + +== Flow + +. An administrator sends an invitation to join the conference to a non-existing or existing participant +. The participant accepts the invitation + +image:spaces/conferences/invite_participant_form.png[Invite a participant form] + + +.Invite participant form +|=== +|Champ |Type |Description + +|Attendee type +|Obligatoire +|Wheter this invited person is a non-existing or existing participant. Do they already have an account created on the platform? + +|Nom +|Required if it's a non-existing participant. +|Name of the invited person. + +|Email +|Required if it's a non-existing participant. +|Email of the invited person. + +|User +|Required if it's an existing participant. +|Type at least three characters to search. + +|xref:admin:spaces/conferences/registrations/types.adoc[Registration type] +|Obligatoire +|What xref:admin:spaces/conferences/registrations/types.adoc[registration type] does this participant will have. +|=== \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/spaces/conferences/registrations/types.adoc b/docs/fr/modules/admin/pages/spaces/conferences/registrations/types.adoc new file mode 100644 index 0000000000..99b949173e --- /dev/null +++ b/docs/fr/modules/admin/pages/spaces/conferences/registrations/types.adoc @@ -0,0 +1,56 @@ += Registration types + +You can enable registrations in conferences, so it's easier to register to the whole conference, or by days, rather than +going meeting by meeting to enable registration for that particular event. + +After enabling registrations participants will have a button to register to the conference in the landing and the conference's header. + +image:spaces/conferences/registration_landing01.png[Registration button on landing page] + +image:spaces/conferences/registration_landing02.png[Registration button on landing page] + +If you want to enable registration you'll need to define and publish at least one registration type. + +image:spaces/conferences/registration_types_frontend_wo_user.png[Select registration type without a user account] + +== Create a new registration type + +For adding a new registration type, you need to: + +. Sign in as administrator +. Go to the conferences section in the sidebar +. Click on the conference Edit action +. Click on the "Registration types" link in the sidebar +. Click on the "New Registration type" button +. Remplissez le formulaire +. Publish the registration type + +image:spaces/conferences/new_registration_type.png[Create a new registration type form] + +image:spaces/conferences/registration_types_backend.png[Manage registration types] + + +.Create a new registration type +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|What is the title of this registration type. + +|Weight +|Which order will it have in relation to the other types. Avoir un nombre inférieur signifie un rang d'affichage plus élevé. For instance, if you have two types, "Day 1" with weight "10" and "Day 2" with weight "0", then "Day 2" will be first when ordering. +|Description + +|Obligatoire +|Description for this registration type +|Price + +|Facultatif +|Define a price for this registration type. If you don't define a price, the price will be "Free". +|Select conference meetings +|=== + +If the participant is already logged in then they will see their username and email in the registration page. + +image:spaces/conferences/registration_types_frontend_w_user.png[Select registration type with user account] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/spaces/conferences/registrations/users.adoc b/docs/fr/modules/admin/pages/spaces/conferences/registrations/users.adoc new file mode 100644 index 0000000000..24e2468fc2 --- /dev/null +++ b/docs/fr/modules/admin/pages/spaces/conferences/registrations/users.adoc @@ -0,0 +1,27 @@ += User registrations + +After participants have registered, they will appear in this section. + +image:spaces/conferences/user_registrations.png[Conferences user registrations (backend)] + +As an administrator, you can: + +* Export the registrations +* Confirm a registration + +== Export + +It's possible to export the registrations in multiple formats: CSV, JSON, and XLSX (Excel). + +== Flow + +. A participant registers to the conference +. They receive a pending registration notification +image:spaces/conferences/user_registration_pending_notification.png[Notification for pending user registration] +. They receive a pending registration email +image:spaces/conferences/user_registration_pending_email.png[Email for pending user registration] +. An administrator reviews and confirms the registration with the image:action_check.png[Confirm] button +. The participant receives a confirmed registration notification +image:spaces/conferences/user_registration_confirmed_notification.png[Notification for confirmed user registration] +. They receive a confirmed registration email with an calendar file (.ICS). +image:spaces/conferences/user_registration_confirmed_email.png[Email for confirmed user registration] \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/spaces/conferences/speakers.adoc b/docs/fr/modules/admin/pages/spaces/conferences/speakers.adoc new file mode 100644 index 0000000000..f01875d1a9 --- /dev/null +++ b/docs/fr/modules/admin/pages/spaces/conferences/speakers.adoc @@ -0,0 +1,68 @@ += Speakers + +The speakers are people that are going to talk at the conference. + +image:spaces/conferences/speakers_frontend.png[Conferences speakers (frontend)] + +== Create a new speaker + +image:spaces/conferences/speakers.png[Conferences speakers] + +For creating a new speaker of a conference: + +. Sign in as administrator +. Go to the conferences section in the sidebar +. Click on the conference Edit action +. Click on the Speakers link in the sidebar +. Click on the "New Conference Speaker" button +. Remplissez le formulaire + +image:spaces/conferences/new_speaker.png[Conferences speakers] + + +.New conference speaker form +|=== +|Champ |Type |Description + +|Participant type +|Obligatoire +|Wheter this speaker is a non-participant or existing participant. Do they already have an account created on the platform? + +|Full name +|Required if it's non-participant. +|Name of the speaker. + +|User or group +|Required if it's an existing participant. +|Type at least three characters to search. + +|Related meetings +|Facultatif +|Which meetings does this speaker attend and participates actively? + +|Position +|Obligatoire +|Metadata for showing extra information about the speaker. + +|Affiliation +|Obligatoire +|Metadata for showing extra information about the speaker. + +|Short Bio +|Facultatif +|Metadata for showing extra information about the speaker. + +|Twitter handle +|Facultatif +|Metadata for showing extra information about the speaker. + +|Personal URL +|Facultatif +|Metadata for showing extra information about the speaker. + +|Avatar +|Facultatif +|Metadata for showing extra information about the speaker. + +Default image +|=== \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/spaces/initiatives.adoc b/docs/fr/modules/admin/pages/spaces/initiatives.adoc new file mode 100644 index 0000000000..ae672042d5 --- /dev/null +++ b/docs/fr/modules/admin/pages/spaces/initiatives.adoc @@ -0,0 +1,408 @@ += Initiatives + +An initiative is a special type of participatory process that can be promoted by anyone (independently of other channels or participation spaces) through the collection of (online and in-person) signatures for the organization to carry out a specific action (modify a regulation, initiate a project, change the name of a department or a street, etc.). + +The promoters of an initiative can define its objectives, gather support, debate, disseminate it and define meeting points where signatures can be collected from the attendees or debates open to other participants. + +Examples: An initiative can collect signatures to call for a consultation among all the people of an organization, or to create an assembly, or to call for a process of budget increase for a territory or area of the organization. During the process of collecting signatures, more people can add to this demand and carry it forward in the organization. + +Initiatives are to be distinguished from the other participation spaces because they can be used as a participatory tool or mechanism promoted by participants. In other words, the initiatives are mechanisms for semi-direct democracy through which participants can promote a certain action of common interest to the organization, by collecting a specific number of signatures. In this case, what the organization has to do is enable the promotion of these initiatives and offer the necessary technical support and advice to the people concerned. The role of the platform’s administrator, then, is somewhat different from that of the other participation spaces. + +In the first place, you will have to configure the various forms of initiatives. This could be specified in a regulation (like a municipal normative or state law), specifying the number of signatures required for processing the various types of initiatives. For example, an initiative for incorporating one or several items into the Municipal Council’s agenda evidently requires fewer signatures than another initiative for promoting a binding consultation. + +== 0. Initiative setup + +How initiatives work depends on two things: how the initiative module is configured through the xref:admin:initiatives_initializer.adoc[initializer] (in code) and how the initiative type is configured in the administration panel. + +Regarding initiatives type, **an administrator** needs to define one. For Initiatives to work on an organization there must be at least one initiative type created and configured with at least one initiative type scope. If there's only one type then the participant will not get the possibility to choose the initiative type, this step will be skipped in the initiative creation wizard. + +Some real examples from the city of Barcelona are: + +* To add an item to the Municipal Council or Districts agendas +* To perform a participatory process +* To create a new assembly +* To approve or modify a regulation +* To request the holding of a citizen consultation +* To call for assemblies (neighborhood councils or public audiences) + +=== New initiative type form + +image:admin_initiative_type.png[New initiative type form] + + +.Admin new initiative type form: General information +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|Title of the initiative type. For instance, "New park at city center". + +|Description +|Obligatoire +|Explanation of what can be done with this initiative type. + +|Banner image +|Obligatoire +|An image for this initiative type. NOTE: At the moment this is not used. +|=== + + +.Admin new initiative type form: Options +|=== +|Champ |Type |Description + +|Signature type +|Facultatif +|Which kind of signature type will be allowed. Options are: Online, In-person and Mixed. The Mixed option allows a participant to choose which signature type will have the initiative. + +|Enable attachments +|Facultatif +|Whether it'll allow to upload attachments to initiatives. + +|Enable participants to undo their online signatures +|Facultatif +|Can a participant undo its signature when they already signed? + +|Enable authors to choose the end of the signature collection period +|Facultatif +|Can the authors of an initiative change the end of the signature collection period? + +|Enable authors to choose the area for their initiative +|Facultatif +|Can the authors choose the area of their initiative? + +|Enable child scope signatures +|Facultatif +|This config flag doesn't support offline votes, it enables sub-scopes and works with an authorization handler that associates a scope to the user, make sure you select that authorization, bellow in authorization settings. For it to work, scopes need to be configured in a hierarchical way : 1 Parent - N Child. + +|Only allow global scope initiatives creation +|Facultatif +|Tick this flag if you enabled "Child scope signature" and configured the global scope as your parent scope. By enabling this, scope selection will be skipped in the initiative creation wizard. + +|Enable promoting committee +|Facultatif +|Whether it will only allow individual initiatives (made by only one person) or allow collective initiatives (multiple promoters, being multiple individuals or a user group). + +|Minimum of committee members +|Facultatif +|When "Enable promoting committee" option is checked, defines the minimum number of promoter's committee member to send the initiative to technical validation + +|Collect participant personal data on signature +|Facultatif +|Adds a step to the signature process. When a participant clicks on the signature button, they will be redirected to a form asking for some personal data. This will be used with the PDF export action after the recollection period has ended. + +|Legal information about the collection of personal data +|Depends on whether the option "Collect participant personal data on the signature" is checked +|Privacy notice and terms of use for the participant personal data during the signature process. +|=== + + +.Admin new initiative type form: Authorization settings +|=== +|Champ |Type |Description + +|Authorization to verify document number on signatures +|Facultatif +|When a participant is making the signature process, will they be asked for an authorization? + +|Add SMS code validation step to the signature process +| +|During the signature process, will it ask for SMS validation? See xref:services:sms.adoc[configuration of SMS service]. +|=== + +=== New initiative type scope form + +An initiative type can also have scopes associated. For Initiatives it needs at least one scope configured. + +image:admin_initiative_type_scope.png[New initiative type form] + + +.Admin new initiative type scope form +|=== +|Champ |Type |Description + +|Scopes +|Obligatoire +|A Scope. An author can choose this scope in the creation of the initiative. + +|Signatures required +|Obligatoire +|Number of signatures the initiative need to have before the end period so it can be accepted. +|=== + +== 1. Create an initiative + +This action is done by **the author**. The author is a participant that creates the initiative. Depending on how the initiatives module is configured in the initializer or how the initiative type is configured, it may need to ask for authorization, or it will even not show the "New initiative" button. + +image:initiative_list.png[Initiatives list] + +For creating an initiative, a participant must click in the "New initiative" button. Then they will have a wizard with multiple steps: + +=== 1.1 Choose the initiative type + +image:initiative_new_step1.png[Initiative creation: step 1] + +=== 1.2 Add title and description + +image:initiative_new_step2.png[Initiative creation: step 2] + +=== 1.3 [Optional] Similarity comparison + +Checks the rest of the initiatives if there are other similar initiatives. If there are, the system will show them before continuing. This is a way to avoid duplicates. + +=== 1.4 Finish + +image:initiative_new_step3.png[Initiative creation: step 3] + +image:initiative_new_step4.png[Initiative creation: step 4] + +=== Actions after it was created + +After the initiative was created, a participant can see the initiative page, but until the initiative is reviewed and accepted by an administrator, through the technical validation, it will not be published and visible for all the participants. + +image:initiative_show.png[Initiative show] + +In the sidebar a participant can make some actions: Edit, Print and Send to technical validation. + +image:initiative_actions.png[Initiative actions] + +==== Edit + +After the initiative was created and before it was sent to technical validation, **an author** can edit and correct the initiative if it has any error. + +image:initiative_edit.png[Initiative edit] + +==== Print + +An author can also print the initiative. + +image:initiative_print.png[Print an initiative] + +==== Technical validation + +After the author has reviewed how the initiative will look, they can send it to technical validation. + +image:initiative_send_to_technical_validation.png[Send initiative to technical validation] + +== 2. Send initiative to technical validation + +This action is done by **the author**. + +After it has been reviewed by the author, it can be sent to "Technical validation", but it depends in the configuration of the initiative type, in whether the options "Enable promoting committee" and "Minimum of committee members" are configured. + +=== Promoter's committee + +An initiative type can optionally be supported by a promoter's committee, with a minimum number of committee members. Once the user has created the initiative and before it can be sent for technical validation they need to invite committee members to promote it. + +When the user has created the initiative they will be given a link to share with possible committee members, which will look something like `/initiatives/.../committee_requests/new` + +When a prospective committee member opens the link, they can click a button which allows them to request to be part of the committee. The initiative author then needs to approve each request. The author can approve them by clicking on the "Edit" button of their initiative at the bottom of the form they can approve or reject committee members. + +image:initiative_commitee_members_send_to_technical_false.png[Initiative promotor committee: edit screen] + +The initiative cannot be sent to technical validation until it meets the minimum number of committee members required. You can find the invitation link in the edit form. + +image:initiative_edit_commitee_members.png[Initiative promotor committee: edit screen] + +Share the invitation link with the people you'd like to have on your committee. + +image:initiative_commitee_members_ask.png[Initiative promotor committee: edit screen] + +The people invited with the link will be able to read the initiative and ask to be part of the committee. + +image:initiative_commitee_members_sent.png[Initiative promotor committee: edit screen] + +The request is sent and the author can then and accept or refuse it in the initiative edit form. + +image:initiative_commitee_members_approve.png[Initiative promotor committee: edit screen] + +image:initiative_commitee_members_send_to_technical_true.png[Initiative promotor committee: edit screen] + +Once enough people have joined the promoter committee the initiative author can send it for +technical validation. + +== 3. Publish an initiative + +This action is done by **an administrator**. + +After the initiative was sent to technical validation by a participant, an administrator can view all the initiatives in the admin panel and make some corrections. + +image:initiative_admin_list.png[Admin initiatives list] + +=== Actions + +Regarding the actions in an initiative, an administrator can "Preview", "Edit", "Answer" or "Print" an initiative: + +image:initiative_admin_list_actions.png[Initiative admin list actions] + +|=== +|Icône |Nom |Definition + +|image:action_preview.png[Preview icon] +|Preview +|Pour voir comment il est montré dans le frontend aux participants. + +|image:action_edit.png[Edit icon] +|Edit +|Edit form for Initiative. + +|image:action_answer.png[Answer icon] +|Answer +|Allows to answer an Initiative. + +|image:action_print.png[Print icon] +|Print +|Allows to print. +|=== + +=== Fonctionnalités + +Once an initiative has been created it gets the Meetings and Page component enabled by +default. The initiative author has no control over these - an admin will need to manage +them. All of the other usual components may be added by an admin too. + +image:initiative_admin_show.png[Admin initiative show page] + +There are also other features inside initiatives, like Attachments and Moderations for the comments. + +image:initiative_admin_sidebar.png[Admin initiative sidebar] + +=== Publish + +After the initiative was reviewed and technically approved by an admin, for instance for checking that what the initiative is asking is legal or abides to the normative (ie it's municipal competency), then it can be published: + +image:initiative_admin_actions.png[Admin initiative actions] + +== 4. Sign an initiative + +This action is done by **a participant**. + +After the initiative was published, it'll be visible in the initiatives listing page (/initiatives): + +image:initiative_list_published.png[Initiative list after it was published] + +image:initiative_admin_show_published.png[Admin initiative show after it was published] +image:initiative_show_published.png[Initiative show after it was published] + +And authorized participants can sign it: + +image:initiative_admin_show_published_detail.png[Admin initiative show after it was published (detail)] + +image:initiative_show_signed.png[Initiative show after it was signed] + +== 5. Export signatures + +This action is done by **an administrator**. After the initiative has started to get signatures, there's an option for exporting a PDF of the signatures: + +image:initiative_actions_export.png[Initiative actions with Export to PDF] + +image:initiative_actions_export_pdf.png[Initiative exported PDF] + +== 6. Answer an initiative + +After the initiative has collected all the signatures then it can be answered by an administrator. An initiative answer don't have different types. + +image:initiative_backend_answer.png[Initiative backend answer] + +image:initiative_frontend_answer.png[Initiative frontend answer] + +== Initiative statuses + +For better understanding all the status, this is a summary: + +|=== +|Status |Explanation + +|Created +|The initiative has been created but is not yet public for every visitor or the rest of the participants. + +|Technical validation +|The initiative needs to be reviewed by an administrator. From here, it can be "discarded" or "published" + +|Expired +|The initiative wasn't reviewed by an administrator and wasn't approved, and the maximum time for validation has passed. + +|Discarded +|The initiative was reviewed by an administrator and was discarded, so it's not published. + +|Published +|The initiative was reviewed by an administrator and was approved, so it's published. + +|Rejected +|The period for signature recollection has ended and there weren't enough signatures. + +|Accepted +|The period for signature recollection has ended and there were enough signatures. +|=== + +[plantuml] +@startuml +:Created; +:Technical validation; +if (has passed the maximum validation time?) then (yes) + #pink:Expired; + kill; +elseif (validated?) then (no) + #pink:Discarded; + kill; +else (yes) + #palegreen:Published; + if (enough signatures?) then (no) + #pink:Rejected + (not enough signatures); + kill; + else (yes) + #palegreen:Accepted + (enough signatures); + stop; + endif; +endif +@enduml + +Finally, these are all the relevant settings in every moment in the initiatives life cicle: + +[plantuml] +@startuml +(*) --> "Create a new initiative" +if "Has only one type?" then +--> [Yes] "Fill initiative form" +else +--> [No] "Select initiative type" +--> "Fill initiative form" +Endif +partition Created { + if "Is the User a UserGroup?" then + --> [Yes] "Send to Technical Validation" + else + --> [No] Collect the minimum number of committee members (2 by default) + --> "Send to Technical Validation" + Endif +} +partition Validating { + if "Has passed the maximum time for validation (60 days by default)?" then + --> [Yes] "Expired" + else + --> [No] if "Is accepted by an administrator?" then + --> [No] "Discarded" + else + --> [Yes] "Publish" + endIf + endIf +} +partition Published { + --> "Signature process" + if "Has passed the configured time window for validation (60 days by default)?" + --> [Yes] "Expired" + else + --> [No] Export PDF to signatures + --> Check signatures with offline signatures for duplicates (if the Initiative has them) + --> if "Has the initiative get the number of signatures required?" then + --> [No] Rejected + else + --> [Yes] Accepted + endIf + endIf +} +--> (*) +@enduml \ No newline at end of file diff --git a/docs/fr/modules/admin/pages/spaces/processes/types.adoc b/docs/fr/modules/admin/pages/spaces/processes/types.adoc new file mode 100644 index 0000000000..58432d8684 --- /dev/null +++ b/docs/fr/modules/admin/pages/spaces/processes/types.adoc @@ -0,0 +1,39 @@ += 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. + +Process Types work similarly to xref:admin:spaces/assemblies.adoc#_assemblies_types[Assembly types]. + +== New process type form + +For creating a new process type: + +. 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 + +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"] + + +.New participatory process type form: General information +|=== +|Champ |Type |Description + +|Titre +|Obligatoire +|Title of the participatory process type. For instance, "Consultative". +|=== + +== 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. + +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"] + +== Process type filter + +In the front-end if there is at least one Process Type defined, a filter shows, allowing filtering of Processes. + +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"] \ No newline at end of file diff --git a/docs/fr/modules/admin/partials/page_admins.adoc b/docs/fr/modules/admin/partials/page_admins.adoc new file mode 100644 index 0000000000..ad9ccd45f4 --- /dev/null +++ b/docs/fr/modules/admin/partials/page_admins.adoc @@ -0,0 +1,67 @@ += Space Admins + +You can give permissions to users with special rights in a space, +so they can only have access to some of the administration pages in this space. +These roles are administrators, moderators, collaborators, or valuators. + +* Administrators: they can administer the space and change the space settings. +* Collaborators: they can see the space and its components before it's published and view the space settings. +They can't change anything. +* Moderators: they can see the reported contents of the space and hide or unhide them. +* Valuators: they can evaluate proposals. Used by participatory budgeting processes. + +To invite them, in the space's submenu, go to *Space admins* and click on *New space admin*. This depends in the kind of space +that you're, for instance for participatory processes it'd be *Process admins* and *New process admin*. + +== New space admin form + +image:spaces/admins_form.png[New space admin form] + + +.New space admin form +|=== +|Champ |Type |Description + +|Nom +|Obligatoire +|What is the name of the new admin. + +|Email +|Obligatoire +|What is the email of the new admin, so they can receive the invitation. + +|Role +|Obligatoire +|Which role does this admin will have in the participatory process? Can be any of Administrator, Collaborator, Moderator, or Valuator. +|=== + +== Roles + +=== Administrators + +A space administrator can administer the space and change the space settings. It can also invite new space administrators. + +image:spaces/admins_role_admin01.png[Process administrators view 01] + +image:spaces/admins_role_admin02.png[Process administrators view 02] + +=== Collaborators + +A space collaborator can only see the space before it's published. + +image:spaces/admins_role_collaborator.png[Process collaborators view] + +=== Moderators + +A space moderator can review the reported contents of the space and hide or unhide them. + +image:spaces/admins_role_moderator.png[Process moderators view] + +=== Process valuators + +A space valuator can review the proposals of the space. They can: + +* change the status of the proposals, by accepting or rejecting them +* add a monetary value to the proposals, so they can be voted with the budget component. + +image:spaces/admins_role_valuator.png[Process valuators view] \ No newline at end of file diff --git a/docs/fr/modules/admin/partials/page_private_participants.adoc b/docs/fr/modules/admin/partials/page_private_participants.adoc new file mode 100644 index 0000000000..e63e1fd239 --- /dev/null +++ b/docs/fr/modules/admin/partials/page_private_participants.adoc @@ -0,0 +1,75 @@ += Private participants + +There are cases where you want to have a closed census of the participants in a space. For instance this could be a space +for a small group of people, or the members of a comission inside of a big organization. For these cases you can +use the private participants feature. + +image:spaces/private_participants.png[Private participants list] + +For inviting private participants of a space: + +. Sign in as administrator +. Go to the space's section in the sidebar +. Click on the space Edit action +. Click on the "Private participants" link in the sidebar +. Click on the "New participatory space private user" or "Import via CSV" buttons + +== New participatory space private user + +image:spaces/private_participants_new_form.png[New private participant form] + + +.New participatory space private user form +|=== +|Champ |Type |Description + +|Nom +|Obligatoire +|What is the name of the new participant. + +|Email +|Obligatoire +|What is the email of the new participant. +|=== + +== Import via CSV + +image:spaces/private_participants_csv_import.png[Import private participants via CSV] + +This form allows you to bulk import the participants of a space. + +It must have two columns with email in the first column of the file and the name in the last column of the file (email, name) +of the users that you want to add to the participatory space. Some tips: + +* The file should not have headers. That means that you do not have to add a column that says "email, name" +* You must avoid using invalid chars like `<>?%&^*#@()[]=+:;"{}\|` in user name. +* The separator between columns must be a comma (",") + +== Actions + +After the participants has been invited, you can resend or delete the invitation. + +image:spaces/private_participants_actions.png[Private participants actions] + +|=== +|Icône |Nom |Definition + +|image:action_resend_invitation.png[Resend invitation] +|Resend invitation +|If the invitation wasn't accepted, send it again to the user + +|image:action_delete.png[Delete invitation] +|Delete invitation +|Revoke the invitation sent to the user +|=== + +== Invitation + +When a participant was invited they will get an email with a link for accepting the invitation: + +image:spaces/private_participants_email_invite.png[Email invitation of a private participant] + +After clicking in this email, they will have to fill a form for setting their password, accepting the Terms of Service and giving +their consent if they want to receive newsletters. + +image:spaces/private_participants_user_registration_form.png[User registration form of a private participant] \ No newline at end of file diff --git a/docs/fr/modules/features/pages/general-description.adoc b/docs/fr/modules/features/pages/general-description.adoc new file mode 100644 index 0000000000..e34d230c73 --- /dev/null +++ b/docs/fr/modules/features/pages/general-description.adoc @@ -0,0 +1,63 @@ += General description and introduction to how Decidim works +:page-partial: + +http://decidim.org[Decidim], from the Catalan for "let's decide", is a digital infrastructure for participatory democracy, built entirely and collaboratively as free software. More specifically, Decidim is a web environment (a _framework_) produced in _Ruby on Rails_ that allows users to create and configure a website platform or portal, to be used in the form of a social network, for democratic participation. The portal allows any organization (local city council, association, university, NGO,trade union, neighborhood or cooperative) to create massive democratic processes for strategic planning, participatory budgeting, collaborative regulatory design, urban spaces design and elections. It also enables the organization of in-person meetings, signing up for them, the publication of minutes, proposing points for the agenda and receiving notifications of the results. Decidim can also help organizing governing bodies, councils or assemblies, the convening of consultations and referendums or channeling citizen or member initiatives to impact different decision making processes. All together Decidim makes possible to digitally structure a complete system of participatory democratic governance for any organization. + +To understand in detail how Decidim operates, a distinction must be made between participatory _spaces_ and _components_ (see <>). + +[#functional-architecture-fig] +._Summary diagram of Decidim's functional architecture showing a combination of components in participatory spaces. The "Vote*" component allows a variety of voting systems, expressions of support or allegiance for a proposal._ +image::functional-architecture-en.svg[width=2000] + +* *Participatory spaces.* These are the frameworks that define how participation will be carried out, the _channels_ or means through which citizens or members of an organization can process requests or coordinate proposals and make decisions. _Initiatives_, _Processes_, _Assemblies_ and _Consultations are all participatory spaces. Specific examples of each of these include: a citizen initiative for directly changing a regulation (_Initiative_); a general assembly or workers’ council (_Assembly_); a participatory budgeting, strategic planning, or electoral process (_Processes_); a referendum or a call to vote “Yes” or “No” to change the name of an organization (_Consultation_). +* *Participatory components.* These are the participatory _mechanisms_ that allow a series of operations and interactions between the platform users within each of the participatory spaces. The following are participatory components: _comments, proposals, amendments, votes, results, debates, surveys, sortitions, pages, blogs, newsletters_ and _meetings_. Other components that build on top of basic components are: _participatory texts_, _accountability_ and _conferences_. + +[#spaces-components-fig] +._Decidim displays participatory spaces on the top menu (dark) and components are displayed on the bottom menu (white)._ +image::spaces-components.png[] + +The ways in which spaces and components interact is the following. Users of the platform (participants) interact through participatory mechanisms known as components which afford a variety of features for the various participatory _spaces_. In other words, participatory _spaces_ such as _Initiatives_, _Assemblies_, _Processes_ and _Consultations_ have components at their disposal which work together as participatory mechanisms. The more notable components include in-person _meetings_, _surveys_, _proposals_, _debates_, _results_ and _comments_. So, for example, the various phases of a participatory budgeting process can combine components in the following way: at an early phase public meetings can be opened for citizens to analyze different needs classified by districts. In turn these meetings can lead to the design of a survey. The survey results can then be used to define a set of categories for projects to be proposed. The proposal component can then be activated for participants to create and publish their projects as solutions to the identified needs. These proposals can then be commented and, after two weeks of deliberation, voting can be activated to select among the projects with a budget-expenditure system. Participants can then be called to a public meeting to evaluate the results, and an assessment survey can be launched afterwards for those who could not attend the meeting. Finally, the accountability component may be activated to monitor the degree of execution of the selected projects, and people can comment on it. What makes Decidim particularly powerful is this combination of components within spaces, which provides an organization with a complete toolkit to easily design and deploy a democratic system and adapt it to the organization's needs. + +Decidim's top navigation bar displays the different types of active *spaces* of the platform. *Processes* is a space that allows to create, activate/deactivate, and manage various participatory processes. These are distinguished from other spaces by being structured in different phases within which all of the components can be incorporated. Examples of participatory processes are: an election process for members of a committee, participatory budgeting, a strategic planning process, the collaborative writing of a regulation or norm, the design of an urban space or the production of a public policy plan. *Assemblies* is a space that offers the possibility of setting decision-making bodies or groups (councils, working groups, committees, etc.) that meet up periodically, detailing their composition, listing and geolocating their meetings, and allowing to take part in them (for instance: attending if the seating capacity and nature of the assembly so permits, adding items to the agenda, or commenting on the proposals and decisions taken by that body). *Consultations* is a space that makes it possible to coordinate referendums, trigger discussions and debates, get voting results published; it can be connected to a secure e-voting system. *Initiatives* is a space that allows participants to collaboratively create initiatives, define their trajectory and goals, gather endorsements, discuss, debate and disseminate initiatives and define meeting points where signatures can be collected from attendees or debates opened to other members of the organization. Initiatives is a special kind of space by which members of the organization can trigger actions that are generally restricted to elected bodies or platform administrators, by collecting (digital) signatures. The organization can define the types of initiatives and set up the number of signatures that are required to trigger the expected result (e.g. to call for a consultation). + +The *components* (also called features) are displayed as a second level menu with white background within spaces (as displayed in <>). The *collaborative draft* for proposals facilitates the collaborative creation of proposals as well as the monitoring and control of changes throughout the process. The *proposals* component allows a user to create a proposal using a creation wizard, compare it with existing ones, publish it in the platform and include additional information like geolocation or attached documents and images. This component also makes possible to navigate, filter and interact with a set of proposals. The proposal component has plenty of configuration options, and different features can be activated or de-activated in time. One such feature is *voting* or *support*: it offers organizations the possibility of activating different voting or support systems around proposals: unlimited, limited to a given threshold, weighted, cost-based, etc. Proposals can also be imported to a new phase, so they can be re-written or elaborated in different stages, where they can also be subject to *amends* which can be voted separately, accepted and merged or rejected, to improve proposals democratically. The *results* component is used to turn proposals into results and give official responses concerning their acceptance or rejection, merging various proposals into a single result or creating different results related to the same original proposal. The *accountability* component offers the possibility of subdividing results into projects, defining and applying progress statuses around their implementation, as well as displaying the extent of the results’ implementation grouped by categories and scopes. In this sense the accountability component works like a project management system built into the platform. The *surveys* component can be used to design and publish surveys and to display and download their results. The *sortition* component allows to select a number of proposals (e.g. candidates for a jury) with random, yet reproducible, procedures that guarantees non-biased and uniform distributions. The *comments* component enables users to add comments, to identify the comment as being in favor, against or neutral in relation to the commented object, to vote comments, respond to them and to receive notifications about responses. The *participatory texts* component can be used to convert lengthy text documents into various proposals or results and, vice versa, to compose and display a unified text based on a collection of proposals or results. This makes possible to work with a full document as continuous text in participatory manner. The *pages* component is used to create informative pages with rich text formatting, embedded pictures and videos. The *blog* component makes possible the creation of posts or news, and to navigate them chronologically. The *meeting* component offers organizations and participants the opportunity to convene meetings, determine their location and time, registration and management of attendees, to define the structure and content of the meeting as well as publishing the minutes, and the resulting proposals. The *conference* component allows an organization to create a website for a big event by joining up a series predefined meetings (chats, workshops etc.), putting together a unified program and managing attendees. The *newsletter* component makes possible to send emails to everyone registered in the platform or, more selectively, to those who participate in a specific space. + +Participants can carry on different *types of actions* within the platform: + +[start=0] +. They can *navigate* and search for information +. They can *create* contents of different types (e.g. proposals and debates). +. They can *vote, support or sign* all three modes allow for participants to aggregate their preference or will for a specific consultation question, proposal or initiative respectively (the difference between these three types of actions involve different levels of security and anonymity: signatures can be audited and attributed to a participant, supports cannot, in order to prevent coercion, while votes involve higher cryptographic guarantees than supports). +. They can *comment* on any object of the platform (proposals, debates, results, sortitions, etc.). +. They can *endorse* any content, meaning that they can publicly declare they support it or find it relevant, with the participants following it then receiving notifications. +. They can *follow* other participants, a participatory process, an initiative, a specific proposal, etc. and receive notifications. +. They can *sign up* for a meeting. +. They can also *share* and *embed* content out of the platform, sharing the link to other social networks and embedding content on other sites. + +Component items (e.g. a proposal, a blog post, a meeting) have their individual page but are also displayed as *cards* throughout the platform, cards being a major design interface to interact with components. <> displays a proposal card with the different types of data and interactions identified within the card. + +[#card-anatomy-fig] +._Decidim's proposal card anatomy._ +image::card-anatomy.png[] + +The users who participate in Decidim can be grouped into three different categories: + +* *Visitors* have access to all of the platform's content without having to sign up or provide any information. +* *Registered* participants can create content and comments, sign-up for meetings, endorse content, follow other participants and objects of the platform, customize their profile and receive notifications, mentions and private messages. By choosing a username and password, accepting the user agreement, and providing an email account (or using an account for several social networks) participants become registered. Registered participants can also have their account officialized (meaning their username is accompanied by a special symbol indicating they really are who they claim they are on their profile). +* *Verified* participants can make decisions. In order to fall under this category they must first be verified as members of the organization, citizens of the municipality, or constituents of the decision-making group (an association, community, collective etc.). Decidim offers different ways to carry out this verification. Once verified, participants will be able to take decisions by supporting proposals, signing initiatives and voting in consultations. + +Administrators can *manage permissions* for registered or verified users selectively. For example proposal creation can be activated for both registered and verified users but supports to proposals only for verified users. It is also possible (although rarely recommended) to consider all registered users as verified and to grant them decision making powers. + +There are different types of administrators: *administrators* of the whole platform or of specific spaces and components, they can also be *moderators* (with the exclusive power of moderating proposals, comments or debates) or *collaborators* that can read unpublished content, create notes and responses to proposals. + +Participants can register as an *individual* or as a *collective* (associations, working groups, etc. within the main organization). User *groups* might also be created so that individuals can be associated to a *group*. Decidim allows participants belonging to such a group to express or act individually or embodying the group identity: when an action is carried the platform prompts the participant to choose wether they want to act as themselves or as the group they belong to. + +Participants can not only navigate the content of Decidim through the top menu and move down the architectural hierarchy, from a space to its different components; they can also get information through the *search engine*, or via *notifications*. Participants can also talk to each other by internal messaging or *chat*. + +The participant's *profile* makes possible to read notifications, manage followers, and monitor different gamification and engagement badges. + +The *home page* of the platform is fully customizable: it can display different types of banners, call-to-action buttons, it can also display statistics and interactive visualizations, activity streams, and maps with the upcoming meetings. + +The content of the platform can be classified by different criteria. A participatory space and its contents (e.g. a participatory process or the proposals within) can be (independently) assigned a *scope*. Scopes are defined for the whole platform, and they can be thematic or territorial (for example, an assembly can be assigned to a specific theme or subject, like "ecology", and to a specific territory, like a district within a city). Content within a space-instance can be assigned to a *category* or sub-category (e.g. topics) that are specific for such a space-instance. For example, the categories "sport facilities", "parks" and "schools" can be created for a participatory budgeting process, and proposals will be assigned to these categories. *Hashtags* can also be freely created and introduced in the body text almost anywhere in the platform (proposals, debates, comments, process description, etc), both by participants and administrators, to classify content and make it searchable. + +Unlike other existing platforms, Decidim’s architecture is *modular*, *scalable*, easy to *configure*, and *integrated* with other tools or apps (data analysis, maps, SMS, mail, social networks, etc.). The platform has been designed in such a way that processes, assemblies and mechanisms can be set up easily and deployed from an administration panel. No knowledge of programming is required to install, configure and activate it. The participatory spaces and components can be developed, activated and deactivated independently. \ No newline at end of file diff --git a/docs/fr/modules/releases/pages/index.adoc b/docs/fr/modules/releases/pages/index.adoc new file mode 100644 index 0000000000..f0af39d4f1 --- /dev/null +++ b/docs/fr/modules/releases/pages/index.adoc @@ -0,0 +1,35 @@ += Release notes + +Here you can find all the blog posts for every minor release. + +You can find all the releases (with minor and patches) at +https://rubygems.org/gems/decidim/versions[RubyGems.org] and +https://github.com/decidim/decidim/releases[GitHub]. + +* https://decidim.org/blog/2023-12-20-new-version-0-28-0/[Version 0.28 (2022-12-20)] +* https://decidim.org/blog/2022-09-30-new-version-0-27-0/[Version 0.27 (2022-09-30)] +* https://decidim.org/blog/2022-02-22-new-version-0-26-0/[Version 0.26 (2022-02-22)] +* https://decidim.org/blog/2021-10-07-new-version-0-25-0/[Version 0.25 (2021-10-07)] +** xref:develop:guide_migrate_webpacker_module.adoc[Migrate to Webpacker a module] +** xref:develop:guide_migrate_webpacker_app.adoc[Migrate to Webpacker an instance app] +* https://decidim.org/blog/2021-03-26-new-version-0-24-0/[Version 0.24 (2021-03-26)] +* https://decidim.org/blog/2020-11-12-new-version-0-23-0/[Version 0.23 (2020-11-12)] +* https://decidim.org/blog/2020-09-02-new-version-0-22-0/[Version 0.22 (2020-09-02)] +* https://decidim.org/blog/2020-04-12-new-version-0-21-0/[Version 0.21 (2020-04-12)] +* https://decidim.org/blog/2020-02-06-new-version-0-20-0/[Version 0.20 (2020-02-06)] +* https://decidim.org/blog/2019-10-21-release-0-19-0/[Version 0.19 (2019-10-21)] +* https://decidim.org/blog/2019-07-03-release-0-18-0/[Version 0.18 (2019-07-03)] +* https://decidim.org/blog/2019-03-25-release-0-17-0/[Version 0.17 (2019-03-25)] +* https://decidim.org/blog/2019-01-14-release-0-16-0/[Version 0.16 (2019-01-14)] +* https://decidim.org/blog/2018-12-13-release-0-15-0/[Version 0.15 (2018-12-13)] +* https://decidim.org/blog/2018-08-30-release-0-14-0/[Version 0.14 (2018-08-30)] +* https://decidim.org/blog/2018-07-11-release-0-13-0/[Version 0.13 (2018-07-11)] +* https://decidim.org/blog/2018-06-13-release-0-12-0/[Version 0.12 (2018-06-13)] +* https://decidim.org/blog/2018-04-27-release-0-11-0/[Version 0.11 (2018-04-27)] +* https://decidim.org/blog/2018-03-29-release-0-10-0/[Version 0.10 (2018-03-29)] +* https://decidim.org/blog/2018-02-06-release-0-9-0/[Version 0.9 (2018-02-06)] +* https://decidim.org/blog/2017-12-21-release-0-8-0/[Version 0.8 (2017-12-21)] +* https://decidim.org/blog/2017-11-21-release-0-7-0/[Version 0.7 (2017-11-21)] +* https://decidim.org/blog/2017-09-21-release-0-6-0/[Version 0.6 (2017-09-21)] +* https://decidim.org/blog/2017-08-29-release-0-5-0/[Version 0.5 (2017-08-29)] +* https://decidim.org/blog/2017-07-17-release-0-4-0/[Version 0.4 (2017-07-17)] \ No newline at end of file diff --git a/docs/pt/modules/ROOT/nav.adoc b/docs/pt/modules/ROOT/nav.adoc index ef8f361fc9..21a5f32d0e 100644 --- a/docs/pt/modules/ROOT/nav.adoc +++ b/docs/pt/modules/ROOT/nav.adoc @@ -61,6 +61,7 @@ **** 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/assemblies.adoc[Assemblies] **** xref:admin:spaces/assemblies/components.adoc[Components] **** xref:admin:spaces/assemblies/categories.adoc[Categories] @@ -151,6 +152,18 @@ *** xref:develop:guide_architecture.adoc[5. Architecture] ** xref:develop:security.adoc[Security] ** Advanced +*** Creating custom classes +**** xref:develop:classes/cells.adoc[Cells] +**** xref:develop:classes/commands.adoc[Commands] +**** xref:develop:classes/controllers.adoc[Controllers] +**** xref:develop:classes/events.adoc[Events] +**** xref:develop:classes/forms.adoc[Forms] +**** xref:develop:classes/jobs.adoc[Jobs] +**** xref:develop:classes/mailers.adoc[Mailers] +**** xref:develop:classes/models.adoc[Models] +**** xref:develop:classes/permissions.adoc[Permissions] +**** xref:develop:classes/presenters.adoc[Presenters] +**** xref:develop:classes/queries.adoc[Queries] *** Concerns **** xref:develop:authorable.adoc[Authorable] **** xref:develop:embeddable.adoc[Embeddable] @@ -167,16 +180,19 @@ *** xref:develop:deploy.adoc[Deploy] *** xref:develop:docker.adoc[Docker] *** xref:develop:fixing_locales.adoc[Fixing locales] -*** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] *** xref:develop:maps.adoc[Maps] *** xref:develop:managing_translations_i18n.adoc[i18n] +*** xref:develop:maintainers/index.adoc[Maintainers] +**** xref:develop:backports.adoc[Backports] +**** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] +**** xref:develop:maintainers/releases.adoc[Releasing new versionss] +**** xref:develop:maintainers/security.adoc[Security procedures] *** xref:develop:metrics.adoc[Metrics] *** xref:develop:modules.adoc[Modules] *** xref:develop:notifications.adoc[Notifications] *** xref:develop:open-data.adoc[Open Data] *** xref:develop:permissions.adoc[Permissions] *** xref:develop:profiling.adoc[Profiling] -*** xref:develop:releases.adoc[Releases] *** xref:develop:reminders.adoc[Reminders] *** xref:develop:templates.adoc[Templates] *** xref:develop:testing.adoc[Testing] @@ -184,7 +200,6 @@ *** xref:develop:turbolinks.adoc[Turbolinks] *** Views **** xref:develop:content_blocks.adoc[Content Blocks] -**** xref:develop:data-picker.adoc[Data Picker] **** xref:develop:newsletter_templates.adoc[Newsletter Templates] **** xref:develop:view_hooks.adoc[View Hooks] **** xref:develop:view_models_aka_cells.adoc[View Models (Cells)] @@ -215,4 +230,4 @@ *** xref:publications:spanish.adoc[Spanish] ** Whitepaper *** xref:whitepaper:decidim-a-brief-overview.adoc[Decidim: a brief overview] -* xref:releases:index.adoc[Release Notes] \ No newline at end of file +* xref:releases:index.adoc[Release notes] \ No newline at end of file diff --git a/docs/pt/modules/ROOT/pages/index.adoc b/docs/pt/modules/ROOT/pages/index.adoc index 8ed5c4eb1d..abc8d67629 100644 --- a/docs/pt/modules/ROOT/pages/index.adoc +++ b/docs/pt/modules/ROOT/pages/index.adoc @@ -8,6 +8,11 @@ Decidim is a framework that allows anybody to create and configure a website pla You’ve found the documentation for Decidim. Learn about the project at https://decidim.org[decidim.org]. +[NOTE] +==== +This is the documentation for the `develop` branch. You can see this same documentation site for other versions: xref:v0.28@ROOT:index.adoc[v0.28] and xref:v0.27@ROOT:index.adoc[v0.27] +==== + // * Read the xref:ROOT:getting-started.adoc[Getting Started guide] The documentation covers xref:install:index.adoc[installing], xref:configure:index.adoc[configuring], and xref:admin:index.adoc[running] your own Decidim site. diff --git a/docs/pt/modules/admin/pages/components/accountability.adoc b/docs/pt/modules/admin/pages/components/accountability.adoc index 3657f8f81d..2913cb2ce9 100644 --- a/docs/pt/modules/admin/pages/components/accountability.adoc +++ b/docs/pt/modules/admin/pages/components/accountability.adoc @@ -7,4 +7,4 @@ The Accountability component allows people to follow project implementations. It * defining and applying progress in implementation statuses (0% to 100% implemented) around their implementation * displaying the extent of the results’ implementation grouped by categories and scopes -Results, projects and statuses can be updated through a CVS, or manually by the administration interface. \ No newline at end of file +Results, projects and statuses can be updated through a CSV (comma-separated values), or manually by the administration interface. \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/components/budgets.adoc b/docs/pt/modules/admin/pages/components/budgets.adoc index e4e986f0b1..93261f865c 100644 --- a/docs/pt/modules/admin/pages/components/budgets.adoc +++ b/docs/pt/modules/admin/pages/components/budgets.adoc @@ -17,7 +17,7 @@ Some examples of where this component was used: * https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona]. The city of Barcelona (Spain) has allocated a budget of 30.000.000 EUR so people can present, define, prioritize, vote -and choose which investment projects the city goverment should execute. +and choose which investment projects the city government should execute. * https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers (France) has allocated a budget of 1.000.000 EUR so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. * https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million euros to realising @@ -345,7 +345,7 @@ After the voting step has finished, then an administrator need to: . Change the Voting configuration for the Budget component to "Voting finished" . Go to the Budgets and view the results -. On the projects that according to the normative have been selected, she'll need to go to each project, edit it and +. On the projects that according to the normative have been selected, they will need to go to each project, edit it and then check the "Selected for implementation". image:components/budgets/results_unselected.png[Unselected projects after voting] diff --git a/docs/pt/modules/admin/pages/components/meetings.adoc b/docs/pt/modules/admin/pages/components/meetings.adoc index 96b29fa84e..8b017d8085 100644 --- a/docs/pt/modules/admin/pages/components/meetings.adoc +++ b/docs/pt/modules/admin/pages/components/meetings.adoc @@ -130,7 +130,7 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we Meetings can be created by participants if the setting is "Participants can create meetings" is checked. -If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create meetings as that group also. +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create meetings as that group also. image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)] image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form (frontend)] @@ -202,7 +202,7 @@ image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting f |Create meeting as |Required if the participant belongs to a group -|With which identity she wants to create this meeting: as her user or as a group that she's reprensenting? +|With which identity they want to create this meeting: as their user or as a group that they are reprensenting? |=== After creating the meeting, participants can also edit and xref:components/meetings/close.adoc[close] it. diff --git a/docs/pt/modules/admin/pages/components/meetings/registrations.adoc b/docs/pt/modules/admin/pages/components/meetings/registrations.adoc index 71f3b3adb2..b8a7cfd6de 100644 --- a/docs/pt/modules/admin/pages/components/meetings/registrations.adoc +++ b/docs/pt/modules/admin/pages/components/meetings/registrations.adoc @@ -81,7 +81,7 @@ The exported data will have these fields: * code: the xref:_registration_code[registration code] (if this feature is enabled) * user/name: the name of the user * user/email: the email of the user -* user/user_group: the group of the user if she has selected that's representing a group when registering +* user/user_group: the group of the user if they have selected that's representing a group when registering == Invitations @@ -92,7 +92,7 @@ image:components/meetings/registrations/invite_attendee.png[Invite attendee for == Registration code -This feature allows you to check if the attendee is registered in the meeting. She needs to provide her code, that gets +This feature allows you to check if the attendee is registered in the meeting. They need to provide their code, that gets entered in this form and it's checked against the database. image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting] diff --git a/docs/pt/modules/admin/pages/components/proposals.adoc b/docs/pt/modules/admin/pages/components/proposals.adoc index 5d2b652324..808fb78693 100644 --- a/docs/pt/modules/admin/pages/components/proposals.adoc +++ b/docs/pt/modules/admin/pages/components/proposals.adoc @@ -68,8 +68,8 @@ For instance, if you have two components, "Proposals" with weight "10" and "Meet |Minimum supports per user |Optional -|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If she doesn't -reach this number, her supports will not be taken in account. +|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If they don't +reach this number, their supports will not be taken in account. |Proposal limit per participant |Optional @@ -322,7 +322,7 @@ image:components/proposals/new_proposal_frontend.png[New proposal form] Proposals can be created by participants if the setting is "Proposal creation enabled" is checked for the active phase. -If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create proposals as that group also. +If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create proposals as that group also. This form depends a lot in which settings you've enabled in this component. It can be really short (with only a Title and Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, Image and Attachment). diff --git a/docs/pt/modules/admin/pages/components/proposals/amendments.adoc b/docs/pt/modules/admin/pages/components/proposals/amendments.adoc index 04526d48f2..ab49c41aa1 100644 --- a/docs/pt/modules/admin/pages/components/proposals/amendments.adoc +++ b/docs/pt/modules/admin/pages/components/proposals/amendments.adoc @@ -42,7 +42,7 @@ image:components/proposals/amendments/amendment_list.png[] image:components/proposals/amendments/amendment_view_side_by_side.png[] . It's also possible to filter the amended proposals image:components/proposals/amendments/amendment_list_filter.png[] -. Alice receives a notification that Bob has proposed an amendment to her original proposal +. Alice receives a notification that Bob has proposed an amendment to their original proposal image:components/proposals/amendments/proposal_amendmed_notification.png[] . Alice can see the amendment proposal image:components/proposals/amendments/proposal_amendmed_to_review.png[] diff --git a/docs/pt/modules/admin/pages/components/proposals/collaborative_drafts.adoc b/docs/pt/modules/admin/pages/components/proposals/collaborative_drafts.adoc index 9c26ef25e2..ef2c4cb7b3 100644 --- a/docs/pt/modules/admin/pages/components/proposals/collaborative_drafts.adoc +++ b/docs/pt/modules/admin/pages/components/proposals/collaborative_drafts.adoc @@ -6,7 +6,7 @@ It's useful to propose improvements or corrections. It has similarities with xref:components/proposals/amendments.adoc[Amendments] but the main difference is that with collaborative drafts there is a need to trust other authors, as they can make any change to the original proposal without approval by the -original author, although the original author can decide if she promotes the collaborative draft as a proposal. +original author, although the original author can decide if they promote the collaborative draft as a proposal. image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[Collaborative draft with request access button] @@ -24,7 +24,7 @@ For instance, it could be "Processes", "Assemblies", or "Conferences" == How it works -. A participant (Alice) wants to create a collaborative draft. For that, she goes to the proposals list page. +. A participant (Alice) wants to create a collaborative draft. For that, they go to the proposals list page. . Alice clicks in the "Access collaborative drafts" button image:components/proposals/collaborative_drafts/proposals_list01.png[] . Alice clicks in "New collaborative draft" button @@ -40,7 +40,7 @@ image:components/proposals/collaborative_drafts/collaborative_draft_request_acce image:components/proposals/collaborative_drafts/access_requested.png[] . Alice receives the notification image:components/proposals/collaborative_drafts/notification.png[] -. Alice goes to the collaborative draft. There she can accept or reject the collaboration request +. Alice goes to the collaborative draft. There they can accept or reject the collaboration request image:components/proposals/collaborative_drafts/author_sidebar.png[] . Alice approves the collaboration request. Once a request is approved it can't be rejected . Now the collaborative draft has multiple authors @@ -53,7 +53,7 @@ image:components/proposals/collaborative_drafts/collaborative_draft_edited.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_01.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_02.png[] -. Once Alice is satisfied with the collaborative draft, she can publish it by click in the "Publish" button +. Once Alice is satisfied with the collaborative draft, they can publish it by click in the "Publish" button image:components/proposals/collaborative_drafts/publish_modal.png[] . When it's published it becomes a proposal image:components/proposals/collaborative_drafts/proposal.png[] diff --git a/docs/pt/modules/admin/pages/features/badges.adoc b/docs/pt/modules/admin/pages/features/badges.adoc index 6cf9a138d3..7d546a113e 100644 --- a/docs/pt/modules/admin/pages/features/badges.adoc +++ b/docs/pt/modules/admin/pages/features/badges.adoc @@ -5,16 +5,16 @@ and interacting in the platform, they will earn different badges. Here is the li It's a https://en.wikipedia.org/wiki/Gamification[gamification] mechanism to improve the engagement of the participants in a ludic way. -The badges a participant has are visible in her account. There's also a general explanation page with a short description of every badge. +The badges a participant has are visible in their account. There's also a general explanation page with a short description of every badge. image:features/badges/example01.png[Example of badges in profile] -When a participant earns a badge she receives a notification. +When a participant earns a badge they receive a notification. image:features/badges/notification.png[Example of badges notification] -Badges have multiple levels, depending in the number of times she has made the action. For instance, for Proposals badge -she'll receive the first level badge when arriving at 1 follower, the second level at 15 followers, the third level at 30 followers, +Badges have multiple levels, depending in the number of times they have made the action. For instance, for Proposals badge +they will receive the first level badge when arriving at 1 follower, the second level at 15 followers, the third level at 30 followers, the fourth level at 60 and the fifth level at 100. @@ -25,14 +25,14 @@ the fourth level at 60 and the fifth level at 100. |image:features/badges/accepted_proposals_badge.png[Accepted proposals badge] |Accepted proposals |Granted when particiapnts actively participate with new proposals and these are accepted. -|The participant needs to choose the participation space of her interest with submission for proposals enabled and try to +|The participant needs to choose the participation space of their interest with submission for proposals enabled and try to make proposals that can be carried out. This way they are more likely to be accepted. |1, 5, 15, 30, 50 |image:features/badges/attended_meetings_badge.png[Attended meetings badge] |Attended meetings |Granted when participants attend several face-to-face meetings. -|The participant needs to register for the meetings she want to attend +|The participant needs to register for the meetings they want to attend |1, 3, 5, 10, 30 |image:features/badges/debates_badge.png[Debates badge] @@ -45,7 +45,7 @@ make proposals that can be carried out. This way they are more likely to be acce |Followers |Granted when participant reach a certain number of followers. The platform is a social and political network, so participants ned to weave their web to communicate with other people in the platform. -|The participant needs to be be active and follow other people. That will surely make other people follow her. +|The participant needs to be be active and follow other people. That will surely make other people follow them. |1, 15, 30, 60, 100 |image:features/badges/published_initiatives_badge.png[Published initiatives badge] @@ -57,20 +57,20 @@ participants ned to weave their web to communicate with other people in the plat |image:features/badges/invitations_badge.png[invitations badge] |Invitations |Granted when participants invite some people and they have become participants. -|The participant needs to use the “invite friends” link on her user page to invite her friends. She can customize the -message she's sending. She’ll level up by sending invitations and getting them registered. Note that this feature is disabled +|The participant needs to use the “invite friends” link on their user page to invite their friends. They can customize the +message they are sending. They will level up by sending invitations and getting them registered. Note that this feature is disabled and this badge is not available, so it'll be removed in the future. |1, 5, 10, 30, 50 |image:features/badges/proposal_supports_badge.png[Proposal supports badge] |Proposal supports |Granted when participants support other people's proposals. -|The participant needs to browse and spend some time reading other people's proposals and give support to the proposals she like or find interesting. +|The participant needs to browse and spend some time reading other people's proposals and give support to the proposals they like or find interesting. |5, 15, 50, 100, 500 |image:features/badges/proposals_badge.png[Proposals badge] |Proposals |Granted when participants actively participate with new proposals. -|The participant needs to choose the participation space of her interest with submission for proposals enabled and create a new proposal. +|The participant needs to choose the participation space of their interest with submission for proposals enabled and create a new proposal. |1, 5, 10, 30, 60 |=== \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/features/endorsements.adoc b/docs/pt/modules/admin/pages/features/endorsements.adoc index b407e0ca97..90b2f56ab5 100644 --- a/docs/pt/modules/admin/pages/features/endorsements.adoc +++ b/docs/pt/modules/admin/pages/features/endorsements.adoc @@ -8,7 +8,7 @@ This is done through the button in the sidebar. Administrators can enable or dis image:features/endorsements/sidebar.png[Endorsement button in sidebar] -When a participant belongs to a verified group she can also endorse like that group by selecting the identity. +When a participant belongs to a verified group they can also endorse like that group by selecting the identity. image:features/endorsements/modal.png[Select identity modal] diff --git a/docs/pt/modules/admin/pages/features/my_account.adoc b/docs/pt/modules/admin/pages/features/my_account.adoc index f15dc1f51e..67c0baefad 100644 --- a/docs/pt/modules/admin/pages/features/my_account.adoc +++ b/docs/pt/modules/admin/pages/features/my_account.adoc @@ -1,6 +1,6 @@ = My account -My account is all the pages where a participant can change her personal data that is displayed in her xref:admin:features/my_public_profile.adoc[My public profile] page, change her notifications settings, see which groups she belongs, etc. +My account is all the pages where a participant can change their personal data that is displayed in their xref:admin:features/my_public_profile.adoc[My public profile] page, change their notifications settings, see which groups they belong to, etc. To go to this section: @@ -8,7 +8,7 @@ To go to this section: . Click in the name of the participant in the header . Click in "My account" -The actions that she can do are: +The actions that they can do are: * xref:admin:features/my_account/account.adoc[Account] * xref:admin:features/my_account/notifications_settings.adoc[Notifications settings] diff --git a/docs/pt/modules/admin/pages/features/my_account/account.adoc b/docs/pt/modules/admin/pages/features/my_account/account.adoc index 9eb98b406b..115a68a819 100644 --- a/docs/pt/modules/admin/pages/features/my_account/account.adoc +++ b/docs/pt/modules/admin/pages/features/my_account/account.adoc @@ -28,7 +28,7 @@ The service crops the image. Maximum file size: 5MB |Your email |Required -|The email of the participant, where she'll receive notifications, password recovery, etc. If it's changed it needs to be +|The email of the participant, where they will receive notifications, password recovery, etc. If it's changed it needs to be confirmed. |Personal URL diff --git a/docs/pt/modules/admin/pages/features/my_account/delete_my_account.adoc b/docs/pt/modules/admin/pages/features/my_account/delete_my_account.adoc index 8ba403a53e..3522a1c183 100644 --- a/docs/pt/modules/admin/pages/features/my_account/delete_my_account.adoc +++ b/docs/pt/modules/admin/pages/features/my_account/delete_my_account.adoc @@ -10,7 +10,7 @@ To delete the account: . Click in the name of the participant in the header . Click in "My account" . Click in "Delete my account" in the sidebar -. Optionally, she can provide a reason for the deletion +. Optionally, they can provide a reason for the deletion . Click in "Delete my account" . Click in "Yes, I want to delete my account" diff --git a/docs/pt/modules/admin/pages/features/notifications.adoc b/docs/pt/modules/admin/pages/features/notifications.adoc index 18006f9c47..1d5a122581 100644 --- a/docs/pt/modules/admin/pages/features/notifications.adoc +++ b/docs/pt/modules/admin/pages/features/notifications.adoc @@ -1,5 +1,7 @@ = Notifications +== The notification menu + Most of the actions in the platform generate notifications so particpants can know when there are new things to watch. This is accessible from the `Notifications` menu item (image:icon_bell.png[Notification icon]) in the header, after a participant has logged in. @@ -13,4 +15,216 @@ If there are notifications, then the participant will see the icon with a color image:features/notifications/notifications.png[Example of notifications page when there are notifications] -image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] \ No newline at end of file +image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] + +== Notifications list + +Below is an exhaustive list of actions that trigger notifications to participants. Participants are divided into three categories: affected users, followers, and administrators. + +[NOTE] +==== +Affected users depend on the notification context. For instance, it could be the author of moderated content, a user that earns a badge, a user that has been mentioned, etc. +==== + +[cols="7,2,1,1,1"] +|=== +|Action |Feature |Affected user |Follower |Administrator + +|A new attachment has been created |Admin |❌ |✅ |❌ + +|An admin requested an export |Admin |❌ |❌ |✅ + +|A component has been published in a participatory space |Admin |❌ |✅ |❌ + +|A participant has tried to verify themself with the data of another participant |Verifications |❌ |❌ |✅ + +|An administrator moderated a resource because it has been reported |Moderation |✅ |❌ |❌ + +|A resource has been reported |Moderation |❌ |❌ |✅ + +|A user confirms the registration (if welcome notification is enabled) |User |✅ |❌ |❌ + +|A user earned a badge (if badges are enabled) |User |✅ |❌ |❌ + +|A user has reached a new badge level (if badges are enabled) |User |✅ |❌ |❌ + +|A user has been officialized |User |❌ |❌ |✅ + +|A user asked their data export |User |✅ |❌ |❌ + +|A user I follow endorsed a resource |User |❌ |✅ |❌ + +|A public profile has been updated |User |❌ |✅ |❌ + +|A new user group has been created |User groupsfootnote:user-group[If user groups are enabled] |❌ |❌ |✅ + +|A user group has updated its profile |User groupsfootnote:user-group[] |❌ |❌ |✅ + +|A user has been invited to join a user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user has been promoted as group admin |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user requested to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request has been accepted to join the user group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|A user request to join the user group has been rejected |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The group admin has been demoted |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|The user has been removed from the group |User groupsfootnote:user-group[] |✅ |❌ |❌ + +|An admin of the assembly has added you as one of its members |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the assembly |Assemblies |✅ |❌ |❌ + +|You have been assigned a role for the participatory process |Processes |✅ |❌ |❌ + +|The phases dates have been updated |Processes |❌ |✅ |❌ + +|A new phase has been activated |Processes |❌ |✅ |❌ + +|You have been assigned a role for the conference |Conferences |✅ |❌ |❌ + +|The registration to the conference has been confirmed |Conferences |✅ |❌ |❌ + +|The registration for the conference is open |Conferences |❌ |✅ |❌ + +|The conference occupied slots are over X% |Conferences |❌ |❌ |✅ + +|The conference is taking place in 2 days |Conferences |❌ |✅ |❌ + +|The conference has been updated |Conferences |❌ |✅ |❌ + +|The election is now active for the participatory space |Elections |❌ |✅ |❌ + +|You are added as a trustee for the election |Elections |✅ |❌ |❌ + +|An admin has added you as trustee |Elections |✅ |❌ |❌ + +|Your vote was accepted |Elections |✅ |❌ |❌ + +|You have been assigned a role of the Polling Station |Elections |✅ |❌ |❌ + +|Here is your Access Code |Elections |✅ |❌ |❌ + +|A user I follow created an initiative |Initiatives |❌ |✅ |❌ + +|My initiative has been created |Initiatives |✅ |❌ |❌ + +|A user I follow endorsed an initiative |Initiatives |❌ |✅ |❌ + +|A user sent their initiative to technical validation |Initiatives |❌ |❌ |✅ + +|The initiative has changed its status |Initiatives |✅ |✅ |❌ + +|The signatures end date for the initiative have been extended |Initiatives |❌ |✅ |❌ + +|The request to be part of the promoter committee for the initiative has been accepted |Initiatives |✅ |❌ |❌ + +|The request to be part of the promoter committee for the initiative has been rejected |Initiatives |✅ |❌ |❌ + +|A user wants to join your initiative |Initiatives |✅ |❌ |❌ + +|The initiative has reached the signatures threshold |Initiatives |❌ |❌ |✅ + +|Your initiative has achieved the X% of signatures |Initiatives |❌ |✅ |❌ + +|The initiative has achieved the X% of signatures |Initiatives |✅ |❌ |❌ + +|The proposal has been included in a result |Accountability |❌ |✅ |❌ + +|The result progress has been updated |Accountability |❌ |✅ |❌ + +|A post has been published |Blogs |❌ |✅ |❌ + +|The budget is now active |Budgets |❌ |✅ |❌ + +|A resource has a comment |Comments |❌ |✅ |❌ + +|A user group has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has left a comment on a resource |Comments |❌ |✅ |❌ + +|A user has replied your comment |Comments |✅ |❌ |❌ + +|A group you belong to has been mentioned |Comments |✅ |❌ |❌ + +|You have been mentioned |Comments |✅ |❌ |❌ + +|Your comment in has been upvoted |Comments |✅ |❌ |❌ + +|Your comment in has been downvoted |Comments |✅ |❌ |❌ + +|A debate has been created |Debates |❌ |✅ |❌ + +|Debate creation is enabled for participants |Debates |❌ |✅ |❌ + +|Debate creation is no longer active |Debates |❌ |✅ |❌ + +|The debate was closed |Debates |✅ |✅ |❌ + +|A meeting has been created |Meetings |❌ |✅ |❌ + +|A meeting was closed |Meetings |✅ |✅ |❌ + +|A meeting was updated |Meetings |❌ |✅ |❌ + +|Your meeting's registration has been confirmed |Meetings |✅ |❌ |❌ + +|The allocated slots for the meeting are over X% |Meetings |❌ |❌ |✅ + +|The meeting has enabled registrations |Meetings |❌ |✅ |❌ + +|The registration code for the meeting has been validated. |Meetings |✅ |❌ |❌ + +|The meeting will start in less than 48h |Meetings |❌ |✅ |❌ + +|A new proposal has been published |Proposals |❌ |✅ |❌ + +|Proposal creation is open |Proposals |❌ |✅ |❌ + +|Proposal supports are open |Proposals |❌ |✅ |❌ + +|Proposal endorsements are open |Proposals |❌ |✅ |❌ + +|Someone has left a note on the proposal |Proposals |❌ |❌ |✅ + +|A proposal is currently being evaluated |Proposals |✅ |✅ |❌ + +|A proposal has been rejected |Proposals |✅ |✅ |❌ + +|A proposal has been accepted |Proposals |✅ |✅ |❌ + +|An admin has updated the scope of your proposal |Proposals |✅ |❌ |❌ + +|An admin has updated the category of your proposal |Proposals |✅ |❌ |❌ + +|A proposal has been mentioned |Proposals |✅ |❌ |❌ + +|A user requested access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|You have been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been rejected to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user has been accepted to access as a contributor |Proposal drafts |✅ |❌ |❌ + +|A user withdrawn the collaborative draft |Proposal drafts |✅ |❌ |❌ + +|An amendment has been rejected |Amendmentsfootnote:amendments[If amendments are enabled] |✅ |✅ |❌ + +|An amendment has been accepted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been created |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|An amendment has been promoted |Amendmentsfootnote:amendments[] |✅ |✅ |❌ + +|A sortition has been created |Sortitions |❌ |✅ |❌ + +|A survey has been opened |Surveys |❌ |✅ |❌ + +|A survey has been closed |Surveys |❌ |✅ |❌ +|=== \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/global_moderations.adoc b/docs/pt/modules/admin/pages/global_moderations.adoc index bb3d553310..ce8d81dee3 100644 --- a/docs/pt/modules/admin/pages/global_moderations.adoc +++ b/docs/pt/modules/admin/pages/global_moderations.adoc @@ -36,8 +36,8 @@ the https://www.decidim.barcelona/pages/terms-and-conditions[Terms of Service] s > * to create multiple users by pretending to be different people (astroturfing). Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant -profile. After a participant has clicked in this action then she needs to provide a -reason why she's making this report: +profile. After a participant has clicked in this action then they need to provide a +reason why they are making this report: * Contains clickbait, advertising, scams or script bots. * Contains racism, sexism, slurs, personal attacks, death threats, suicide requests or any form of hate speech. diff --git a/docs/pt/modules/admin/pages/help_sections.adoc b/docs/pt/modules/admin/pages/help_sections.adoc index 7e942f55d7..9be6d5e3d7 100644 --- a/docs/pt/modules/admin/pages/help_sections.adoc +++ b/docs/pt/modules/admin/pages/help_sections.adoc @@ -1,6 +1,6 @@ = Help sections -The first time a visitor goes to any Space page she'll see an information box about what's this Space about. +The first time a visitor goes to any Space page they will see an information box about what's this Space about. This is how the information box is shown to participants and visitors: diff --git a/docs/pt/modules/admin/pages/newsletters.adoc b/docs/pt/modules/admin/pages/newsletters.adoc index 7c3c069551..cddc909cf4 100644 --- a/docs/pt/modules/admin/pages/newsletters.adoc +++ b/docs/pt/modules/admin/pages/newsletters.adoc @@ -141,8 +141,8 @@ the selected participatory spaces in the list * Sending the newsletter to all the participants that have selected an scope in their "My interests" settings in their account. -It's important to note that even if a participant has confirmed its account and -is following the space, the system will not send her a newsletter email if she +It's important to note that even if a participant has confirmed their account and +is following the space, the system will not send them a newsletter email if they haven't activated the "I want to receive newsletters". image::newsletter_select_recipients.png[Newsletter select recipients] diff --git a/docs/pt/modules/admin/pages/pages.adoc b/docs/pt/modules/admin/pages/pages.adoc index 70e77220cd..b68fbc4592 100644 --- a/docs/pt/modules/admin/pages/pages.adoc +++ b/docs/pt/modules/admin/pages/pages.adoc @@ -100,11 +100,11 @@ image::pages_backend_tos_change.png[Backend: ToS change] image::pages_frontend_tos_change.png[Frontend: ToS change] -If a participant rejects to accept the terms, then she has three options: +If a participant rejects to accept the terms, then they have three options: -. To review this again later. It signs her out automatically. +. To review this again later. It signs them out automatically. . To download their personal data -. To delete her account +. To delete their account image::pages_frontend_tos_reject.png[Frontend: ToS reject] diff --git a/docs/pt/modules/admin/pages/participants/admins.adoc b/docs/pt/modules/admin/pages/participants/admins.adoc index f88bcff92b..0746ef9183 100644 --- a/docs/pt/modules/admin/pages/participants/admins.adoc +++ b/docs/pt/modules/admin/pages/participants/admins.adoc @@ -11,7 +11,7 @@ Here you can: * see when was the last time an administrator logged in For inviting a new administrator, you need to go to the button "New user" and fill -the form with the admin username, email and which role will she have: +the form with the admin username, email and which role will they have: * Admin: to give full access to the platform * Participant manager: to give permission to only do xref:admin:participants/impersonations.adoc[Impersonations] diff --git a/docs/pt/modules/admin/pages/participants/authorizations.adoc b/docs/pt/modules/admin/pages/participants/authorizations.adoc index 3937fffc92..022397e249 100644 --- a/docs/pt/modules/admin/pages/participants/authorizations.adoc +++ b/docs/pt/modules/admin/pages/participants/authorizations.adoc @@ -8,7 +8,7 @@ With authorizations an administrator can define different permissions so partici For instance you can configure that only participants who have verified herselves by their identity documents can vote on proposals in a participatory process. -A participant can see which authorizations does she have available in her account settings. +A participant can see which authorizations do they have available in their account settings. image:authorizations_account.png[Authorizations in participants account] diff --git a/docs/pt/modules/admin/pages/participants/authorizations/census.adoc b/docs/pt/modules/admin/pages/participants/authorizations/census.adoc index b7e2cfbb9d..bc81ab9578 100644 --- a/docs/pt/modules/admin/pages/participants/authorizations/census.adoc +++ b/docs/pt/modules/admin/pages/participants/authorizations/census.adoc @@ -15,7 +15,7 @@ In the admin panel, the administrator can review the request by going to the "Or image:authorizations_organization_census.png[Organization's census in admin panel] -After the CSV is imported then the administrator can see how many participants where imported. She can also delete this +After the CSV is imported then the administrator can see how many participants where imported. They can also delete this imported census. image:authorizations_organization_census_imported.png[Imported CSV] @@ -29,6 +29,6 @@ image:authorizations_organization_census_account.png[Organization's census in pa == 3. The participant is verified (or not) -After is verified, as with other verifications, she can see it in her account settings. +After is verified, as with other verifications, they can see it in their account settings. image:authorizations_organization_census_verified.png[Verified by organization's census] \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/participants/authorizations/code_postal_letter.adoc b/docs/pt/modules/admin/pages/participants/authorizations/code_postal_letter.adoc index 953c5c0eb0..7ad078d0f9 100644 --- a/docs/pt/modules/admin/pages/participants/authorizations/code_postal_letter.adoc +++ b/docs/pt/modules/admin/pages/participants/authorizations/code_postal_letter.adoc @@ -1,7 +1,7 @@ = Code by postal letter authorization -This authorization allows a participant to request for a verification code to be sent to its address, to confirm that she -lives or works in this place. She'll need to then fill the code in the platform. +This authorization allows a participant to request for a verification code to be sent to its address, to confirm that they +live or work in this place. They will need to then fill the code in the platform. The process is: @@ -9,16 +9,16 @@ The process is: . An administrator sends the letter to their address with the verification code. . An administrator marks the letter as sent. . Once you mark the letter as sent, the participant will be able to introduce the code. -. If this code matchs, then she gets verified. +. If this code matchs, then they get verified. == 1. A participant request the verification code By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for filling in her full address to request the verification code. +a participant can see the form for filling in their full address to request the verification code. image:authorizations_code_postal_letter_request.png[Code by postal letter request by participant] -If she tries to edit it, she'll see this message: +If they try to edit it, they will see this message: image:authorizations_code_postal_letter_edit.png[Edit the postal letter request] @@ -31,17 +31,17 @@ In the admin panel, the administrator can review the request by going to the "Co image:authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in admin] -Here she can see the verification code and can send it to the participant by mail. After the code is sent she can mark it +Here they can see the verification code and can send it to the participant by mail. After the code is sent they can mark it as sent with the icon image:action_mark_as_sent.png[Mark as sent]. It'll also show when the letter was sent. == 3. A participant fills in the verification code -After the participant has received the code, she can go to it's account settings and click in the "Code by postal letter" +After the participant has received the code, they can go to their account settings and click in the "Code by postal letter" verfication method. image:authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account] -Then she'll see the form for confirming the code. +Then they will see the form for confirming the code. image:authorizations_code_postal_letter_confirm.png[Code by postal letter confirmation form] @@ -52,6 +52,6 @@ If the verification code matches, then the participant will see the message "Con On the other hand, if the verification code doesn't match, then the participant will see the message "Your verification code doesn't match ours. Please double-check the letter we sent to you." -After is verified, as with other verifications, she can see it in her account settings. +After is verified, as with other verifications, they can see it in their account settings. image:authorizations_code_postal_letter_verified.png[Verified by code by postal letter] \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/participants/authorizations/identity_documents.adoc b/docs/pt/modules/admin/pages/participants/authorizations/identity_documents.adoc index 2502903d6a..bff9992031 100644 --- a/docs/pt/modules/admin/pages/participants/authorizations/identity_documents.adoc +++ b/docs/pt/modules/admin/pages/participants/authorizations/identity_documents.adoc @@ -6,7 +6,7 @@ they could be a driver's license, a passport, a national identity card, a club m These documents will be reviewed by an administrator to accept or reject them. It's possible to do this process in two ways: Online or Offline. * Online: the participant will be asked to upload the documents, and the administrator will review these documents. -* Offline: the participant will be asked to fill in some data, and then she'll need to go to a presential place to show her documents face to face. +* Offline: the participant will be asked to fill in some data, and then they will need to go to a presential place to show their documents face to face. == Configuration @@ -42,13 +42,13 @@ The process is: . Participants fill in their document type and number and upload a copy of their document. . An administrator fills in the information present in the uploaded image. . The information should match whatever the user filled in. -. If the administrator can't clearly see the information or she can't get it verified, she can reject the request and +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and the user will be able to fix it. -=== 1. A participant fill in the document information and upload a copy of her document +=== 1. A participant fill in the document information and uploads a copy of their document By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for uploading a copy of her document. She also needs to fill in her document type and number. +a participant can see the form for uploading a copy of their document. They also need to fill in their document type and number. image:authorizations_id_document_online.png[ID document authorization online form] @@ -69,7 +69,7 @@ image:authorizations_id_document_online_confirm.png[ID document authorization on There are two actions an admin can do: * Accept: the participant will be fully authorized. -* Reject: the participant will be prompted to amend her documents +* Reject: the participant will be prompted to amend their documents If the request is rejected then the participant can provide other pictures or document. @@ -84,7 +84,7 @@ The process is: specific time to show their documents. . An administrator go to the "Offline verification" panel and fills in the information present in the physical documents. . The information should match whatever the user filled in. -. If the administrator can't clearly see the information or she can't get it verified, she can reject the request and +. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and the user will be able to fix it. For this authorization to work, an administrator need to first configure it in the admin panel with the instructions explaining @@ -95,7 +95,7 @@ image:authorizations_id_document_configuration_offline.png[ID document authoriza === 1. A participant fill in the document information and follow the instructions By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can see the form for filling in her document type and number. +a participant can see the form for filling in their document type and number. image:authorizations_id_document_offline_request.png[ID document authorization offline form] @@ -105,7 +105,7 @@ In the admin panel, the administrator can review the request by clicking in the image:authorizations_id_document_offline_button.png[ID document authorization offline button in admin] -Then she'll need to fill some data provided by the participant and by reviewing the document physically provided by her. +Then they will need to fill some data provided by the participant and by reviewing the document physically provided by them. image:authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in admin] @@ -130,12 +130,12 @@ image:authorizations_id_document_offline_confirm.png[ID document authorization o === 3. The request is accepted or rejected In the cases where the verifications don't match (meaning that the email or the document number provided by the -participant and the ones filled by the administrators aren't the same), then the participant need to ammend it with her +participant and the ones filled by the administrators aren't the same), then the participant needs to amend it with their user account. == Both It's also possible to enable both of these verifications methods. In this case, the participant will be asked to choose -which kind of verification she wants to do. +which kind of verification they want to do. image:authorizations_id_document_account_choose.png[Choose ID document verification kind] \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/participants/groups.adoc b/docs/pt/modules/admin/pages/participants/groups.adoc index 3201f6fac9..3a40bc859e 100644 --- a/docs/pt/modules/admin/pages/participants/groups.adoc +++ b/docs/pt/modules/admin/pages/participants/groups.adoc @@ -4,7 +4,7 @@ An user group is a group of participants. Depending in the installation and the == Creation -This action is done by **a participant**. She needs to go to their profile and in the sidebar there's a button that says "Create group": +This action is done by **a participant**. They need to go to their profile and in the sidebar there's a button that says "Create group": image:user_sidebar.png[User sidebar] @@ -48,7 +48,7 @@ image:user_group_new_form.png[New user group form] == Membership -After a group has been created, it's possible to invite participants to become members of the group. After a participant has accepted to be part of this group then she can become an admin. +After a group has been created, it's possible to invite participants to become members of the group. After a participant has accepted to be part of this group then they can become an admin. The actions that can be done by a participant in the user group are: diff --git a/docs/pt/modules/admin/pages/participants/impersonations.adoc b/docs/pt/modules/admin/pages/participants/impersonations.adoc index 9cd1788be5..05979cfe5f 100644 --- a/docs/pt/modules/admin/pages/participants/impersonations.adoc +++ b/docs/pt/modules/admin/pages/participants/impersonations.adoc @@ -36,7 +36,7 @@ After this data is confirmed then there'll be a session for the participant for image::participants_impersonations_user.png[Impersonated user session] Finally, it's also possible to Promote a participant, meaning that after a -participant has been managed, an administrator can add the email and send her +participant has been managed, an administrator can add the email and send them an Invitation: image::participants_impersonations_promotion.png[Admin's promotion Impersonations] \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/participants/participants.adoc b/docs/pt/modules/admin/pages/participants/participants.adoc index e76ab358b4..64e5d2ec77 100644 --- a/docs/pt/modules/admin/pages/participants/participants.adoc +++ b/docs/pt/modules/admin/pages/participants/participants.adoc @@ -2,7 +2,7 @@ In this page an administrator can: -* Block a participant, for instance because she's spamming or acting against the Terms of Service +* Block a participant, for instance because they are spamming or acting against the Terms of Service * Contact a participant with Decidim private messages (Conversations) * Officialize a participant * See its email @@ -48,7 +48,7 @@ blocking this participant: image:participants_block_user_justification.png[Justificate the blocked user action] -Once a blocked participant tries to log-in she'll see an error message: +Once a blocked participant tries to log-in they will see an error message: image:participants_block_user_alert.png[Message shown to blocked user] @@ -58,7 +58,7 @@ See more at xref:admin:participants/reported_users.adoc[Reported users] === Show email address -After clicking this option, the admin will see a modal. She'll have to click in +After clicking this option, the admin will see a modal. They will have to click in button "Show email address". image:participants_show_email.png[Modal in show email] diff --git a/docs/pt/modules/admin/pages/participants/reported_users.adoc b/docs/pt/modules/admin/pages/participants/reported_users.adoc index 6616b10c2b..855316b7f4 100644 --- a/docs/pt/modules/admin/pages/participants/reported_users.adoc +++ b/docs/pt/modules/admin/pages/participants/reported_users.adoc @@ -8,8 +8,8 @@ A participant can be blocked from the xref:participants/participants.adoc[partic section in the admin panel] or through this "Reported users" section. Anyone can propose a moderation in Decidim, through the "Flag" icon in the participant -profile. After a participant has clicked in this action she needs to provide a -reason why she's making this report: +profile. After a participant has clicked in this action they need to provide a +reason why they are making this report: * Contains clickbait, advertising, scams or script bots. * Contains racism, sexism, slurs, personal attacks, death threats, suicide requests @@ -26,7 +26,7 @@ blocking this participant: image:participants_block_user_justification.png[Justificate the blocked user action] -Once a blocked participant tries to log-in she'll see an error message: +Once a blocked participant tries to log-in they will see an error message: image:participants_block_user_alert.png[Message shown to blocked user] diff --git a/docs/pt/modules/admin/pages/participants/verifications_conflicts.adoc b/docs/pt/modules/admin/pages/participants/verifications_conflicts.adoc index 1e14b977f6..4e6afbfb07 100644 --- a/docs/pt/modules/admin/pages/participants/verifications_conflicts.adoc +++ b/docs/pt/modules/admin/pages/participants/verifications_conflicts.adoc @@ -4,8 +4,8 @@ There are cases depending on which kind of verifications you've enabled that the For instance: -. A participant get xref:admin:participants/impersonations.adoc[impersonated], and she doesn't provide an email -. Then she creates an account and tries to verify herself with the Census verification +. A participant get xref:admin:participants/impersonations.adoc[impersonated], and they don't provide an email +. Then they create an account and try to verify themselves with the Census verification For security, we try to be extra cautious in these cases, and we want that an administrator reviews these verifications. As you can see, this depends a lot on which kind of verifications you've enabled in your organization, so it's easy to say @@ -17,7 +17,7 @@ image:verifications_conflicts.png[Verification's conflicts panel] An administrator can review these conflicts by clicking in the Transfer user image:action_transfer_user.png[Transfer user] icon. -Then she'll see the Transfer user form, where she can provide a reason for the transfer. +Then they will see the Transfer user form, where they can provide a reason for the transfer. image:verifications_conflicts_transfer_user.png[] diff --git a/docs/pt/modules/admin/pages/scopes.adoc b/docs/pt/modules/admin/pages/scopes.adoc index e189ca92cb..a528c1eb9f 100644 --- a/docs/pt/modules/admin/pages/scopes.adoc +++ b/docs/pt/modules/admin/pages/scopes.adoc @@ -96,7 +96,7 @@ On a participatory space which concerns only one of the cities, you will be able === User interests and Newsletters -A Participant can choose which Scopes she wants to follow in its account. +A Participant can choose which Scopes they want to follow in its account. image:account_my_interests.png[Account: my interests] diff --git a/docs/pt/modules/admin/pages/spaces/assemblies/members.adoc b/docs/pt/modules/admin/pages/spaces/assemblies/members.adoc index 64a7159a8f..6668e828db 100644 --- a/docs/pt/modules/admin/pages/spaces/assemblies/members.adoc +++ b/docs/pt/modules/admin/pages/spaces/assemblies/members.adoc @@ -28,7 +28,7 @@ image:assembly_members_new_form.png[Assembly members new form] |Participant type |Required -|Wheter this assembly member is non-participant or existing participant. Does she already have an account created on the platform? +|Wheter this assembly member is non-participant or existing participant. Do they already have an account created on the platform? |Full name |Required if it's non-participant. diff --git a/docs/pt/modules/admin/pages/spaces/conferences/registrations/invites.adoc b/docs/pt/modules/admin/pages/spaces/conferences/registrations/invites.adoc index bd02c5da95..4ffe30d645 100644 --- a/docs/pt/modules/admin/pages/spaces/conferences/registrations/invites.adoc +++ b/docs/pt/modules/admin/pages/spaces/conferences/registrations/invites.adoc @@ -18,7 +18,7 @@ image:spaces/conferences/invite_participant_form.png[Invite a participant form] |Attendee type |Required -|Wheter this invited person is a non-existing or existing participant. Does she already have an account created on the platform? +|Wheter this invited person is a non-existing or existing participant. Do they already have an account created on the platform? |Name |Required if it's a non-existing participant. diff --git a/docs/pt/modules/admin/pages/spaces/conferences/registrations/types.adoc b/docs/pt/modules/admin/pages/spaces/conferences/registrations/types.adoc index 1625887826..e1756b8391 100644 --- a/docs/pt/modules/admin/pages/spaces/conferences/registrations/types.adoc +++ b/docs/pt/modules/admin/pages/spaces/conferences/registrations/types.adoc @@ -51,6 +51,6 @@ image:spaces/conferences/registration_types_backend.png[Manage registration type |Select conference meetings |=== -If the participant is already logged in then she'll see her username and email in the registration page. +If the participant is already logged in then they will see their username and email in the registration page. image:spaces/conferences/registration_types_frontend_w_user.png[Select registration type with user account] \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/spaces/conferences/registrations/users.adoc b/docs/pt/modules/admin/pages/spaces/conferences/registrations/users.adoc index 33dc8d6b46..24e2468fc2 100644 --- a/docs/pt/modules/admin/pages/spaces/conferences/registrations/users.adoc +++ b/docs/pt/modules/admin/pages/spaces/conferences/registrations/users.adoc @@ -16,12 +16,12 @@ It's possible to export the registrations in multiple formats: CSV, JSON, and XL == Flow . A participant registers to the conference -. She receives a pending registration notification +. They receive a pending registration notification image:spaces/conferences/user_registration_pending_notification.png[Notification for pending user registration] -. She receives a pending registration email +. They receive a pending registration email image:spaces/conferences/user_registration_pending_email.png[Email for pending user registration] . An administrator reviews and confirms the registration with the image:action_check.png[Confirm] button . The participant receives a confirmed registration notification image:spaces/conferences/user_registration_confirmed_notification.png[Notification for confirmed user registration] -. She receives a confirmed registration email with an calendar file (.ICS). +. They receive a confirmed registration email with an calendar file (.ICS). image:spaces/conferences/user_registration_confirmed_email.png[Email for confirmed user registration] \ No newline at end of file diff --git a/docs/pt/modules/admin/pages/spaces/conferences/speakers.adoc b/docs/pt/modules/admin/pages/spaces/conferences/speakers.adoc index f62160a3e8..339f5a7256 100644 --- a/docs/pt/modules/admin/pages/spaces/conferences/speakers.adoc +++ b/docs/pt/modules/admin/pages/spaces/conferences/speakers.adoc @@ -26,7 +26,7 @@ image:spaces/conferences/new_speaker.png[Conferences speakers] |Participant type |Required -|Wheter this speaker is a non-participant or existing participant. Does she already have an account created on the platform? +|Wheter this speaker is a non-participant or existing participant. Do they already have an account created on the platform? |Full name |Required if it's non-participant. diff --git a/docs/pt/modules/admin/pages/spaces/initiatives.adoc b/docs/pt/modules/admin/pages/spaces/initiatives.adoc index 7abb57a326..f9dec1da31 100644 --- a/docs/pt/modules/admin/pages/spaces/initiatives.adoc +++ b/docs/pt/modules/admin/pages/spaces/initiatives.adoc @@ -90,7 +90,7 @@ image:admin_initiative_type.png[New initiative type form] |Collect participant personal data on signature |Optional -|Adds a step to the signature process. When a participant clicks on the signature button, she'll be redirected to a form asking for some personal data. This will be used with the PDF export action after the recollection period has ended. +|Adds a step to the signature process. When a participant clicks on the signature button, they will be redirected to a form asking for some personal data. This will be used with the PDF export action after the recollection period has ended. |Legal information about the collection of personal data |Depends on whether the option "Collect participant personal data on the signature" is checked @@ -104,7 +104,7 @@ image:admin_initiative_type.png[New initiative type form] |Authorization to verify document number on signatures |Optional -|When a participant is making the signature process, will she be asked for an authorization? +|When a participant is making the signature process, will they be asked for an authorization? |Add SMS code validation step to the signature process | @@ -137,7 +137,7 @@ This action is done by **the author**. The author is a participant that creates image:initiative_list.png[Initiatives list] -For creating an initiative, a participant must click in the "New initiative" button. Then she'll have a wizard with multiple steps: +For creating an initiative, a participant must click in the "New initiative" button. Then they will have a wizard with multiple steps: === 1.1 Choose the initiative type @@ -181,7 +181,7 @@ image:initiative_print.png[Print an initiative] ==== Technical validation -After the author has reviewed how the initiative will look, she can send it to technical validation. +After the author has reviewed how the initiative will look, they can send it to technical validation. image:initiative_send_to_technical_validation.png[Send initiative to technical validation] diff --git a/docs/pt/modules/admin/pages/spaces/processes/types.adoc b/docs/pt/modules/admin/pages/spaces/processes/types.adoc new file mode 100644 index 0000000000..2e1c452b2b --- /dev/null +++ b/docs/pt/modules/admin/pages/spaces/processes/types.adoc @@ -0,0 +1,39 @@ += 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. + +Process Types work similarly to xref:admin:spaces/assemblies.adoc#_assemblies_types[Assembly types]. + +== New process type form + +For creating a new process type: + +. 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 + +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"] + + +.New participatory process type form: General information +|=== +|Field |Type |Description + +|Title +|Required +|Title of the participatory process type. For instance, "Consultative". +|=== + +== 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. + +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"] + +== Process type filter + +In the front-end if there is at least one Process Type defined, a filter shows, allowing filtering of Processes. + +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"] \ No newline at end of file diff --git a/docs/pt/modules/admin/partials/page_admins.adoc b/docs/pt/modules/admin/partials/page_admins.adoc index e4527970ba..db05cf9da8 100644 --- a/docs/pt/modules/admin/partials/page_admins.adoc +++ b/docs/pt/modules/admin/partials/page_admins.adoc @@ -28,7 +28,7 @@ image:spaces/admins_form.png[New space admin form] |Email |Required -|What is the email of the new admin, so she can receive the invitation. +|What is the email of the new admin, so they can receive the invitation. |Role |Required @@ -59,7 +59,7 @@ image:spaces/admins_role_moderator.png[Process moderators view] === Process valuators -A space valuator can review the proposals of the space. She can: +A space valuator can review the proposals of the space. They can: * change the status of the proposals, by accepting or rejecting them * add a monetary value to the proposals, so they can be voted with the budget component. diff --git a/docs/pt/modules/admin/partials/page_private_participants.adoc b/docs/pt/modules/admin/partials/page_private_participants.adoc index 90580396be..f5d5983d88 100644 --- a/docs/pt/modules/admin/partials/page_private_participants.adoc +++ b/docs/pt/modules/admin/partials/page_private_participants.adoc @@ -65,11 +65,11 @@ image:spaces/private_participants_actions.png[Private participants actions] == Invitation -When a participant was invited she'll get an email with a link for accepting the invitation: +When a participant was invited they will get an email with a link for accepting the invitation: image:spaces/private_participants_email_invite.png[Email invitation of a private participant] -After clicking in this email, she'll have to fill a form for setting her password, accepting the Terms of Service and giving -her consent if she wants to receive newsletters. +After clicking in this email, they will have to fill a form for setting their password, accepting the Terms of Service and giving +their consent if they want to receive newsletters. image:spaces/private_participants_user_registration_form.png[User registration form of a private participant] \ No newline at end of file diff --git a/docs/pt/modules/features/pages/general-description.adoc b/docs/pt/modules/features/pages/general-description.adoc index c54b27a835..e34d230c73 100644 --- a/docs/pt/modules/features/pages/general-description.adoc +++ b/docs/pt/modules/features/pages/general-description.adoc @@ -50,7 +50,7 @@ Administrators can *manage permissions* for registered or verified users selecti There are different types of administrators: *administrators* of the whole platform or of specific spaces and components, they can also be *moderators* (with the exclusive power of moderating proposals, comments or debates) or *collaborators* that can read unpublished content, create notes and responses to proposals. -Participants can register as an *individual* or as a *collective* (associations, working groups, etc. within the main organization). User *groups* might also be created so that individuals can be associated to a *group*. Decidim allows participants belonging to such a group to express or act individually or embodying the group identity: when an action is carried the platform prompts the participant to choose wether she wants to act as herself or as the group she belong to. +Participants can register as an *individual* or as a *collective* (associations, working groups, etc. within the main organization). User *groups* might also be created so that individuals can be associated to a *group*. Decidim allows participants belonging to such a group to express or act individually or embodying the group identity: when an action is carried the platform prompts the participant to choose wether they want to act as themselves or as the group they belong to. Participants can not only navigate the content of Decidim through the top menu and move down the architectural hierarchy, from a space to its different components; they can also get information through the *search engine*, or via *notifications*. Participants can also talk to each other by internal messaging or *chat*. diff --git a/docs/pt/modules/releases/pages/index.adoc b/docs/pt/modules/releases/pages/index.adoc index c9f9bc7423..f0af39d4f1 100644 --- a/docs/pt/modules/releases/pages/index.adoc +++ b/docs/pt/modules/releases/pages/index.adoc @@ -1,4 +1,4 @@ -= Releases += Release notes Here you can find all the blog posts for every minor release. @@ -6,6 +6,9 @@ You can find all the releases (with minor and patches) at https://rubygems.org/gems/decidim/versions[RubyGems.org] and https://github.com/decidim/decidim/releases[GitHub]. +* https://decidim.org/blog/2023-12-20-new-version-0-28-0/[Version 0.28 (2022-12-20)] +* https://decidim.org/blog/2022-09-30-new-version-0-27-0/[Version 0.27 (2022-09-30)] +* https://decidim.org/blog/2022-02-22-new-version-0-26-0/[Version 0.26 (2022-02-22)] * https://decidim.org/blog/2021-10-07-new-version-0-25-0/[Version 0.25 (2021-10-07)] ** xref:develop:guide_migrate_webpacker_module.adoc[Migrate to Webpacker a module] ** xref:develop:guide_migrate_webpacker_app.adoc[Migrate to Webpacker an instance app]