Skip to content

Commit

Permalink
Fix linter issues
Browse files Browse the repository at this point in the history
  • Loading branch information
paulinebessoles committed Nov 14, 2024
1 parent d8702f4 commit d293121
Show file tree
Hide file tree
Showing 9 changed files with 78 additions and 77 deletions.
12 changes: 6 additions & 6 deletions docs/en/modules/admin/pages/participants/admins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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.
12 changes: 6 additions & 6 deletions docs/en/modules/admin/pages/participants/authorizations.adoc
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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]

Expand All @@ -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].
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
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:

. Participant request a verification code to be sent to an 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 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

Expand All @@ -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]

Expand All @@ -29,17 +29,17 @@ 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.

== 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]

Expand All @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -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]
Expand All @@ -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
|===
Expand All @@ -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"

Expand All @@ -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]
17 changes: 9 additions & 8 deletions docs/en/modules/admin/pages/participants/groups.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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]

Expand Down Expand Up @@ -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]

Expand All @@ -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.
Loading

0 comments on commit d293121

Please sign in to comment.