From d2931210e4d2fb35820b117ad5a35ad13d43af61 Mon Sep 17 00:00:00 2001 From: paulinebessoles Date: Thu, 14 Nov 2024 14:02:40 +0100 Subject: [PATCH] Fix linter issues --- .../admin/pages/participants/admins.adoc | 12 +++--- .../pages/participants/authorizations.adoc | 12 +++--- .../participants/authorizations/census.adoc | 10 ++--- .../authorizations/code_postal_letter.adoc | 20 +++++----- .../authorizations/identity_documents.adoc | 38 +++++++++---------- .../admin/pages/participants/groups.adoc | 17 +++++---- .../pages/participants/impersonations.adoc | 24 ++++++------ .../pages/participants/participants.adoc | 14 +++---- .../participants/verifications_conflicts.adoc | 8 ++-- 9 files changed, 78 insertions(+), 77 deletions(-) diff --git a/docs/en/modules/admin/pages/participants/admins.adoc b/docs/en/modules/admin/pages/participants/admins.adoc index 41030b5ea..89d30a1f8 100644 --- a/docs/en/modules/admin/pages/participants/admins.adoc +++ b/docs/en/modules/admin/pages/participants/admins.adoc @@ -15,14 +15,14 @@ You can invite an already registered or a non registered participant. image:participants/admins_invite.png[Invite participant as administrator form] -.New admin form +.New administrator form |=== |Field |Type |Description |Name |Required -|Name of the administrator. If they already have an account, it will change for their account name automatically. +|Name of the administrator. If they already have an account, it changes automatically for their username. |Email |Required @@ -48,7 +48,7 @@ You can find all the administrators on the administrators list in the administra * *Creation date*: date of the participant account creation. You can filter and sort this list by clicking the "Filter" button and the columns headers. -You can also search for administrators by email, name or nickname in the search bar. +You can also search for administrators by email, name, or nickname in the search bar. === Actions @@ -67,8 +67,8 @@ You can also search for administrators by email, name or nickname in the search |=== -=== Revoke administror permissions +=== Revoke administrator permissions -When an administator doesn't need access anymore, you should revoke their rights by clicking the "Delete" button. -You need to confirm the rights deletion in order to completely remove their rights. +When an administrator doesn't need access anymore, you should revoke their rights by clicking the "Delete" button. +You need to confirm the rights deletion to completely remove their rights. Revoking administrator permissions don't delete the participant account. \ No newline at end of file diff --git a/docs/en/modules/admin/pages/participants/authorizations.adoc b/docs/en/modules/admin/pages/participants/authorizations.adoc index 569979024..46e21c3f3 100644 --- a/docs/en/modules/admin/pages/participants/authorizations.adoc +++ b/docs/en/modules/admin/pages/participants/authorizations.adoc @@ -1,20 +1,20 @@ = Authorizations Authorizations allow to give specific participation rights to participants who have completed a verification process. -This verification process can be direct, have multiple steps, be online or presential. +This verification process can be direct, have multiple steps, be online or in-person. For instance you can configure that only participants who have verified themselves by their identity documents can vote on proposals in a specific participatory process. NOTE: Several authorizations are available by default, but you can also develop your own authorizations. -== Enable / Disable authorizations +== Enable / disable authorizations To enable an authorization, you need to have access to the xref:configure:system.adoc[System panel] or ask your administrator. 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]. -Participants can access, update or delete their authorizations in their xref:admin:features/my_account/authorizations.adoc[account]. +Participants can access, update, or delete their authorizations in their xref:admin:features/my_account/authorizations.adoc[account]. == Verification methods @@ -29,7 +29,7 @@ more about xref:customize:authorizations.adoc[Authorizations in the Customize Gu == Authorizations revocation -A default Decidim installation will not have verified participants. +A default Decidim installation don't have verified participants. image::participants/authorizations_admin_default.png[Authorizations in a default installation] @@ -40,5 +40,5 @@ Then, an administrator can want to force participants to renew their verificatio image:participants/authorizations_admin_revocation.png[Authorizations revocation] -It's possible to revoke all the authorizations with "Revoke all", or to only revoke authorizations created before a given date. -Another possiblity is to revoke only the verifications for xref:admin:participants/impersonations.adoc[impersonated participants]. +It's possible to revoke all the authorizations with "Revoke all," or to only revoke authorizations created before a given date. +Another possibility is to revoke only the verifications for xref:admin:participants/impersonations.adoc[impersonated participants]. diff --git a/docs/en/modules/admin/pages/participants/authorizations/census.adoc b/docs/en/modules/admin/pages/participants/authorizations/census.adoc index ebed095f8..cc2f27f86 100644 --- a/docs/en/modules/admin/pages/participants/authorizations/census.adoc +++ b/docs/en/modules/admin/pages/participants/authorizations/census.adoc @@ -6,16 +6,16 @@ The process is as follows: . Participants go to their account and request to be verified . Only participants with an email in that CSV file can get verified -NOTE: This authorization is 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]. +NOTE: This authorization is too basic and you need more features related to CSV census imports? +Check all the CSV or file based authorizations in the https://decidim.org/modules/[Modules page]. == 1. CSV upload -In the admin panel, the administrator can upload a CSV file by going to the "Organization's census" in the "Participants" section. +In the administrator panel, you can upload a CSV file by clicking on "Organization's census" in the "Participants" section. -image::participants/authorizations_organization_census.png[Organization's census in admin panel] +image::participants/authorizations_organization_census.png[Organization's census in administrator panel] -After the CSV is imported then the administrator can see how many participants where imported. They can also delete this +After the CSV is imported then the administrator can see how many participants were imported. They can also delete this imported census. image::participants/authorizations_organization_census_imported.png[Imported CSV] diff --git a/docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc b/docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc index af4203474..faacc51af 100644 --- a/docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc +++ b/docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc @@ -3,7 +3,7 @@ This authorization allows a participant to request for a verification code to be sent to an address, to confirm that they live or work in this place. They then need to fill the received code in the platform. -NOTE: If you don't want to use this authorization, we advice you to disable it in the xref:admin:system.adoc[system panel]. +NOTE: If you don't want to use this authorization, you should turn it off in the xref:admin:system.adoc[system panel]. The process is: @@ -11,7 +11,7 @@ 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 is able to introduce the code. -. If this code matchs, then they get verified. +. If this code matches, then they get verified. == 1. Verification code request @@ -20,7 +20,7 @@ a participant can see the form requesting their full address. image::participants/authorizations_code_postal_letter_request.png[Code by postal letter request by participant] -If they try to edit it, they will see this message: +If they try to edit it, they see this message: image::participants/authorizations_code_postal_letter_edit.png[Edit the postal letter request] @@ -29,9 +29,9 @@ to contact a platform administrator. == 2. Administrator review -In the admin panel, the administrator can review the request by going to the "Code by postal letter" in the "Participants" section. +In the administration panel, the administrator can review the request by going to the "Code by postal letter" in the "Participants" section. -image::participants/authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in admin] +image::participants/authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in administration] Here they can see the verification code and can send it to the participant by postal letter. After the code is sent they can mark it as such with the icon image:icons/action_verify.png[Mark as sent]. It'll also show when the letter was sent. @@ -39,7 +39,7 @@ as such with the icon image:icons/action_verify.png[Mark as sent]. It'll also sh == 3. Participant validate the 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. +verification method. image::participants/authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account] @@ -49,11 +49,11 @@ image::participants/authorizations_code_postal_letter_confirm.png[Code by postal == 4. Code match -If the verification code matches, then the participant will see the message "Congratulations. You've been successfully verified". +If the verification code matches, then the participant sees 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." +On the other hand, if the verification code doesn't match, then the participant see an error asking to double-check the code in +the letter. -After is verified, as with other verifications, they can see it in their account settings. +After a participant is verified, as with other verifications, they can see it in their account settings. image::participants/authorizations_code_postal_letter_verified.png[Verified by code by postal letter] diff --git a/docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc b/docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc index 10007a724..72df53914 100644 --- a/docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc +++ b/docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc @@ -4,13 +4,13 @@ This authorization allows a participant to upload its identity documents into th These documents depend on the organization, they could be a driver's license, a passport, a national identity card, a club membership card, etc. -NOTE: If you don't want to collect any data, we advice you to disable this authorization in the xref:admin:system.adoc[system panel]. +NOTE: If you don't want to collect any data, you should turn it off in the xref:admin:system.adoc[system panel]. -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. +These documents are reviewed by an administrator who can accept or reject them. It's possible to do this process +in two ways: -* *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 +* *Online*: the participant is asked to upload the documents, and the administrator reviews these documents. +* *Offline*: the participant is asked to fill in some data, and then they need to go to a physical place to show their documents face to face. == Configuration @@ -42,7 +42,7 @@ 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 +. If the administrator can't 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. Participant authorization creation @@ -56,22 +56,22 @@ NOTE: You can change the document types options by xref:customize:code.adoc[cust === 2. Administrator document review -After this document is uploaded, an administrator can review it by going to the Identity documents section in the admin +After this document is uploaded, an administrator can review it by going to the Identity documents section in the administration panel. image::participants/authorizations_id_document_online_pending.png[ID document authorization pending online verification] After clicking on the verification id link or on the document, the administrator needs to review the image and fill in -the document numbe in the field. This number needs to match with the one provided by the participant. +the document number in the field. This number needs to match with the one provided by the participant. image:participants/authorizations_id_document_online_confirm.png[ID document authorization online confirmation form] === 3. Administrator decision -There are two actions an admin can do: +There are two actions an administrator can do: -* Verify: the system will check if the document numbers entered by administrator and user are the same. -* Reject: the participant will have to edit their authorization if they want to get verified. +* Verify: the system checks if the document numbers entered by administrator and user are the same. +* Reject: the participant have to edit their authorization if they want to get verified. If the request is rejected then the participant can provide other pictures or document. @@ -88,10 +88,10 @@ 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 they can't get it verified, they can reject the request and -the user will be able to fix it. +. If the administrator can't see the information or they can't get it verified, they can reject the request and +the user is then able to fix it. -For this authorization to work, an administrator need to first configure it in the admin panel with the instructions explaining +For this authorization to work, an administrator need to first configure it in the administration panel with the instructions explaining what the participant need to do to finish the verification process. image:participants/authorizations_id_document_configuration_offline.png[ID document authorization configuration: offline instructions] @@ -105,13 +105,13 @@ image:participants/authorizations_id_document_offline_request.png[ID document au === 2. Administrator document review -In the admin panel, the administrator can review the request by clicking the "Offline verification" button. +In the administration panel, the administrator can review the request by clicking the "Offline verification" button. -image::participants/authorizations_id_document_offline_button.png[ID document authorization offline button in admin] +image::participants/authorizations_id_document_offline_button.png[ID document authorization offline button in administration] Then they need to fill some data provided by the participant and review the document physically provided. -image::participants/authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in admin] +image::participants/authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in administration] .ID Documents authorization offline form |=== @@ -125,7 +125,7 @@ image::participants/authorizations_id_document_offline_confirm.png[ID document a |Required |Can be: ID or Passport -|Document number (with letter) +|Document number |Required |Document number of the participant. For instance, "12345678Z" @@ -139,7 +139,7 @@ user account. == Both -It's also possible to enable both of these verifications methods. In this case, the participant will be asked to choose +It's also possible to enable both of these verifications methods. In this case, the participant has to choose which kind of verification they want to do. image::participants/authorizations_id_document_account_choose.png[Choose ID document verification kind] diff --git a/docs/en/modules/admin/pages/participants/groups.adoc b/docs/en/modules/admin/pages/participants/groups.adoc index aff602ff7..360668a96 100644 --- a/docs/en/modules/admin/pages/participants/groups.adoc +++ b/docs/en/modules/admin/pages/participants/groups.adoc @@ -6,11 +6,11 @@ If an administrator verifies a user group, then all the user group administrator image::participants/user_group_frontend_show.png[Frontend: show a user group] -== Enable / Disable user groups +== Enable / disable user groups Administrators can enable or disable user groups in the xref:admin:configuration.adoc[Configuration] panel. -When enabled, participants will be able to create and manage groups from their profile. +When enabled, participants are able to create and manage groups from their profile. To learn more about how participants can do this, go to the xref:admin:features/my_public_profile.adoc[public profile] article. == Manage user groups @@ -22,10 +22,10 @@ When a participant creates a user group, it adds a line in the user groups list * *Phone*: phone number of the structure or the administrator of the user group. * *Participants count*: number of members of the user group. * *Created at*: date of the user group creation. -* *State*: state of the verification, can only be Pending, Verified or Rejected. +* *State*: state of the verification, can only be pending, verified, or rejected. You can filter and sort this list by clicking the "Filter" button and the columns headers. -You can also search for user groups by email, name or nickname in the search bar. +You can also search for user groups by email, name, or nickname in the search bar. image::participants/admin_user_group_verification.png[Admin panel: user group verifications] @@ -54,10 +54,11 @@ A user group can have three states: === Verify a group -To verify a group, an administrator should check that the group exists and is legitimate to have an entity on the platform. -Administrator can call the group administrator on the phone number provided, or check that the document number exists. +To verify a group, an administrator should verify that the group exists and is legitimate to have an entity on the platform. +Administrator can call the group administrator on the phone number provided, or verify that the document number exists. -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". +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::participants/user_group_verified.png[User group: verified icon] @@ -67,5 +68,5 @@ If you want to verify multiple user groups at once, you can do so with the "Veri image::participants/admin_user_group_verification_csv.png[Admin panel: user group verifications CSV] -There, you can upload a CSV file, formated with a unique column without headers, containing the user groups emails you want to verify. +There, you can upload a CSV file, with a unique column without headers, containing the user groups emails you want to verify. Only the groups that have confirmed their email and that have an email appearing in the CSV file will be verified. diff --git a/docs/en/modules/admin/pages/participants/impersonations.adoc b/docs/en/modules/admin/pages/participants/impersonations.adoc index 1adabb31d..a011a1943 100644 --- a/docs/en/modules/admin/pages/participants/impersonations.adoc +++ b/docs/en/modules/admin/pages/participants/impersonations.adoc @@ -1,11 +1,11 @@ = Participants impersonations -Sometimes, people don't have the time to create an account, or don't have the knwoledge or ability to use technological tools. +Sometimes, people don't have the time to create an account, or don't have the knowledge or ability to use technological tools. Impersonations allow administrators and participant managers to enable those persons to participate anyway. NOTE: In the code and the User Interface, *Impersonation* and *Managed Participants* are the same thing. -== Enable / Disable impersonations +== Enable / disable impersonations Impersonations are only available when at least one authorization is enabled for the organization. Indeed, they allow the system to search through a Verification system for an already existing participant, and to create @@ -13,19 +13,19 @@ a participant without the need for an email address. To enable an authorization, you need to have access to the xref:configure:system.adoc[System panel] or ask your administrator. -image::participants/participants_impersonations_backend_list_no_auth.png[Admin's Impersonations panel with no authorizations] +image::participants/participants_impersonations_backend_list_no_auth.png[Administrators Impersonations panel with no authorizations] -The different authorizations will give you different possibilities: +The different authorizations give you different possibilities: * View impersonation logs only: When Identity documents, Code by postal letter, and/or Organization's census are enabled * Impersonate existing and new users: Direct verification enabled, like example authorization or other custom direct authorizations. NOTE: 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]. +https://github.com/decidim/decidim/blob/develop/decidim-verifications/README.md[Decidim-verification README]. -image::participants/participants_impersonations_backend_list_logs.png[Admin's Impersonations panel with view log] +image::participants/participants_impersonations_backend_list_logs.png[Administrators Impersonations panel with view log] -image::participants/participants_impersonations_backend_list_button.png[Admin's Impersonations panel with impersonation action] +image::participants/participants_impersonations_backend_list_button.png[Administrators Impersonations panel with impersonation action] == Manage impersonations @@ -47,12 +47,12 @@ You can filter this list by clicking the "Filter" button and search for particip |image:icons/action_clock.png[View logs icon] |View logs -|To check the impersonation history of the participant. +|To view the impersonation history of the participant. |Available all the time. |image:icons/action_promote.png[Promote icon] |Promote -|To check the impersonation history of the participant. +|To view the impersonation history of the participant. |Available only for managed users. |=== @@ -61,7 +61,7 @@ You can filter this list by clicking the "Filter" button and search for particip Click the "Manage new participant" button. You are then able to enter the personal data to check against the verification: -image::participants/participants_impersonations_form.png[Admin's Impersonations form] +image::participants/participants_impersonations_form.png[Administrators Impersonations form] After this data is checked by the system, it opens a session for the participant for 30 minutes. A banner at the top of the page reminds the administrator that they are impersonating the participant, and the remaining time. @@ -70,7 +70,7 @@ image::participants/participants_impersonations_user.png[Impersonated user sessi === Promote a managed participant -Administrators can promote managed participants, in order to invite them to the create an account on the platform. +Administrators can promote managed participants, to invite them to the create an account on the platform. Click the "Promote" icon to be able to add an email address to the participant and invite them by email. -image::participants/participants_impersonations_promotion.png[Admin's promotion Impersonations] +image::participants/participants_impersonations_promotion.png[Administrators promotion Impersonations] diff --git a/docs/en/modules/admin/pages/participants/participants.adoc b/docs/en/modules/admin/pages/participants/participants.adoc index 205af33b1..6b39fb249 100644 --- a/docs/en/modules/admin/pages/participants/participants.adoc +++ b/docs/en/modules/admin/pages/participants/participants.adoc @@ -1,10 +1,10 @@ = Participants -Participants are all people with an account on the platform, whether they have confirmed their e-mail address or not. +Participants are all people with an account on the platform, whether they have confirmed their email address or not. 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) +* Contact a participant with Decidim private messages * Officialize a participant * Show a participant email @@ -21,7 +21,7 @@ You can find all the participants here, with: * *Reports*: number of reports by different users. You can filter and sort this list by clicking the "Filter" button and the columns headers. -You can also search for participants by email, name or nickname in the search bar. +You can also search for participants by email, name, or nickname in the search bar. === Actions @@ -67,23 +67,23 @@ A modal appears, with the name of the participant, and an hidden field. image:participants/participants_show_email.png[Modal in show email] -To show the email address, you need to click on the "Show" button. +To show the email address, you need to click the "Show" button. image:participants/participants_showed_email.png[Modal after the email is shown] -For administration transparency, this action is logged in the actvity logs. +For administration transparency, this action is logged in the activity logs. image:participants/participants_showed_email_admin_log.png[Admin activity log for show email] === Contact -To contact participants directly through the private messaging of the platform, click on the "Contact" icon. +To contact participants directly through the private messaging of the platform, click the "Contact" icon. image:participants/participants_conversation.png[Conversation with a participant]. === Officialize -This option is useful to recognize that a participant has a special status in the +This option is useful to recognize that a participant has a specific status in the platform. For instance, if someone is the city mayor, a city councillor, the president of an association, etc. diff --git a/docs/en/modules/admin/pages/participants/verifications_conflicts.adoc b/docs/en/modules/admin/pages/participants/verifications_conflicts.adoc index 34cb2c90c..59cd97829 100644 --- a/docs/en/modules/admin/pages/participants/verifications_conflicts.adoc +++ b/docs/en/modules/admin/pages/participants/verifications_conflicts.adoc @@ -7,9 +7,9 @@ For instance: . A participant get xref:admin:participants/impersonations.adoc[impersonated] with their data, but don't enter an email . Then they create an account, and try to verify themselves with the same verification -For security, we try to be extra cautious in these cases, and we want an administrator to review these potential conflicts. +For security, try to be extra cautious in these cases, and make sure an administrator reviews these potential conflicts. It depends a lot on which kind of verifications you've enabled in your organization, so most of the time an organization -will not see any conflicts in this panel. +don't see any conflicts appear in this panel. image:participants/verifications_conflicts.png[Verification's conflicts panel] @@ -23,7 +23,7 @@ In the verifications conflict panel, you can find all the conflicts, with: * *Attempts*: number of time the user tried to get verified with their data. * *Solved*: if the verification conflict was solved or not. -You can search for conflicts by participant email, name or nickname in the search bar. +You can search for conflicts by participant email, name, or nickname in the search bar. === Actions @@ -56,5 +56,5 @@ image:participants/verifications_conflicts_transfer_user.png[Transfer user form] |=== -After the user is transferred, both accounts, the managed one and the new one, will be merged into one, with the +After the user is transferred, both accounts, the managed one and the new one, is merged into one, with the email address entered in the form.