Skip to content

Commit

Permalink
Participants (#170)
Browse files Browse the repository at this point in the history
* Update participants parent article

* Update Administrators article and screens

* Update user groups article and screenshots

* Add user group frontend screenshot

* Update Participants page and screenshots

* Update impersonations article and screenshots

* Update verifications conflict page

* Update authorizations article

* Update Identity document article

* Update Code postal auth article

* Update Census article

* Fix linter issues

* Fix lint errors

* Update accepted vocabulary

* Revert changes on my public profile page

* Update accepted terms and empty line

* Implement review feedbacks

---------

Co-authored-by: paulinebessoles <[email protected]>
  • Loading branch information
paulinebessoles and paulinebessoles authored Nov 28, 2024
1 parent d901980 commit b809921
Show file tree
Hide file tree
Showing 110 changed files with 422 additions and 323 deletions.
10 changes: 9 additions & 1 deletion .github/styles/config/vocabularies/Decidim/accept.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
Decidim
moderations
CSV
Config
[Nn]ickame
[Ee]mail
[Oo]fficialize
[Oo]fficialization
[Oo]fficializing
Reoffficialize
moderations
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/en/modules/admin/assets/images/admins.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
37 changes: 25 additions & 12 deletions docs/en/modules/admin/pages/participants.adoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
= Participants

Sometimes as an administrator you'll need to make certain tasks with participants, among them:
== Understand the basics

* To give permissions to other administrators so they can manage platform's content
* To verify user groups (organizations or collectives)
* To verify participants
* To recognize that a participant has a special status in the platform, with Officializations
* To authenticate that a person has the right to vote, with Authorizations
* To contact a participant
The participants tab allow you to make certain tasks with participants, among them:

You can access this section on the main sidebar of the admin panel.
* To manage access rights to the platform administration
* To contact participants
* To manage participants access to specific spaces
* To certify the identity of specific participants
* To certify the authenticity of user organizations or collectives

image:participants_menu.png[Participants menu]
== Configuration

Once you're in you can see all the different kind of participants and actions that you can do:
To access the Participants configuration panel, go in the administration panel and click the "Participants" item in the administration navigation bar.

image:participants_sidebar_menu.png[Participants sidebar menu]
image::participants/participants_menu.png[Participants menu]

There, you first see the list of administrators of the platform.

image::participants/participants_sidebar_menu.png[Participants sidebar menu]

In the secondary navigation panel, you can see all the participants configuration possibilities:

* xref:admin:participants/admins.adoc[Admins]
* xref:admin:participants/groups.adoc[Groups]
Expand All @@ -26,4 +31,12 @@ image:participants_sidebar_menu.png[Participants sidebar menu]
* xref:admin:participants/authorizations.adoc[Authorizations]
** xref:admin:participants/authorizations/identity_documents.adoc[Identity documents]
** xref:admin:participants/authorizations/code_postal_letter.adoc[Code by postal letter]
** xref:admin:participants/authorizations/census.adoc[Organization's census]
** xref:admin:participants/authorizations/census.adoc[Organization's census]

Some of those items might not appear in this menu, because they aren't enabled.
To check how to enable them, go on the missing item documentation article.

== Examples

You want to add your colleagues so they can edit the platform.
You want to set specific flows for participants to be able to participate in a specific participatory space.
79 changes: 66 additions & 13 deletions docs/en/modules/admin/pages/participants/admins.adoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,74 @@
= Admins
= Administrators

In the administrator listing page you can see all the administrators of the platform:
Administrators are the persons managing the organization, creating the processes, managing the platform as a whole
They can be of two types:

image:admins.png[Admins list]
* Administrators: have access to all the platform configuration.
* Participant managers: can only manage participants xref:admin:participants/impersonations.adoc[impersonations].
Here you can:
image:participants/admins.png[Admins list]

* invite new administrators
* revoke administrators permissions
* see when was the last time an administrator logged in
== Invite an administrator

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:
To invite an administrator, click the "New admin" button at the top right of the page.
You can invite an already registered or a non registered participant.

* Admin: to give full access to the platform
* Participant manager: to give permission to only do xref:admin:participants/impersonations.adoc[Impersonations]
image:participants/admins_invite.png[Invite participant as administrator form]

image:admins_invite.png[Invite participant as administrator form]
.New administrator form

You can invite an already registered or a non registered participant.
|===
|Field |Type |Description

|Name
|Required
|Name of the administrator. If they already have an account, it changes automatically for their username.

|Email
|Required
|Email of the participant to invite. If they don't have an account related to this email, they should receive an invitation email to create an account. Otherwise, they won't be notified.

|Role
|Required
|Administrator or Participant manager

|===

If an administrator doesn't already have an account, but didn't register, you can also Resend the invitation.

== Manage administrators

You can find all the administrators on the administrators list in the administration panel, with:
* *Role*: type of administrator rights, can only be Administrator or Participant manager.
* *Name*: name of the participant.
* *Email*: email of the participant.
* *Invitation sent at*: date and time of the email invitation.
* *Invitation accepted at*: when they accepted the email invitation.
* *Last log in date*: date of the administrator last connection.
* *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.

=== Actions

|===
|Icon |Name |Definition |Condition

|image:icons/action_resend.png[Resend invitation icon]
|Resend invitation
|To resend an invitation email to the participant.
|Available when the participant didn't accept the invitation.

|image:icons/action_delete.png[Delete icon]
|Delete
|To revoke the participant's administration access rights.
|Available for all administrators, except for the first one.

|===

=== Revoke administrator permissions

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.
48 changes: 26 additions & 22 deletions docs/en/modules/admin/pages/participants/authorizations.adoc
Original file line number Diff line number Diff line change
@@ -1,32 +1,20 @@
= 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.
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 in-person.

A participant can see which authorizations do they have available in their account settings.
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.

image:authorizations_account.png[Authorizations in participants account]

== Authorizations revocation
NOTE: Several authorizations are available by default, but you can also develop your own authorizations.

A default Decidim installation will not have verified participants.
== Enable / disable authorizations

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]
To enable an authorization, you need to have access to the xref:configure:system.adoc[System panel] or ask the instance implementer.
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].

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].
Participants can access, update, or delete their authorizations in their xref:admin:features/my_account/authorizations.adoc[account].

== Verification methods

Expand All @@ -38,3 +26,19 @@ Some of the available authorizations by default are:

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

== Authorizations revocation

A default Decidim installation don't have verified participants.

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

From the moment some participants get verified with an authorization, administrators can revoke all the authorizations at once.
Indeed, after some time, some of the verifications can be deprecated.
For instance, identity documents expire after some time, or participants can move from a city.
Then, an administrator can want to force participants to renew their verification information.

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 possibility is to revoke only the verifications for xref:admin:participants/impersonations.adoc[impersonated participants].
26 changes: 13 additions & 13 deletions docs/en/modules/admin/pages/participants/authorizations/census.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,33 @@

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
. Admins upload a CSV with the emails of the verified participants
. Participants go to their account and request 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].
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. An administrator uploads the CSV of the participants
== 1. CSV upload

In the admin panel, the administrator can review the request 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: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:authorizations_organization_census_imported.png[Imported CSV]
image::participants/authorizations_organization_census_imported.png[Imported CSV]

== 2. A participant requests to be verified
== 2. Participant request

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]
image::participants/authorizations_organization_census_account.png[Organization's census in participant's accounts]

== 3. The participant is verified (or not)
== 3. Participant verification

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]
image::participants/authorizations_organization_census_verified.png[Verified by organization's census]
Original file line number Diff line number Diff line change
@@ -1,57 +1,59 @@
= 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.
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, you should turn it off in the xref:admin:system.adoc[system panel].

The process is:

. Participants request a verification code to be sent to their address.
. 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 will be able to introduce the code.
. If this code matchs, then they get verified.
. Once you mark the letter as sent, the participant is able to introduce the code.
. If this code matches, then they get verified.

== 1. A participant request the verification code
== 1. Verification code request

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.
a participant can see the form requesting their full address.

image:authorizations_code_postal_letter_request.png[Code by postal letter request by participant]
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:authorizations_code_postal_letter_edit.png[Edit the postal letter request]
image::participants/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.
to contact a platform administrator.

== 2. An administrator review this request and sent the letter
== 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: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 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.
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. A participant fills in the verification code
== 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:authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account]
image::participants/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.
Then they can fill the form with the code they received.

image:authorizations_code_postal_letter_confirm.png[Code by postal letter confirmation form]
image::participants/authorizations_code_postal_letter_confirm.png[Code by postal letter confirmation form]

== 4. The verification code matches or not
== 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:authorizations_code_postal_letter_verified.png[Verified by code by postal letter]
image::participants/authorizations_code_postal_letter_verified.png[Verified by code by postal letter]
Loading

0 comments on commit b809921

Please sign in to comment.