Skip to content

Commit d293121

Browse files
author
paulinebessoles
committed
Fix linter issues
1 parent d8702f4 commit d293121

9 files changed

+78
-77
lines changed

docs/en/modules/admin/pages/participants/admins.adoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ You can invite an already registered or a non registered participant.
1515

1616
image:participants/admins_invite.png[Invite participant as administrator form]
1717

18-
.New admin form
18+
.New administrator form
1919

2020
|===
2121
|Field |Type |Description
2222

2323
|Name
2424
|Required
25-
|Name of the administrator. If they already have an account, it will change for their account name automatically.
25+
|Name of the administrator. If they already have an account, it changes automatically for their username.
2626

2727
|Email
2828
|Required
@@ -48,7 +48,7 @@ You can find all the administrators on the administrators list in the administra
4848
* *Creation date*: date of the participant account creation.
4949

5050
You can filter and sort this list by clicking the "Filter" button and the columns headers.
51-
You can also search for administrators by email, name or nickname in the search bar.
51+
You can also search for administrators by email, name, or nickname in the search bar.
5252

5353
=== Actions
5454

@@ -67,8 +67,8 @@ You can also search for administrators by email, name or nickname in the search
6767

6868
|===
6969

70-
=== Revoke administror permissions
70+
=== Revoke administrator permissions
7171

72-
When an administator doesn't need access anymore, you should revoke their rights by clicking the "Delete" button.
73-
You need to confirm the rights deletion in order to completely remove their rights.
72+
When an administrator doesn't need access anymore, you should revoke their rights by clicking the "Delete" button.
73+
You need to confirm the rights deletion to completely remove their rights.
7474
Revoking administrator permissions don't delete the participant account.

docs/en/modules/admin/pages/participants/authorizations.adoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
= Authorizations
22

33
Authorizations allow to give specific participation rights to participants who have completed a verification process.
4-
This verification process can be direct, have multiple steps, be online or presential.
4+
This verification process can be direct, have multiple steps, be online or in-person.
55

66
For instance you can configure that only participants who have verified themselves by their identity documents can vote on
77
proposals in a specific participatory process.
88

99
NOTE: Several authorizations are available by default, but you can also develop your own authorizations.
1010

11-
== Enable / Disable authorizations
11+
== Enable / disable authorizations
1212

1313
To enable an authorization, you need to have access to the xref:configure:system.adoc[System panel] or ask your administrator.
1414
To understand more what are authorizations and how to configure them, please refer to the
1515
xref:customize:authorizations.adoc[Authorizations section in the Customize Guide].
1616

17-
Participants can access, update or delete their authorizations in their xref:admin:features/my_account/authorizations.adoc[account].
17+
Participants can access, update, or delete their authorizations in their xref:admin:features/my_account/authorizations.adoc[account].
1818

1919
== Verification methods
2020

@@ -29,7 +29,7 @@ more about xref:customize:authorizations.adoc[Authorizations in the Customize Gu
2929

3030
== Authorizations revocation
3131

32-
A default Decidim installation will not have verified participants.
32+
A default Decidim installation don't have verified participants.
3333

3434
image::participants/authorizations_admin_default.png[Authorizations in a default installation]
3535

@@ -40,5 +40,5 @@ Then, an administrator can want to force participants to renew their verificatio
4040

4141
image:participants/authorizations_admin_revocation.png[Authorizations revocation]
4242

43-
It's possible to revoke all the authorizations with "Revoke all", or to only revoke authorizations created before a given date.
44-
Another possiblity is to revoke only the verifications for xref:admin:participants/impersonations.adoc[impersonated participants].
43+
It's possible to revoke all the authorizations with "Revoke all," or to only revoke authorizations created before a given date.
44+
Another possibility is to revoke only the verifications for xref:admin:participants/impersonations.adoc[impersonated participants].

docs/en/modules/admin/pages/participants/authorizations/census.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ The process is as follows:
66
. Participants go to their account and request to be verified
77
. Only participants with an email in that CSV file can get verified
88

9-
NOTE: This authorization is too simple and you need more features related to CSV census imports?
10-
Check all the CSV or file based authorizations in our https://decidim.org/modules/[Modules page].
9+
NOTE: This authorization is too basic and you need more features related to CSV census imports?
10+
Check all the CSV or file based authorizations in the https://decidim.org/modules/[Modules page].
1111

1212
== 1. CSV upload
1313

14-
In the admin panel, the administrator can upload a CSV file by going to the "Organization's census" in the "Participants" section.
14+
In the administrator panel, you can upload a CSV file by clicking on "Organization's census" in the "Participants" section.
1515

16-
image::participants/authorizations_organization_census.png[Organization's census in admin panel]
16+
image::participants/authorizations_organization_census.png[Organization's census in administrator panel]
1717

18-
After the CSV is imported then the administrator can see how many participants where imported. They can also delete this
18+
After the CSV is imported then the administrator can see how many participants were imported. They can also delete this
1919
imported census.
2020

2121
image::participants/authorizations_organization_census_imported.png[Imported CSV]

docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc

+10-10
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
This authorization allows a participant to request for a verification code to be sent to an address, to confirm that they
44
live or work in this place. They then need to fill the received code in the platform.
55

6-
NOTE: If you don't want to use this authorization, we advice you to disable it in the xref:admin:system.adoc[system panel].
6+
NOTE: If you don't want to use this authorization, you should turn it off in the xref:admin:system.adoc[system panel].
77

88
The process is:
99

1010
. Participant request a verification code to be sent to an address.
1111
. An administrator sends the letter to their address with the verification code.
1212
. An administrator marks the letter as sent.
1313
. Once you mark the letter as sent, the participant is able to introduce the code.
14-
. If this code matchs, then they get verified.
14+
. If this code matches, then they get verified.
1515

1616
== 1. Verification code request
1717

@@ -20,7 +20,7 @@ a participant can see the form requesting their full address.
2020

2121
image::participants/authorizations_code_postal_letter_request.png[Code by postal letter request by participant]
2222

23-
If they try to edit it, they will see this message:
23+
If they try to edit it, they see this message:
2424

2525
image::participants/authorizations_code_postal_letter_edit.png[Edit the postal letter request]
2626

@@ -29,17 +29,17 @@ to contact a platform administrator.
2929

3030
== 2. Administrator review
3131

32-
In the admin panel, the administrator can review the request by going to the "Code by postal letter" in the "Participants" section.
32+
In the administration panel, the administrator can review the request by going to the "Code by postal letter" in the "Participants" section.
3333

34-
image::participants/authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in admin]
34+
image::participants/authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in administration]
3535

3636
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
3737
as such with the icon image:icons/action_verify.png[Mark as sent]. It'll also show when the letter was sent.
3838

3939
== 3. Participant validate the code
4040

4141
After the participant has received the code, they can go to their account settings and click in the "Code by postal letter"
42-
verfication method.
42+
verification method.
4343

4444
image::participants/authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account]
4545

@@ -49,11 +49,11 @@ image::participants/authorizations_code_postal_letter_confirm.png[Code by postal
4949

5050
== 4. Code match
5151

52-
If the verification code matches, then the participant will see the message "Congratulations. You've been successfully verified".
52+
If the verification code matches, then the participant sees the message "Congratulations. You've been successfully verified."
5353

54-
On the other hand, if the verification code doesn't match, then the participant will see the message "Your verification
55-
code doesn't match ours. Please double-check the letter we sent to you."
54+
On the other hand, if the verification code doesn't match, then the participant see an error asking to double-check the code in
55+
the letter.
5656

57-
After is verified, as with other verifications, they can see it in their account settings.
57+
After a participant is verified, as with other verifications, they can see it in their account settings.
5858

5959
image::participants/authorizations_code_postal_letter_verified.png[Verified by code by postal letter]

docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc

+19-19
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ This authorization allows a participant to upload its identity documents into th
44
These documents depend on the organization, they could be a driver's license, a passport, a national identity card,
55
a club membership card, etc.
66

7-
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].
7+
NOTE: If you don't want to collect any data, you should turn it off in the xref:admin:system.adoc[system panel].
88

9-
These documents will be reviewed by an administrator to accept or reject them. It's possible to do this process
10-
in two ways: Online or Offline.
9+
These documents are reviewed by an administrator who can accept or reject them. It's possible to do this process
10+
in two ways:
1111

12-
* *Online*: the participant will be asked to upload the documents, and the administrator will review these documents.
13-
* *Offline*: the participant will be asked to fill in some data, and then they will need to go to a presential place
12+
* *Online*: the participant is asked to upload the documents, and the administrator reviews these documents.
13+
* *Offline*: the participant is asked to fill in some data, and then they need to go to a physical place
1414
to show their documents face to face.
1515
1616
== Configuration
@@ -42,7 +42,7 @@ The process is:
4242
. Participants fill in their document type and number and upload a copy of their document.
4343
. An administrator fills in the information present in the uploaded image.
4444
. The information should match whatever the user filled in.
45-
. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and
45+
. If the administrator can't see the information or they can't get it verified, they can reject the request and
4646
the user will be able to fix it.
4747

4848
=== 1. Participant authorization creation
@@ -56,22 +56,22 @@ NOTE: You can change the document types options by xref:customize:code.adoc[cust
5656

5757
=== 2. Administrator document review
5858

59-
After this document is uploaded, an administrator can review it by going to the Identity documents section in the admin
59+
After this document is uploaded, an administrator can review it by going to the Identity documents section in the administration
6060
panel.
6161

6262
image::participants/authorizations_id_document_online_pending.png[ID document authorization pending online verification]
6363

6464
After clicking on the verification id link or on the document, the administrator needs to review the image and fill in
65-
the document numbe in the field. This number needs to match with the one provided by the participant.
65+
the document number in the field. This number needs to match with the one provided by the participant.
6666

6767
image:participants/authorizations_id_document_online_confirm.png[ID document authorization online confirmation form]
6868

6969
=== 3. Administrator decision
7070

71-
There are two actions an admin can do:
71+
There are two actions an administrator can do:
7272

73-
* Verify: the system will check if the document numbers entered by administrator and user are the same.
74-
* Reject: the participant will have to edit their authorization if they want to get verified.
73+
* Verify: the system checks if the document numbers entered by administrator and user are the same.
74+
* Reject: the participant have to edit their authorization if they want to get verified.
7575

7676
If the request is rejected then the participant can provide other pictures or document.
7777

@@ -88,10 +88,10 @@ The process is:
8888
specific time to show their documents.
8989
. An administrator go to the "Offline verification" panel and fills in the information present in the physical documents.
9090
. The information should match whatever the user filled in.
91-
. If the administrator can't clearly see the information or they can't get it verified, they can reject the request and
92-
the user will be able to fix it.
91+
. If the administrator can't see the information or they can't get it verified, they can reject the request and
92+
the user is then able to fix it.
9393

94-
For this authorization to work, an administrator need to first configure it in the admin panel with the instructions explaining
94+
For this authorization to work, an administrator need to first configure it in the administration panel with the instructions explaining
9595
what the participant need to do to finish the verification process.
9696

9797
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
105105

106106
=== 2. Administrator document review
107107

108-
In the admin panel, the administrator can review the request by clicking the "Offline verification" button.
108+
In the administration panel, the administrator can review the request by clicking the "Offline verification" button.
109109

110-
image::participants/authorizations_id_document_offline_button.png[ID document authorization offline button in admin]
110+
image::participants/authorizations_id_document_offline_button.png[ID document authorization offline button in administration]
111111

112112
Then they need to fill some data provided by the participant and review the document physically provided.
113113

114-
image::participants/authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in admin]
114+
image::participants/authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in administration]
115115

116116
.ID Documents authorization offline form
117117
|===
@@ -125,7 +125,7 @@ image::participants/authorizations_id_document_offline_confirm.png[ID document a
125125
|Required
126126
|Can be: ID or Passport
127127

128-
|Document number (with letter)
128+
|Document number
129129
|Required
130130
|Document number of the participant. For instance, "12345678Z"
131131

@@ -139,7 +139,7 @@ user account.
139139

140140
== Both
141141

142-
It's also possible to enable both of these verifications methods. In this case, the participant will be asked to choose
142+
It's also possible to enable both of these verifications methods. In this case, the participant has to choose
143143
which kind of verification they want to do.
144144

145145
image::participants/authorizations_id_document_account_choose.png[Choose ID document verification kind]

docs/en/modules/admin/pages/participants/groups.adoc

+9-8
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ If an administrator verifies a user group, then all the user group administrator
66

77
image::participants/user_group_frontend_show.png[Frontend: show a user group]
88

9-
== Enable / Disable user groups
9+
== Enable / disable user groups
1010

1111
Administrators can enable or disable user groups in the xref:admin:configuration.adoc[Configuration] panel.
1212

13-
When enabled, participants will be able to create and manage groups from their profile.
13+
When enabled, participants are able to create and manage groups from their profile.
1414
To learn more about how participants can do this, go to the xref:admin:features/my_public_profile.adoc[public profile] article.
1515

1616
== Manage user groups
@@ -22,10 +22,10 @@ When a participant creates a user group, it adds a line in the user groups list
2222
* *Phone*: phone number of the structure or the administrator of the user group.
2323
* *Participants count*: number of members of the user group.
2424
* *Created at*: date of the user group creation.
25-
* *State*: state of the verification, can only be Pending, Verified or Rejected.
25+
* *State*: state of the verification, can only be pending, verified, or rejected.
2626

2727
You can filter and sort this list by clicking the "Filter" button and the columns headers.
28-
You can also search for user groups by email, name or nickname in the search bar.
28+
You can also search for user groups by email, name, or nickname in the search bar.
2929

3030
image::participants/admin_user_group_verification.png[Admin panel: user group verifications]
3131

@@ -54,10 +54,11 @@ A user group can have three states:
5454

5555
=== Verify a group
5656

57-
To verify a group, an administrator should check that the group exists and is legitimate to have an entity on the platform.
58-
Administrator can call the group administrator on the phone number provided, or check that the document number exists.
57+
To verify a group, an administrator should verify that the group exists and is legitimate to have an entity on the platform.
58+
Administrator can call the group administrator on the phone number provided, or verify that the document number exists.
5959

60-
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".
60+
After a group is verified, this is publicly visible in their nickname in the platform and there's a message in its profile:
61+
"This group is publicly verified, its name has been verified to correspond with its real name."
6162

6263
image::participants/user_group_verified.png[User group: verified icon]
6364

@@ -67,5 +68,5 @@ If you want to verify multiple user groups at once, you can do so with the "Veri
6768

6869
image::participants/admin_user_group_verification_csv.png[Admin panel: user group verifications CSV]
6970

70-
There, you can upload a CSV file, formated with a unique column without headers, containing the user groups emails you want to verify.
71+
There, you can upload a CSV file, with a unique column without headers, containing the user groups emails you want to verify.
7172
Only the groups that have confirmed their email and that have an email appearing in the CSV file will be verified.

0 commit comments

Comments
 (0)