**Is your feature request related to a problem? Please describe.**
It would be useful to set a character limit on questionnaire answers to provide guidance for users regarding how long their answers should be.
**Describe the solution you\'d like**
To have a number input field next to each question in the admin, labeled \\"Character limit\\", by default set to zero (no limit), which determines the maximum characters the user answers to those questions can have.
**Describe alternatives you\'ve considered**
Another possibility could be to define this globally for the questionnaire, setting the character limit for each type of question.
**Additional context**
-
**Could this issue impact on users private data?**
No
**Funded by**
Fundació Bosch i Guimpera
"},"title":{"en":"Maximum characters for questionnaire text answers"}}' | sha256sum ----- diff --git a/docs/en/modules/admin/pages/features/follows.adoc b/docs/en/modules/admin/pages/features/follows.adoc deleted file mode 100644 index 1a5ad94eda..0000000000 --- a/docs/en/modules/admin/pages/features/follows.adoc +++ /dev/null @@ -1,27 +0,0 @@ -= Follows - -Most of the contents in Decidim allows to be followed. This means that you'll receive xref:features/notifications.adoc[notifications] -of the activity being made by the thing you're following. - -You can control these notifications in the xref:features/my_account/notifications_settings.adoc[settings of your account]. - -The activity of the things that you're following is visible in your xref:features/my_public_profile/timeline.adoc[profile timeline]. - -For following a thing: - -. Navigate to whatever you want to follow. -. Click in the "Follow" button. -image:button_follow.png[Follow button] -. You'll see the "Follow" button disappear and the "Stop following" button appear. - -To unfollow a thing: - -. Navigate to whatever you want to unfollow. -. Click in the "Stop following" button. -image:button_stop_following.png[Stop following button] -. You'll see the "Stop following" button disappear and the "Follow" button appear. - -Administrators by default follow all the new spaces that are created in the Decidim platform. - -A participant can also follow another participants. This is public and it's visible in the profile sections -xref:features/my_public_profile/follows.adoc[follows] and xref:features/my_public_profile/followers.adoc[followers]. diff --git a/docs/en/modules/admin/pages/features/hashtags.adoc b/docs/en/modules/admin/pages/features/hashtags.adoc deleted file mode 100644 index 2ecbf6ea61..0000000000 --- a/docs/en/modules/admin/pages/features/hashtags.adoc +++ /dev/null @@ -1,5 +0,0 @@ -= Hashtags - -Hashtags are a way to categorize content globally on the platform and make it more easily searchable through these categorizations. It allows different related contents to be easily discoverable under the same topic. Similar functionality is often used in other social media platforms. - -Hashtags can be set for different records within the platform, such as participatory spaces. They can also be generated for content created by the participants to allow easier discovery of the content. Some components may also allow setting suggested hashtags or specific hashtags for all records submitted by the participants. diff --git a/docs/en/modules/admin/pages/features/my_account.adoc b/docs/en/modules/admin/pages/features/my_account.adoc deleted file mode 100644 index 15a381fbef..0000000000 --- a/docs/en/modules/admin/pages/features/my_account.adoc +++ /dev/null @@ -1,19 +0,0 @@ -= 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] diff --git a/docs/en/modules/admin/pages/features/my_account/account.adoc b/docs/en/modules/admin/pages/features/my_account/account.adoc deleted file mode 100644 index 18b23060ce..0000000000 --- a/docs/en/modules/admin/pages/features/my_account/account.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= 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. diff --git a/docs/en/modules/admin/pages/features/my_account/authorizations.adoc b/docs/en/modules/admin/pages/features/my_account/authorizations.adoc deleted file mode 100644 index a34efaf2ad..0000000000 --- a/docs/en/modules/admin/pages/features/my_account/authorizations.adoc +++ /dev/null @@ -1,23 +0,0 @@ -= Authorizations - -In this section participants will be able to review their Authorizations and see some metadata, like when it was granted -or the status of the authorization. - -It depends on how it's configured for the organization, as depending in the context (like normative or laws) it could work -in different ways. For more information about Authorizations see xref:admin:participants/authorizations.adoc[authorizations -in admin manual] and xref:customize:authorizations.adoc[authorizations in customize guide]. - -image:features/my_account/authorizations.png[Authorizations] - -To go to this section: - -. Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "Authorizations" in the sidebar - -For any given authorization, you can see the following information: - -* If it's not finished, when the authorization process started -* If it has finished and has been granted, the date when it was granted -* If the authorization provides it, some metadata, such as the scope of the authorization diff --git a/docs/en/modules/admin/pages/features/my_account/delete_my_account.adoc b/docs/en/modules/admin/pages/features/my_account/delete_my_account.adoc deleted file mode 100644 index 3fc0c019fc..0000000000 --- a/docs/en/modules/admin/pages/features/my_account/delete_my_account.adoc +++ /dev/null @@ -1,21 +0,0 @@ -= 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] diff --git a/docs/en/modules/admin/pages/features/my_account/groups.adoc b/docs/en/modules/admin/pages/features/my_account/groups.adoc deleted file mode 100644 index c91b9ae83a..0000000000 --- a/docs/en/modules/admin/pages/features/my_account/groups.adoc +++ /dev/null @@ -1,18 +0,0 @@ -= Groups - -In this section participants can see which Groups they belong to. - -NOTE: Want to create a new group? Go to the xref:admin:features/my_public_profile.adoc[My public profile] page. - -image:features/my_account/groups.png[Groups] - -To go to this section: - -. Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "Groups" in the sidebar - -Here you can see in which date the group was created and which status does it have (`pending` or `verified`). - -Read more about xref:admin:participants/groups.adoc[Groups in admin manual]. diff --git a/docs/en/modules/admin/pages/features/my_account/my_data.adoc b/docs/en/modules/admin/pages/features/my_account/my_data.adoc deleted file mode 100644 index b2dfb09c69..0000000000 --- a/docs/en/modules/admin/pages/features/my_account/my_data.adoc +++ /dev/null @@ -1,29 +0,0 @@ -= My data - -In this section participants can request a file with all the data that they've provided to the platform. - -image:features/my_account/my_data.png[My data] - -To request the data: - -. Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "My data" in the sidebar -. Click in "Request data" -. Wait a couple of minutes so the files are generated. It could depend in how many proposals, comments, etc you've made -. Go to your email account and find the received email -. Click in "Download" -. Open it with a support zip software -. Enter the password that you've received in the email -. Unzip or extract the contents - -image:features/my_account/my_data_email.png[My data] - -== Zip applications - -For opening the zip file, the software that you use need to support encryption with the AES-256 algorithm. Depending on your operating system you have multiple alternatives. - -* Windows: https://www.7-zip.org/[7-Zip] -* Mac: https://www.keka.io[Keka] -* GNU/Linux: File Roller (available through your package manager) or https://peazip.github.io/[PeaZip] diff --git a/docs/en/modules/admin/pages/features/my_account/my_interests.adoc b/docs/en/modules/admin/pages/features/my_account/my_interests.adoc deleted file mode 100644 index 44de673df7..0000000000 --- a/docs/en/modules/admin/pages/features/my_account/my_interests.adoc +++ /dev/null @@ -1,15 +0,0 @@ -= My interests - -In this section participants can choose which interests they have to receive more information about. - -By default what they see here is a list of all the xref:admin:scopes.adoc[Scopes] of the organization. Those selections -can be used by administrators when segmenting for the xref:admin:newsletters.adoc[Newsletters]. - -image:features/my_account/my_interests.png[My interests] - -To go to this section: - -. Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "My interests" in the sidebar diff --git a/docs/en/modules/admin/pages/features/my_account/notifications_settings.adoc b/docs/en/modules/admin/pages/features/my_account/notifications_settings.adoc deleted file mode 100644 index 2729a48cde..0000000000 --- a/docs/en/modules/admin/pages/features/my_account/notifications_settings.adoc +++ /dev/null @@ -1,26 +0,0 @@ -= Notifications - -In this section participants can choose which kind of notifications they'll receive. For instance, depending in the activity of the installation and spaces, most people would want to disable the "Everything I follow" - -image:features/my_account/notifications_settings.png[Notifications settings] - -To go to this section: - -. Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "Notifications settings" in the sidebar - -The options available are: - -* I want to get notifications about -** My own activity, like when someone comments in my proposal or mentions me -** Everything I follow -* Send notifications by email -** I want to receive an email every time I receive a notification -* Newsletters -** I want to receive newsletters -* Receive direct messages from anyone -** Allow anyone to send me a direct message, even if I don't follow them -* Administrators -** I want to receive an email every time something is reported for moderation diff --git a/docs/en/modules/admin/pages/features/my_public_profile.adoc b/docs/en/modules/admin/pages/features/my_public_profile.adoc deleted file mode 100644 index e9220e0b43..0000000000 --- a/docs/en/modules/admin/pages/features/my_public_profile.adoc +++ /dev/null @@ -1,18 +0,0 @@ -= My public profile - -Every participant has a public profile that shows details about them and their activity on the website. - -To go to this section: - -. Sign in as a participant -. Click in the name of the participant in the header -. Click in "My public profile" - -The sections available under the public profile are: - -* xref:admin:features/my_public_profile/timeline.adoc[Timeline] -* xref:admin:features/my_public_profile/activity.adoc[Activity] -* xref:admin:features/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] diff --git a/docs/en/modules/admin/pages/features/my_public_profile/activity.adoc b/docs/en/modules/admin/pages/features/my_public_profile/activity.adoc deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/en/modules/admin/pages/features/my_public_profile/badges.adoc b/docs/en/modules/admin/pages/features/my_public_profile/badges.adoc deleted file mode 100644 index 03a4d5d292..0000000000 --- a/docs/en/modules/admin/pages/features/my_public_profile/badges.adoc +++ /dev/null @@ -1,5 +0,0 @@ -= Badges - -The public profile's badges shows which badges the participant has accumulated and what their current level is for each badge. - -More information about badges is available on the xref:admin:features/badges.adoc[Badges feature page]. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/followers.adoc b/docs/en/modules/admin/pages/features/my_public_profile/followers.adoc deleted file mode 100644 index fc8c5e2e13..0000000000 --- a/docs/en/modules/admin/pages/features/my_public_profile/followers.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Followers - -The followers section contains a list of participants and groups that are following the participant that the profile belongs to. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/follows.adoc b/docs/en/modules/admin/pages/features/my_public_profile/follows.adoc deleted file mode 100644 index a34bea7794..0000000000 --- a/docs/en/modules/admin/pages/features/my_public_profile/follows.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Follows - -The follows section contains a list of participants and groups the participant is currently following. By following another participant or a group on the platform, the participant will receive notifications about the activity done by those other participants or groups on the platform. Some participants may also require that they need to be following the other participant before they can exchange private messages with each other. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/groups.adoc b/docs/en/modules/admin/pages/features/my_public_profile/groups.adoc deleted file mode 100644 index fc4c438b7b..0000000000 --- a/docs/en/modules/admin/pages/features/my_public_profile/groups.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Groups - -The groups section contains all the groups that the user belongs to. More information about the groups feature is available at the xref:admin:features/my_account/groups.adoc[User groups page]. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/timeline.adoc b/docs/en/modules/admin/pages/features/my_public_profile/timeline.adoc deleted file mode 100644 index bcf0202273..0000000000 --- a/docs/en/modules/admin/pages/features/my_public_profile/timeline.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Timeline - -The timeline view displays the participants activity on the website, including the activity items that should be only visible to the participant currently logged in. This section is not visible to any other user than the participant themselves because it can also contain items that should be visible only to that participant. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/tmp_notifications.adoc b/docs/en/modules/admin/pages/features/my_public_profile/tmp_notifications.adoc deleted file mode 100644 index a46500bc3f..0000000000 --- a/docs/en/modules/admin/pages/features/my_public_profile/tmp_notifications.adoc +++ /dev/null @@ -1,5 +0,0 @@ -= Notifications - -In this section participants can see the notifications that the system has sent to them. For instance, if the participant is followign a participatory space or a proposal, they get related notifications about the actions that happen in these sections of the platform. - -This section can be accessed through the bell icon in the header bar of the platform. The bell icon shows highlighted as active when there are notifications and dimmer when there are no new notifications for the user right now. diff --git a/docs/en/modules/admin/pages/features/participant_actions/group_profile.adoc b/docs/en/modules/admin/pages/features/participant_actions/group_profile.adoc new file mode 100644 index 0000000000..65578d00de --- /dev/null +++ b/docs/en/modules/admin/pages/features/participant_actions/group_profile.adoc @@ -0,0 +1,120 @@ += Groups profiles + +== Understand the basics + +As a participant, you might want to create a user group for you association, your company, your club, etc. +If an administrator verifies that you are entitled to represent this group, then you are able to participate in the instance in the +name of the group. + +NOTE: The group creation option is only available when groups are enabled for the organization. +You can ask an administrator of the platform or enable it from the xref:admin:configuration.adoc[Configuration] panel. + +== Create a group + +To create a group, click the "Create group" button in your public profile. + +image::features/my_profile/profile_create_group.png[Public profile group creation form] + +.Group creation form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Name +|Required +|Name of the organization, association, collective, group, etc. + +|Nickname +|Required +|Nickname of the organization, association, collective, group, etc. Do not use spaces nor accents. + +|Email +|Required +|Email of your organization, association, collective, group, etc. + +|Avatar +|Optional +|Avatar of your organization, that is displayed as a user avatar. Can be a logo, a picture, etc. + +|About +|Optional +|More information about your organization. This is publicly displayed on the user group profile page. + +|Document number +|Optional +|Fill this field if you want an administrator to verify the authenticity of your user group. + +|Phone +|Optional +|Fill this field if you want an administrator to be able to call someone in your organization to +verify the authenticity of the user group. + +|=== + +The user group is visible on the platform as soon as you create it. After its creation, you are redirected to the +user group profile page. + +User groups profiles pages display: + +* Members: Members of the groups, and who are the administrators. +* Badges: User group badges. +* Followers: Participants can also follow user groups. + +== Manage a group + +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 user group administrator are: + +* Edit group profile +* Manage members +* Manage admins +* Invite participant +* Leave group + +image::features/my_profile/profile_manage_group.png[Public profile group drop down menu] + +=== Manage members + +On this page, you can accept or refuse participants requests to join your group, but also promote group members to administrators +or remove them from the group. + +image::features/my_profile/user_group_manage_participant.png[User groups: manage participants] + +=== Manage administrators + +On this page, you can only remove group administrator rights, but it won't remove the participant from the group. + +image::features/my_profile/user_group_manage_admins.png[User groups: manage admins] + +=== Invite participants + +To invite a participant, they need to have an account on the platform. +You can invite them with their nickname. + +image::features/my_profile/user_group_invite_participant.png[User groups: invite a participant] + +Then, they receive an invitation to join the group. They can accept it or not. + +=== Conversations + +You can also have Conversations as a group. + +image::features/my_profile/user_group_conversation.png[User group: conversations] + +== Participate as a group + +NOTE: For user group administrators to be able to participate as a group, an administrator of the instance must have verified it. + +The interest of having an administrator verify the user group is that you can then participate to the platform as a group, +and create debate, proposal, meetings, comments, etc. + +Administrators of the user group can for example comment in the name of their group. + +image::features/my_profile/user_group_make_comment.png[User group: make a comment] + +They can also choose to endorse a debate or a proposal in the name of their group and / or in their own name. + +image::features/my_profile/user_group_endorse.png[User group: endorse] + diff --git a/docs/en/modules/admin/pages/features/participant_actions/my_account.adoc b/docs/en/modules/admin/pages/features/participant_actions/my_account.adoc new file mode 100644 index 0000000000..88e6459eb9 --- /dev/null +++ b/docs/en/modules/admin/pages/features/participant_actions/my_account.adoc @@ -0,0 +1,174 @@ += My account + +== Understand the basics + +This feature allows participants to manage their account information, notifications preferences, authorizations, see their groups, etc. +This account page is only accessible to the participant, and some account information (such as the "About" field) are displayed in the +participant xref:admin:features/participant_actions/my_public_profile.adoc[public profile]. + +== How to find it? + +As a signed in participant, you can access your account configuration from two places: + +. Click in your avatar in the header, and then click in the "My account" menu item +. Click in the "Configuration" link in the footer, in the "My account" section + +image::features/my_account/account_dropdown.png[Frontend user menu dropdown] + +== Account settings + +There, you'll find different sections, allowing you to set different settings for your participant account. + +NOTE: You might not see the Authorizations and the Groups settings sections if you didn't enable them. + +=== Account + +In this section, participants can modify the information displayed in their xref:features/participant_actions/my_public_profile.adoc[public profile], modify their email address or +the language they want to use by default. + +image::features/my_account/account.png[My account form] + +.Participant settings - My account form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Avatar +|Optional +|Avatar or picture for the participant. Guidance for image: Preferably a landscape image that does not have any text. +The service crops the image. Maximum file size: 5 MB + +|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 again. + +|Personal URL +|Optional +|Metadata that is displayed in the participant's profile. + +|About +|Optional +|Information about the participant displayed in the participant's profile. + +|Locale +|Required +|Language you want to use to browse and receive notifications in Decidim. + +|=== + +Participants can also change their password on this page, by clicking the "Change password" link. They need to choose a new password and enter +their current password to be able to change it. + +image::features/my_account/password_change.png[My account form - password change] + +=== Notifications settings + +In this section participants can choose which kind of notifications they want to receive and how often they want to receive them. + +image:features/my_account/notifications_settings.png[Notifications settings] + +The options available are: + +* I want to get notifications about +** My own activity, like when someone comments in my proposal or mentions me +** Everything I follow +* How often do you want to receive the notifications email? +** None, Real time, Daily, or Weekly +* Newsletters +** I want to receive newsletters +* Receive direct messages from anyone +** Allow anyone to send me a direct message, even if I don't follow them +* Administrators +** I want to receive an email every time something or someone is reported for moderation. +** I want to receive email reminders of closed meetings unpublished reports +* Push notifications +** Get push notifications to find out what is going on when you are not on the platform. You can turn them off anytime. + +=== Authorizations + +In this section participants are able to review their Authorizations and see some metadata, like when it was granted +or the status of the authorization. + +It depends on how it's configured for the organization, as depending in the context (like normative or laws) it could work +in different ways. For more information about Authorizations see xref:admin:participants/authorizations.adoc[authorizations +in admin manual] and xref:customize:authorizations.adoc[authorizations in customize guide]. + +image:features/my_account/authorizations.png[Authorizations] + +For any given authorization, you can see the following information: + +* If it's not finished, when the authorization process started +* If it has finished and has been granted, the date when it was granted +* If the authorization provides it, some metadata, such as the scope of the authorization + +=== Groups + +In this section participants can see which groups they belong to. + +NOTE: Want to create a new group? Go to the xref:admin:features/participant_actions/group_profile.adoc[Group profile] page. + +image::features/my_account/groups.png[Groups] + +Read more about groups configuration in the xref:admin:participants/groups.adoc[Groups in the administrator manual]. + +=== My interests + +In this section participants can choose which interests they have to receive more information about. + +By default what they see here is a list of all the xref:admin:scopes.adoc[Scopes] of the organization. Those selections +can be used by administrators when segmenting for the xref:admin:features/social_features/newsletters.adoc[Newsletters]. + +image::features/my_account/my_interests.png[My interests] + +=== My data + +In this section participants can request a file with all the data that they've provided in the platform. + +image::features/my_account/my_data.png[My data] + +To request the data: + +. Click in "Request data" +. Wait a couple of minutes so the files are generated. It could depend in how many proposals, comments, etc you've made +. Go to your email account and find the received email +. Click in "Download" +. Open it with a support zip software +. Enter the password that you've received in the email +. Unzip or extract the contents + +image:features/my_account/my_data_email.png[My data] + +For opening the zip file, the software that you use need to support encryption with the AES-256 algorithm. Depending on your operating system you have multiple alternatives. + +* Windows: https://www.7-zip.org/[7-Zip] +* Mac: https://www.keka.io[Keka] +* GNU/Linux: File Roller (available through your package manager) or https://peazip.github.io/[PeaZip] + +=== Delete my account + +In this section participants are able to delete their own accounts. Once it's done, they are unable to access the system anymore. +This action is irreversible. All the contributions on the platform become anonymous. + +image:features/my_account/delete_my_account.png[Delete my account form] + +To delete the account: + +. Optionally, you 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) are still visible but all the authorship information is anonymised, +and transferred to a "Deleted participant" author. + +image:features/my_account/delete_my_account_deleted.png[Deleted participant contribution] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/participant_actions/my_public_profile.adoc b/docs/en/modules/admin/pages/features/participant_actions/my_public_profile.adoc new file mode 100644 index 0000000000..77ec0494a6 --- /dev/null +++ b/docs/en/modules/admin/pages/features/participant_actions/my_public_profile.adoc @@ -0,0 +1,81 @@ += My public profile + +== Understand the basics + +Every participant has a public profile that shows details about them and their activity on the instance. +This profile page is accessible to all participants and visitors. + +== How to find it? + +To see a participant public profile, click directly in their avatar or their user name in the participant tool-tip. + +image::features/my_profile/profile_pop_up.png[Participant tool-tip] + +As a signed in participant, you can access your public profile from two places: + +. Click in your avatar in the header, and then click in the "My public profile" menu item +. Click in the "My public profile" link in the footer, in the "My account" section + +image::features/my_profile/profile_dropdown.png[Frontend user menu dropdown] + +== Profile tabs + +There, you'll find different tabs. + +NOTE: You might not see the Badges and the Groups tab if you didn't enable them in the xref:admin:configuration.adoc[Configuration] panel. + +=== Activity + +This tab displays all the activity of the participant, starting with the most recent content. + +image::features/my_profile/profile_activity.png[Public profile activity tab] + +=== Badges + +The public profile's badges shows which badges the participant has accumulated and what their current level is for each badge. + +More information about badges is available on the xref:admin:features/social_features/badges.adoc[Badges feature page]. + +image::features/my_profile/profile_badges.png[Public profile badges tab] + +=== Follows + +The follows section contains a list of participants and groups the participant is currently following. +By following another participant or a group on the platform, the participant receives notifications about the activity +done by those participants or groups on the platform. Some participants may also require that they need to be following +a participant before they can exchange private messages with each other. + +image::features/my_profile/profile_follows.png[Public profile follows tab] + +=== Followers + +The followers section contains a list of participants and groups that are following the participant. + +image::features/my_profile/profile_followers.png[Public profile followers tab] + +=== Groups + +The groups section contains all the groups that the user belongs to. More information about the groups feature is +available at the xref:admin:features/participant_actions/groups.adoc[User groups page]. + +image::features/my_profile/profile_groups.png[Public profile groups tab] + +== Actions available + +=== When on another participant profile + +Logged in participants can perform two actions from another participant public profile page: + +. Send them a message +. Follow them +. Report them + +=== When on your own profile + +Logged in participants can perform two actions from their public profile page: + +. Edit their profile: When clicking this button, they're redirected to their xref:admin:features/participant_actions/my_account.adoc[account]. +. Create a group: When clicking this button, they're redirected to the xref:admin:features/participant_actions/group_profile.adoc[group creation form]. + +NOTE: The group creation option is only available when groups are enabled for the organization. +You can do it from the xref:admin:configuration.adoc[Configuration] panel. diff --git a/docs/en/modules/admin/pages/features/notifications.adoc b/docs/en/modules/admin/pages/features/participant_actions/notifications.adoc similarity index 90% rename from docs/en/modules/admin/pages/features/notifications.adoc rename to docs/en/modules/admin/pages/features/participant_actions/notifications.adoc index d9337e58fe..fdd726618e 100644 --- a/docs/en/modules/admin/pages/features/notifications.adoc +++ b/docs/en/modules/admin/pages/features/participant_actions/notifications.adoc @@ -1,39 +1,44 @@ = Notifications -== The notification menu +== Understand the basics -Most of the actions in the platform generate notifications so particpants can know when there are new things to watch. +Notifications allow participants to keep up to date with the platform latest news, with the spaces, the contents and the participants they follow, etc. +Most of the actions in the platform generate notifications. -This is accessible from the `Notifications` menu item (image:icon_bell.png[Notification icon]) in the header, after a participant has logged in. +Participants can manage their notifications preferences in their xref:admin:features/participant_actions/my_account.adoc[account]. -To see the notifications: +== The notification page -. Sign in as participant -. Click in the notifications icon in the header +As a signed in participant, you can access your notifications from two places: -If there are notifications, then the participant will see the icon with a color image:icon_bell_on.png[Notification icon with color] +. Click in your avatar in the header, and then click in the "Notifications" menu item +. Click in the "Notifications" link in the footer, in the "My account" section + +image::features/notifications/notifications_dropdown.png[Frontend user menu dropdown] + +If there are notifications, the participant sees a small badge next to their avatar, and in the dropdown menu. image:features/notifications/notifications.png[Example of notifications page when there are notifications] +When there are no notifications, or the participant marked all the notifications as read, a message is displayed. + 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. -==== +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 | ❌ | ❌ | ✅ +| An administrator 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 | ❌ | ❌ | ✅ +| A participant has tried to verify themselves 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 | ✅ | ❌ | ❌ @@ -46,13 +51,13 @@ Affected users depend on the notification context. For instance, it could be the | 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 has been promoted as group administrator | 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 group administrator 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 | ✅ | ❌ | ❌ +| An administrator 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 | ❌ | ✅ | ❌ @@ -65,7 +70,7 @@ Affected users depend on the notification context. For instance, it could be the | 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 | ✅ | ❌ | ❌ +| An administrator 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 | ✅ | ❌ | ❌ @@ -91,8 +96,8 @@ Affected users depend on the notification context. For instance, it could be the | 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 | ✅ | ❌ | ❌ +| Your comment in has been up-voted | Comments | ✅ | ❌ | ❌ +| Your comment in has been down-voted | Comments | ✅ | ❌ | ❌ | A debate has been created | Debates | ❌ | ✅ | ❌ | Debate creation is enabled for participants | Debates | ❌ | ✅ | ❌ | Debate creation is no longer active | Debates | ❌ | ✅ | ❌ @@ -104,7 +109,7 @@ Affected users depend on the notification context. For instance, it could be the | 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 | ❌ | ✅ | ❌ +| The meeting will start in less than 48 h | Meetings | ❌ | ✅ | ❌ | A new proposal has been published | Proposals | ❌ | ✅ | ❌ | Proposal creation is open | Proposals | ❌ | ✅ | ❌ | Proposal supports are open | Proposals | ❌ | ✅ | ❌ @@ -113,8 +118,8 @@ Affected users depend on the notification context. For instance, it could be the | 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 | ✅ | ❌ | ❌ +| An administrator has updated the scope of your proposal | Proposals | ✅ | ❌ | ❌ +| An administrator 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 | ✅ | ❌ | ❌ diff --git a/docs/en/modules/admin/pages/features/participants_actions.adoc b/docs/en/modules/admin/pages/features/participants_actions.adoc new file mode 100644 index 0000000000..357e311da5 --- /dev/null +++ b/docs/en/modules/admin/pages/features/participants_actions.adoc @@ -0,0 +1,13 @@ += Participant actions + +== Understand the basics + +This documentation section is about participants related features when they want to configure their account, display information on their profile, +create user groups, delete their account, or understand how the notifications work. + +Here, you'll find: + +. xref:admin:features/participant_actions/notifications.adoc[Notifications] +. xref:admin:features/participant_actions/my_account.adoc[My account] +. xref:admin:features/participant_actions/my_public_profile.adoc[My public profile] +. xref:admin:features/participant_actions/group_profile.adoc[Group profiles] diff --git a/docs/en/modules/admin/pages/features/search.adoc b/docs/en/modules/admin/pages/features/search.adoc index 28558b6ff3..7c041d02d4 100644 --- a/docs/en/modules/admin/pages/features/search.adoc +++ b/docs/en/modules/admin/pages/features/search.adoc @@ -1,3 +1,21 @@ = Search engine -*The search engine* allows participants to perform searches across all of the platform’s indexable content, both generally and specifically, by searching within a specific participatory process or inside its components (proposals, results, etc.), through advanced searches. +== Understand the basics + +*The search engine* allows participants to perform searches across all of the platform’s content that can be indexed, +both generally and specifically, by searching within a specific participatory process or inside its components +(proposals, results, etc.), through advanced searches. + +== How to find it? + +The search engine is accessible in the instance header, next to your platform logo. + +image::features/search/search_input.png[Search input in frontend navigation bar] + +In the search bar, you can enter a word or just do an empty search to access the search results page. + +image::features/search/search_page.png[Search results page example] + +The search engine searches for the entry in all the resources titles and descriptions. + +You can also filter the search by clicking the resources types in the left. diff --git a/docs/en/modules/admin/pages/features/share.adoc b/docs/en/modules/admin/pages/features/share.adoc deleted file mode 100644 index 2a49818ee2..0000000000 --- a/docs/en/modules/admin/pages/features/share.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Share - -Different content on the platform can be easily shared through the share links available on the site. The share links allow easier sharing to different social media services that can be configured for Decidim through the configuration files. diff --git a/docs/en/modules/admin/pages/features/social_features.adoc b/docs/en/modules/admin/pages/features/social_features.adoc new file mode 100644 index 0000000000..e140af23f0 --- /dev/null +++ b/docs/en/modules/admin/pages/features/social_features.adoc @@ -0,0 +1,17 @@ += Social features + +== Understand the basics + +This documentation section is about features related to the social interaction between participants on the platform. +Transparency is really important in Decidim, and is one of the main part of xref:understand:social-contract#_transparency_traceability_and_integrity.adoc[Decidim Social Contract]. + +Here, you'll find: + +. xref:admin:features/social_features/newsletters.adoc[Newsletters] +. xref:admin:features/social_features/badges.adoc[Badges] +. xref:admin:features/social_features/comments.adoc[Comments] +. xref:admin:features/social_features/conversations.adoc[Conversations] +. xref:admin:features/social_features/endorsements.adoc[Endorsements] +. xref:admin:features/social_features/follows.adoc[Follows] +. xref:admin:features/social_features/share.adoc[Share] +. xref:admin:features/social_features/hashtags.adoc[Hashtags] diff --git a/docs/en/modules/admin/pages/features/badges.adoc b/docs/en/modules/admin/pages/features/social_features/badges.adoc similarity index 58% rename from docs/en/modules/admin/pages/features/badges.adoc rename to docs/en/modules/admin/pages/features/social_features/badges.adoc index 453776727f..119db0e71b 100644 --- a/docs/en/modules/admin/pages/features/badges.adoc +++ b/docs/en/modules/admin/pages/features/social_features/badges.adoc @@ -1,20 +1,24 @@ = 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. +== Understand the basics + +Badges are recognitions of the participant actions and progress on the platform. As participants start discovering, participating, +and interacting, they 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. +The badges a participant has are visible in their public profile. -image:features/badges/example01.png[Example of badges in profile] +image::features/badges/profile_badges.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] +image::features/badges/notification.png[Example of badges notification] + +== Badges description -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, +Badges have multiple levels, depending in the number of times they have made the action. For instance, for the followers badge, +the participants receive the first level badge when they have 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 @@ -23,7 +27,7 @@ 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. +|Granted when participants 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 @@ -43,24 +47,16 @@ make proposals that can be carried out. This way they are more likely to be acce |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. +participants need to weave their web to communicate with other people in the platform. +|The participant needs to be active and follow other people. It encourages other people to 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. +|The participant needs to go to the participation space of Initiatives 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. @@ -74,3 +70,7 @@ and this badge is not available, so it'll be removed in the future. |1, 5, 10, 30, 60 |=== + +There's also a general explanation page with a short description of every badge. + +image::features/badges/badges_page.png[Badges page with badges explanation] diff --git a/docs/en/modules/admin/pages/features/social_features/comments.adoc b/docs/en/modules/admin/pages/features/social_features/comments.adoc new file mode 100644 index 0000000000..67535f8d2c --- /dev/null +++ b/docs/en/modules/admin/pages/features/social_features/comments.adoc @@ -0,0 +1,136 @@ += Comments + +== Understand the basics + +Comments are public messages allowing participants to share information or opinions about a proposal, debate, meeting, initiative, etc. + +NOTE: Comments need to be enabled by administrators, otherwise participants are not able to comment. To learn +how to enable comments on a component, please refer to the component's article. + +image::features/comments/nested_comment.png[Comments example] + +== Create a comment + +. Go to the content that you want to comment +. Go to the bottom of the page +. Fill the "Add comment" field and leave your comment + +image::features/comments/form.png[Comments form] + +When commenting, participants can: + +|=== +|Type |Description |Syntax |Example + +|Mention +|Mention a participant or a user group. They'll receive a notification for the mention. +|@nickname +|@carmelia_hudson + +|Hashtag +|Hashtags are redirecting to the general xref:admin:features/search.adoc[search page] +|#example +|#sedep + +|Quote +|Hashtags are redirecting to the general xref:admin:features/search.adoc[search page] +|> Your quote here +|> the funding for this program could be better allocated to improving public transportation options + +|URL +|Once published, URL become clickable, and can be internal or external. If they refer to a content of the platform, the +link label takes the content title. +|https://domain.name/ +|https://en.wikipedia.org/wiki/Decidim + +|Emojis +|Participants can add emojis by clicking on the emoji icon at the bottom right of the comment field. +|No syntax +|😁 + +|Give their opinion +|Participants can say they are in favor, neutral, or against the content +|No syntax +|In favor + +|=== + +Below, you can find an example of a comment field with several of those elements. + +image::features/comments/rich_text_write.png[Comments with rich text (write)] + +Once published, this comment and its different elements are displayed like below. + +image::features/comments/rich_text_read.png[Comments with rich text (read)] + +When clicking on a hashtag in a comment or another content, participant is redirected to the global search. + +image::features/comments/hashtag_search.png[Hashtags in comments] + +NOTE: HTML injection added in comments are escaped and not shown. + +image::features/comments/xss_write.png[XSS in comments (write)] +image::features/comments/xss_read.png[XSS in comments (read)] + +== Actions + +Participants can interact with comments in different ways. + +* Everyone can sort them and show and hide replies thread. +* Participants can additionally reply to comments, up-vote or down-vote them, report them or get the link to the comment. +* Authors of comments can also edit and delete their own comments. + +They can access some actions directly on the comment, and others by clicking the three dots menu next to a comment. + +image::features/comments/actions.png[Comments actions] + +=== Sort + +Participants can sort comments by: +* Best rated: comments with the more up-votes appear first in the list +* Recent: most recent comments appear first. +* Older: older comments appear first. +* More discussed: comments with the more nested comments appear first. + +image::features/comments/order_by.png[Order comments] + +They can also hide replies, when they don't want to display a whole comment thread. + +=== Reply + +By clicking on the "Reply" button below a comment, participants can reply to other participants and have public discussions. +Comments can be nested until four levels. On the fourth level, the "Reply" button is not available anymore. + +image::features/comments/anidation_levels.png[Nested comments] + +=== Up-vote / down-vote + +Participants can support comments by clicking on the "Thumbs up" icon at the bottom right of each comment. +It allows them to participate and give their opinion, without necessary having to answer a comment. + +=== Report + +Please read the xref:admin:moderations/reported_content.adoc[Reported content] article to know more about reporting content. + +=== Get link + +By clicking on the "Get link" item, participants are redirected to the comment dedicated URL. +They can then share this link to others, and it lead them directly to the one comment. +A message is displayed to warn the visitor that they are seeing a single comment, with a link to see all the other comments. + +image::features/comments/single_comment.png[Edited comment] + +=== Edit + +Participants can edit their comments, and after they do, a "Edited" mention appears on their comment to indicate to other +participants that this content was edited. + +Comments don't have a version history of the changes made. + +image::features/comments/edited_comment.png[Edited comment] + +=== Delete + +Once a comment is deleted, it's no longer visible, and a message indicates the date when it was deleted. + +image::features/comments/deleted_comment.png[Deleted comment] diff --git a/docs/en/modules/admin/pages/features/social_features/conversations.adoc b/docs/en/modules/admin/pages/features/social_features/conversations.adoc new file mode 100644 index 0000000000..65332598ba --- /dev/null +++ b/docs/en/modules/admin/pages/features/social_features/conversations.adoc @@ -0,0 +1,59 @@ += Conversations + +== Understand the basics + +With conversations, participants can send private messages to another participant, a group of participants, or to user groups. +Only the participants who are in the conversation can see each the messages. + +NOTE: It's not possible to delete a conversation nor to edit a message in a conversation. + +== How to find it? + +As a signed in participant, you can access your conversations from two places: + +. Click in your avatar in the header, and then click in the "Conversations" menu item +. Click in the "Conversations" link in the footer, in the "My account" section + +image::features/conversations/conversations_dropdown.png[Frontend user menu dropdown] + +If there are notifications, the participant sees a small badge next to their avatar, and in the dropdown menu. + +== Start a conversation + +A participant can start a conversation with any participant or group registered on the platform. + +image::features/conversations/conversations.png[Conversations list] + +There are two ways to start a conversation. + +=== From a participant profile + +. Go to the profile of the participant with who you want to start a conversation +. Click the "Message" button +. Write your message + +image:features/conversations/profile.png[Participant profile] + +image:features/conversations/start_a_conversation_form.png[Start a conversation form] + +=== From the conversation page + +image::features/conversations/conversation.png[Example of a conversation] + +. Click in your avatar in the header +. Click in "Conversations" +. Click on the "New conversation" button +. Search the participants or group that you want to start a conversation with +. Write your message + +NOTE: You can start a conversation with several participants, with a limit of 9 participants. + +image::features/conversations/new_conversation_modal.png[New conversation modal] + +== Group conversations + +Just like with participants, it is possible to have conversations with groups. + +NOTE: To know more about user groups, read the xref:admin:features/participant_actions/group_profile.adoc[Group creation] article. + +image::features/conversations/group_conversations.png[Group conversations list] diff --git a/docs/en/modules/admin/pages/features/social_features/endorsements.adoc b/docs/en/modules/admin/pages/features/social_features/endorsements.adoc new file mode 100644 index 0000000000..7c46a19683 --- /dev/null +++ b/docs/en/modules/admin/pages/features/social_features/endorsements.adoc @@ -0,0 +1,26 @@ += Endorsements + +== Understand the basics + +Through endorsements, participants can publicly show that they want to support a particular content, like a proposal, a debate, etc. +Administrators can enable endorsements by step in a given participatory process, and they can also define permissions with authorizations. + +NOTE: Endorsements are also called "Likes" in the participant interface. + +image::features/endorsements/sidebar.png[Endorsement button in sidebar] + +== Endorse / like a content + +To endorse a content, click the "Like" button below the content. + +image::features/endorsements/list.png[List of endorsements] + +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 all the endorsers, you need too click in the "+ x" icon. + +image:features/endorsements/full_list.png[Full list of endorsements] + +Participants can also dislike the content if they change their mind. \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/social_features/follows.adoc b/docs/en/modules/admin/pages/features/social_features/follows.adoc new file mode 100644 index 0000000000..8c142c7a0e --- /dev/null +++ b/docs/en/modules/admin/pages/features/social_features/follows.adoc @@ -0,0 +1,41 @@ += Follows + +== Understand the basics + +Participants can follow contents in Decidim, such as participatory spaces, proposals, a specific meeting, other participants, user groups, etc. +Following something or someone means that when there are news related to this content, the participant receive xref:features/participant_actions/notifications.adoc[notifications]. + +Notifications are accessible in the notification page, but can also be sent by email. +You can control these notifications in the xref:features/participant_actions/my_account.adoc#_notifications_settings[settings of your account]. + +The activity that you're following is visible in your xref:features/participant_actions/my_public_profile.adoc[profile activity]. + +== Follow a content + +NOTE: By default, administrators follow all the new spaces created in the platform. + +To follow a content: + +. Navigate to whatever you want to follow. +. Click in the "Follow" button. +. See that the "Follow" button disappear and the "Stop following" button appear. + +image::features/follows/button_follow.png[Follow button] + +== Unfollow a content + +To unfollow a content: + +. Navigate to whatever you want to unfollow. +. Click in the "Stop following" button. +. You'll see the "Stop following" button disappear and the "Follow" button appear. + +image::features/follows/button_stop_following.png[Stop following button] + +== Follow a participant + +A participant can also follow participants. This is public and visible in the profile xref:features/participant_actions/my_public_profile.adoc[follows section]. + +To follow a participant, pass the cursor on their avatar, or click the "Follow" button in their public profile page. + +image::features/follows/user_tooltip_follow.png[Follow user] diff --git a/docs/en/modules/admin/pages/features/social_features/hashtags.adoc b/docs/en/modules/admin/pages/features/social_features/hashtags.adoc new file mode 100644 index 0000000000..36bb956d32 --- /dev/null +++ b/docs/en/modules/admin/pages/features/social_features/hashtags.adoc @@ -0,0 +1,18 @@ += Hashtags + +== Understand the basics + +Hashtags are a way to categorize content globally on the platform and make it more searchable through these categorizations. +It allows different related contents to be discoverable under the same topic. +Similar feature is often used in other social media platforms. + +Hashtags can be set for different records within the platform, such as participatory spaces. +They can also be generated for content created by the participants to allow easier discovery of the content. +Some components may also allow setting suggested hashtags or specific hashtags for all records submitted by the participants. + +== Use hashtags + +Participants can add hashtags in their comments, debates, proposals, etc. +When clicking on a hashtag in a comment or another content, the participant is redirected to the global search. + +image::features/comments/hashtag_search.png[Hashtags in comments] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/social_features/newsletters.adoc b/docs/en/modules/admin/pages/features/social_features/newsletters.adoc new file mode 100644 index 0000000000..16ae94ac0a --- /dev/null +++ b/docs/en/modules/admin/pages/features/social_features/newsletters.adoc @@ -0,0 +1,188 @@ += Newsletters + +== Understand the basics + +Newsletters may be sent out to inform participants of the latest news on the platform: launch of a new consultation, warning +before a closing date for votes, announcement of a result, monitoring of projects in progress, etc. +The newsletter is sent to any user of the site who has ticked the "Receive an occasional newsletter with relevant information" +box when they created their account, or later in their xref:admin:features/participant_actions/my_account.adoc[account] settings. + +image::features/newsletters/newsletter_contact_permission.png[Contact permission in participant registration] + +image::features/newsletters/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 topic to discuss. +* When there's a new voting planned. +* When there's a new conference published. +* Etc. + +== Configuration + +To access the Newsletters panel, go in the administration panel and click the "Newsletters" item in the administration navigation bar. + +image::features/newsletters/newsletter_menu.png[Newsletter administrator menu] + +There, you see the list of newsletters already sent from this instance. If it's a new instance, you shouldn't see any newsletter in the +list. + +image::features/newsletters/newsletter_list.png[Newsletter list] + +== Create a newsletter + +To start creating a newsletter, click the "New newsletter" button at the top right of the page. + +=== Select a template + +First, you are asked to select a newsletter template, depending on what you want to send. +Two templates are displayed, with a preview for each one to help you decide on the best format for the content you want to communicate. + +* Basic (only text): recommended for short updates +* Image, text and Call To Action button: recommended for more elaborated contents + +image::features/newsletters/newsletter_templates.png[Newsletter new templates selection] + +Click the "Use this template" button below the template you want to use. + +=== Write the newsletter + +Depending in which template you've chosen, you have to fill a form with different fields. + +NOTE: You can use "%\{name}" anywhere in the body or subject to be automatically replaced by the participant's name. + +image::features/newsletters/newsletter_new_basic.png[Newsletter new template basic form] + +.New Newsletter "basic (only text)" form +|=== +|Field |Type |Description + +|Subject +|Required +|Subject of the email. + +|Body +|Optional +|Body of the email. +|=== + +image::features/newsletters/newsletter_new_cta.png[Newsletter new template Image, text and CTA form] + +.New Newsletter "Image, text and Call To Action button" form +|=== +|Field |Type |Description + +|Subject +|Required +|Subject of the email. + +|Introduction +|Optional +|Introduction of the email, displayed before the CTA button. + +|Call To Action button text +|Optional +|The CTA button text. + +|Call To Action button URL +|Optional +|Where the CTA link redirects. + +|Body +|Optional +|Body of the email, displayed after the CTA button. + +|Main image +|Optional +|Guidance for image: Preferably a landscape image that does not have any text. The service crops the image. +Allowed file extensions: JPG JPEG PNG WEBP + +|=== + +Once you wrote the newsletter, click the "Save and preview" button. + +=== Preview the newsletter + +The preview page allows you to review the look and content of the newsletter before sending it. +Until you send the newsletter, you can edit it and review its preview anytime you want. + +image::features/newsletters/newsletter_preview_basic_example.png[Newsletter new template basic form preview] + +=== Send a test email + +If you want to review the newsletter directly in your mailbox, click the "Send me a test email" button at the top right of the page. +You receive the newsletter directly at the email address registered for your participant account. + +=== Select recipients to deliver + +If you want to only communicate about a given space or neighborhood, you can choose the which participants you're sending the newsletter to. +To do so, click the "Select recipients to deliver" button. + +NOTE: If you don't want to send your newsletter to a specific segment, select "Send to all users" + +There, you can choose between sending the newsletter to: + +* All confirmed users +* All confirmed users that have participated in any of the selected participatory spaces in the list +* All confirmed users that have followed any of the selected participatory spaces in the list +* All the participants that have selected an scope in their "My interests" settings in their account. + +NOTE: Even if a participant has a confirmed account and is following a space, the system don't send them a newsletter email if they +haven't accepted it in their xref:admin:features/participant_actions/my_account#_notifications_settings.adoc[notifications] settings. + +image::features/newsletters/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::features/newsletters/newsletter_select_recipients_spaces.png[Newsletter select recipients spaces] + +=== Deliver the newsletter + +Finally if you click in the "Deliver newsletter" button, the newsletter is sent to all the selected recipients. +Before sending it, a pop-up appears to make sure you reviewed everything and are ready to send it. + +image::features/newsletters/newsletter_deliver_modal.png[Newsletter deliver modal] + +NOTE: Once a newsletter is sent it can't be undone nor edited. If you have multiple languages active, +be careful with reviewing all the languages well before sending. + +== Manage newsletters + +You can find all the newsletters on the newsletter page, with: + +* *Subject*: subject of the newsletter, redirects to the newsletter preview. +* *Created at*: date of the newsletter creation. +* *Sent at*: date of the newsletter sending. +* *Sent to*: the segment the newsletter was sent to. +* *Progress*: the number of participants to whom the newsletter was sent, upon the total number of recipients. + +=== Actions + +|=== +|Icon |Name |Definition |Condition + +|image:icons/action_edit.png[Edit newsletter] +|Edit +|To edit the newsletter. +|Newsletter not sent. + +|image:icons/action_share.png[Send test email] +|Send a test email +|To send a test email to the administrator email address. +|Always. + +|image:icons/action_preview.png[Preview newsletter] +|Preview +|To preview the newsletter +|Always. + +|image:icons/action_delete.png[Delete] +|Delete +|To delete the newsletter. +|Newsletter not sent. + +|=== diff --git a/docs/en/modules/admin/pages/features/social_features/share.adoc b/docs/en/modules/admin/pages/features/social_features/share.adoc new file mode 100644 index 0000000000..34e4eb4192 --- /dev/null +++ b/docs/en/modules/admin/pages/features/social_features/share.adoc @@ -0,0 +1,20 @@ += Share + +== Understand the basics + +Participants can share content on the platform through the share links available on the different contents pages. +The share links allow easier sharing to different social media services that can be configured for Decidim through the configuration files. + +NOTE: Check xref:customize:social_shares.adoc[Social share services] for more information. + +== Share a content + +To share a content, such as a proposal, go to the content page and click the "Share" link at the right of the description. + +image::features/share/share_button.png[Share button on resources] + +A modal appears, with different buttons to different social services providers. +By clicking on a button, the participant is redirected to the social network, and can quickly publish or send a message with a link to the content page. +Participants can also copy the link below the buttons, or click in the "Copy" link or icon. + +image::features/share/share_modal.png[Share modal] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/statistics.adoc b/docs/en/modules/admin/pages/features/statistics.adoc deleted file mode 100644 index 1d8e48a2eb..0000000000 --- a/docs/en/modules/admin/pages/features/statistics.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Statistics - -Decidim provides general statistics about the whole platform and different participatory spaces can also provide statistics related to that participatory space only. These are generic numbers that indicate the website activity and may also encourage other people to join the platform as they see it being popular. diff --git a/docs/en/modules/admin/pages/features/transparency/fingerprint.adoc b/docs/en/modules/admin/pages/features/transparency/fingerprint.adoc new file mode 100644 index 0000000000..725c2ea71f --- /dev/null +++ b/docs/en/modules/admin/pages/features/transparency/fingerprint.adoc @@ -0,0 +1,34 @@ += Fingerprint + +== Understand the basics + +Although the platform should show the xref:admin:features/transparency/versions.adoc[Versions] for almost all of the contents, it'd still be possible +for a system administrator to manipulate the content by editing the database directly. + +As mitigation for this risk, the platform shows a fingerprint for some important fields, for instance, a proposal body and title. + +Its goal is to provide a way to give an informal "receipt" to a participant so they can detect tampering. A fingerprint is +a hashed representation of the content. It's useful to ensure the content hasn't been tampered with, as a single modification +would result in a totally different value. It's calculated using a *SHA256 hashing algorithm*. In order to replicate it +yourself, you can use a http://www.md5calc.com/sha256[MD5 calculator online] and copy-paste the source data. + +== Check fingerprint + +. Go to the content for which you want to verify the fingerprint +. Click in the "Check fingerprint" link at the bottom of the page +. Copy the source field value +. Go to a MD5 calculator online (External link) and copy-paste the source data +. Check that fingerprint are the same + +image:features/fingerprint/content.png[Check fingerprint link in page bottom] + +image::features/fingerprint/modal.png[Check fingerprint modal] + +image:features/fingerprint/md5calc.png[MD5calc.com screenshot] + +It's also possible to verify the fingerprint with other tools, such as the sha256sum command line tool. + +[source,bash] +---- +echo -n '{"body":{"en":"This proposal suggests creating a green corridor that connects the north and south districts of Chakar via a bicycle and pedestrian-only route. The corridor would pass through the city center and industrial areas, providing a safe, dedicated path for non-motorized transport, with shade trees, rest spots, and solar-powered lighting."},"title":{"en":"Green Corridor for Cyclists and Pedestrians"}}' | sha256sum +---- diff --git a/docs/en/modules/admin/pages/features/transparency/statistics.adoc b/docs/en/modules/admin/pages/features/transparency/statistics.adoc new file mode 100644 index 0000000000..cc533ec8cf --- /dev/null +++ b/docs/en/modules/admin/pages/features/transparency/statistics.adoc @@ -0,0 +1,38 @@ += Statistics + +== Understand the basics + +Decidim provides general statistics about the whole platform and different participatory spaces can also provide statistics related to that participatory space only. +These are generic numbers that indicate the website activity and may also encourage other people to join the platform as they see it being popular. + +== The types of data + +=== Statistics + +The homepage configuration allows administrators to enable a statistics content block to be displayed on the homepage. + +image::features/metrics/homepage_stats.png[Example of statistics content block] + +Administrators can also enable metrics in a participatory process or an assembly landing page. + +image::features/metrics/example_stats.png[Example of statistics] + +=== Metrics + +NOTE: Looking for how to enable this feature technically? Go to xref:develop:metrics.adoc[Metrics in Developers guide]. + +With metrics, participants can see the evolution in time of some resources, such as Proposals, Supports, Endorsements, Followers, Participants, Accepted proposals, Comments, etc. + +The homepage configuration allows administrators to enable a metrics content block to be displayed on the homepage. + +image::features/metrics/homepage.png[Example of metrics content block] + +Administrators can also enable metrics in a participatory process landing page. + +You can see a real world example of this in https://meta.decidim.org/processes/roadmap/all-metrics[Metadecidim Roadmap process]. + +image::features/metrics/example.png[Example of metrics] + +By clicking in the "Show all" button visitors can see other metrics and download this data in CSV format. + +image:features/metrics/page.png[Metrics page] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/transparency/versions.adoc b/docs/en/modules/admin/pages/features/transparency/versions.adoc new file mode 100644 index 0000000000..2ef3c3b8d8 --- /dev/null +++ b/docs/en/modules/admin/pages/features/transparency/versions.adoc @@ -0,0 +1,25 @@ += Versions + +== Understand the basics + +The versions feature allows a visitor to see the evolution of the different versions of resources that can be edited, +like proposals or results. + +With versions it's possible to see who made changes to a content, when the change has been made and exactly what has changed. + +image::features/versions/side_by_side_escaped.png[Versions in resources] + +== How to find it? + +. Go to the content for which you want to review the different versions. +. Click in the "see other versions" link in the bottom of the page. +. From there you can change the visualisation of the version differences, and review all past versions. + +image::features/versions/sidebar.png[See other versions link in page bottom] + +image::features/versions/list.png[List of versions] + +It's possible to view the diffs of the versions in two formats: side by side or unified. In case that the contents are +in HTML then it's also possible to see the diff un-escaped and escaped, and see the full HTML code. + +image:features/versions/unified_escaped.png[Unified escaped view] diff --git a/docs/en/modules/admin/pages/features/transparency_features.adoc b/docs/en/modules/admin/pages/features/transparency_features.adoc new file mode 100644 index 0000000000..1dee963ad6 --- /dev/null +++ b/docs/en/modules/admin/pages/features/transparency_features.adoc @@ -0,0 +1,12 @@ += Transparency features + +== Understand the basics + +This documentation section is about features related to the transparency policy of Decidim. +Transparency is really important in Decidim, and is one of the main part of xref:understand:social-contract#_transparency_traceability_and_integrity.adoc[Decidim Social Contract]. + +Here, you'll find: + +. xref:admin:features/transparency/statistics.adoc[Statistics] +. xref:admin:features/transparency/versions.adoc[Versions] +. xref:admin:features/transparency/fingerprint.adoc[Fingerprint] diff --git a/docs/en/modules/admin/pages/features/versions.adoc b/docs/en/modules/admin/pages/features/versions.adoc deleted file mode 100644 index 053a6d25ff..0000000000 --- a/docs/en/modules/admin/pages/features/versions.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= Versions - -The versions feature allows a visitor to see the evolution of the different versions of resources that can be edited, -like proposals or results. - -With versions it's possible to see who made the change, when the change has been made and exactly what has changed. - -image:features/versions/side_by_side_escaped.png[Versions in resources] - -== See the versions - -. Go to the content that you want to see the version of. -. Click in the "see other versions" link in the sidebar -image:features/versions/sidebar.png[See other versions link in sidebar] -. Click in the past version that you want to see -image:features/versions/list.png[List of versions] -. From there you can change the visualiation of the version differences -image:features/versions/unified_unescaped.png[Unified unescaped view] - -It's possible to view the diffs of the versions in in two formats: side by side or unified. In case that the contents are -in HTML then it's also possible to see the diff unescaped and escaped, and see the full HTML code. - -image:features/versions/side_by_side_unescaped.png[Side by side unescaped view] -image:features/versions/unified_escaped.png[Unified escaped view] - diff --git a/docs/en/modules/admin/pages/newsletters.adoc b/docs/en/modules/admin/pages/newsletters.adoc deleted file mode 100644 index 46fb7fec80..0000000000 --- a/docs/en/modules/admin/pages/newsletters.adoc +++ /dev/null @@ -1,164 +0,0 @@ -= 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. -==== - diff --git a/docs/en/modules/admin/pages/spaces/assemblies/landing_page.adoc b/docs/en/modules/admin/pages/spaces/assemblies/landing_page.adoc new file mode 100644 index 0000000000..d8700998bc --- /dev/null +++ b/docs/en/modules/admin/pages/spaces/assemblies/landing_page.adoc @@ -0,0 +1,10 @@ + +include::partial$page_landing_page.adoc[] + +=== Dates metadata + +image::spaces/landing_page/dates_metadata.png[Landing page results content block] + +=== Social networks + +image::spaces/landing_page/social_networks.png[Landing page results content block] diff --git a/docs/en/modules/admin/partials/components_list.adoc b/docs/en/modules/admin/partials/components_list.adoc index 4c9e9198bf..8cb751f310 100644 --- a/docs/en/modules/admin/partials/components_list.adoc +++ b/docs/en/modules/admin/partials/components_list.adoc @@ -1,17 +1,16 @@ The platform currently have the following official components: -* xref:admin:components/accountability.adoc[*Accountability*]: allows to keep track of the results execution of a space. -It allows administrators to also relate them to the proposals and meetings that originated them. -* xref:admin:components/blog.adoc[*Blog*]: allows administrators to publish posts with news regarding a space. -* xref:admin:components/budgets.adoc[*Budgets*]: allows participants to vote in projects with amounts predefined. Used for -participatory budgeting processes. Allows to define different kind of rules, for instance a minimum percentage of the total budget or a minimum amount of projects. -* xref:admin:components/debates.adoc[*Debates*]: allows participants to have debates. Debates can be time limited or not. -* xref:admin:components/meetings.adoc[*Meetings*]: gatherings in person or online through videoconferences platforms. +* xref:admin:components/accountability.adoc[*Accountability*]: allows to keep track of ongoing projects. +* xref:admin:components/blog.adoc[*Blog*]: allows administrators to publish blog posts and news. +* xref:admin:components/budgets.adoc[*Budgets*]: allows participants to vote for projects with amounts predefined, for +participatory budgeting for example. +* xref:admin:components/debates.adoc[*Debates*]: allows participants to have debates. +* xref:admin:components/meetings.adoc[*Meetings*]: in person or online gatherings, agenda, minutes, etc. * xref:admin:components/pages.adoc[*Page*]: static pages with multi-language support. -* xref:admin:components/proposals.adoc[*Proposals*]: contributions posted by participants which can be given support. -* xref:admin:components/sortitions.adoc[*Sortitions*]: this allows different kind of proposals to be selected randomly. -For instance the proposals could be candidates who form part of a group (such as a committee). +* xref:admin:components/proposals.adoc[*Proposals*]: contributions posted by participants. +* xref:admin:components/sortitions.adoc[*Sortitions*]: allows to randomly selected proposals. * xref:admin:components/surveys.adoc[*Survey*]: for conducting surveys with different kinds of questions. -In the cases where your needs are not covered by one of the above components, you can create your own component through a xref:develop:modules.adoc[Module]. +NOTE: In the cases where your needs aren't covered by one of those components, +you can create your own component through a xref:develop:modules.adoc[Module]. diff --git a/docs/en/modules/admin/partials/page_admins.adoc b/docs/en/modules/admin/partials/page_admins.adoc index 04153a3a73..613b3140f0 100644 --- a/docs/en/modules/admin/partials/page_admins.adoc +++ b/docs/en/modules/admin/partials/page_admins.adoc @@ -1,44 +1,79 @@ -= Space Admins += Space administrators -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. +== Understand the basics -* 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. +You can give specific permissions to users in the different spaces, so they can only have access to some of the administration actions. +These roles are administrators, moderators, collaborators, and valuators. -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*. +* *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 edit anything. +* *Moderators*: they can see the reported contents of the space and hide or unhide it. +* *Valuators*: they can evaluate proposals, give them answers and update their statuses. -== New space admin form +== How to find it? -image:spaces/admins_form.png[New space admin form] +To configure space administrators, click the "Process admins" or "Assembly admins" item in the corresponding space. -.New space admin form +image::spaces/admins_list.png[Administrators of space] + +== Manage admins + +You can find all the administrators on the list in the administration panel, with: + +* *Name*: name of the administrator account. +* *Email*: email of the administrator account. +* *Last log in date*: last time the administrator was logged in. +* *Invitation accepted at*: date when the administrator accepted the invitation by clicking the link in the invitation email. +* *Role*: administrator role. + +== Actions + +.Components actions in component list +[cols="20h,10h,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|To edit the administrator role. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete the space administrator rights. It doesn't delete the account of the administrator. + +|=== + +== Add a space administrator + +Click on the *New space admin* button (depending in the kind of space you're in). + +image:spaces/admins_form.png[New space administrator form] + +.New space administrator form +[cols="20h,10h,~"] |=== |Field |Type |Description |Name |Required -|What is the name of the new admin. +|What's the name of the new administrator. |Email |Required -|What is the email of the new admin, so they can receive the invitation. +|What's the email of the new administrator, so they can receive an invitation if they don't already have an account. |Role |Required -|Which role does this admin will have in the participatory process? Can be any of Administrator, Collaborator, Moderator, or Valuator. +|Which role does this administrator should have in the space. 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. +A space administrator can administer the space and change the space settings. They can also invite new space administrators. +When managing the space, they would only see the following views and tabs. image:spaces/admins_role_admin01.png[Process administrators view 01] @@ -46,21 +81,23 @@ image:spaces/admins_role_admin02.png[Process administrators view 02] === Collaborators -A space collaborator can only see the space before it's published. +A space collaborator can preview a 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. +A space moderator can review the reported contents of the space and hide or unhide them. They can also +access the reported content in the global moderation panel, but don't see the contents reported from other spaces. image:spaces/admins_role_moderator.png[Process moderators view] -=== Process valuators +=== Valuators -A space valuator can review the proposals of the space. They can: +A space valuator can review the proposals of the space that were assigned to them, by: -* change the status of the proposals, by accepting or rejecting them +* change the status of the proposals, by accepting or rejecting them. +* give an answer to the proposals. * 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] diff --git a/docs/en/modules/admin/partials/page_attachments.adoc b/docs/en/modules/admin/partials/page_attachments.adoc index f152f8fe8e..7f5b1c3544 100644 --- a/docs/en/modules/admin/partials/page_attachments.adoc +++ b/docs/en/modules/admin/partials/page_attachments.adoc @@ -1,32 +1,34 @@ = Attachments -Attachments allow an administrator to upload static files to a space. +== Understand the basics -When a space is launched, it is important to provide citizens with as much information as possible about them so that they can participate with knowledge. That is why it is helpful to add files (Attachments) with the information that is considered relevant. +Attachments allow an administrator to upload static files to a space. -Optionally, these documents can be grouped in *Folders*. For example, for a participatory process of remodeling a square, folders could be created with information about possible uses, with plans, with economic information, etc. +When a space is launched, it is important to provide citizens with as much information as possible about them so that they can participate with knowledge. +That is why it is helpful to add files, documents, images with relevant information. -They can be found on the Space homepage: +These documents can be grouped in *Folders*. For example, for a participatory process of remodeling a square, folders could be created with information about possible uses, with plans, with economic information, etc. -image:spaces/attachments_folder.png[View the folder attachments in the public interface] +They can be found on the space xref:admin:spaces/processes/categories.adoc[landing page] when the content block is enabled. image:spaces/attachments.png[View the attachments in the public interface] -== Create a new attachment +== How to find it? -image:spaces/attachments_admin.png[View the attachments in the admin interface] +To create and manage attachments, click the *Attachments* item in the left navigation bar of any participatory space. -For creating a new attachment of a space: +image:spaces/attachments_admin.png[View the attachments in the administration interface] -. Sign in as administrator -. Go to the space section in the sidebar -. Click on the space Edit action -. Click on the Attachments link in the sidebar -. Click on the "New attachment" button +There, you are able to manage the attachments and folders, configure them, add new ones, etc. + +== Create a new attachment + +To create a new attachment, click the "New attachment" button. image:spaces/attachments_new_form.png[Create a new attachment form] .Create attachment +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -34,13 +36,13 @@ image:spaces/attachments_new_form.png[Create a new attachment form] |Required |What is the title for this attachment. -|Weight +|Order position |Optional -|Which order will it have in relation to the other attachments. Having a lower number means a higher priority. For instance, if you have two categories, "Attachment a" with weight "10" and "Attachment b" with weight "0", then "Attachment b" will be first when ordering. +|Which order it has in relation to the other attachments. Having a lower number means a higher priority. For instance, if you have two categories, "Attachment a" with weight "10" and "Attachment b" with weight "0" then "Attachment b" will be first when ordering. |Description |Required -|A long description explaining what this file is about. +|A long description explaining what this attachment is about. |Folder |Optional @@ -48,13 +50,16 @@ image:spaces/attachments_new_form.png[Create a new attachment form] |File |Required -|Upload the file. Guidance for file: Has to be an image or a document. For images, use preferrably landscape images, the -service crops the image. For CSV files, the separator between columns must be a comma (","). Maximum file size: 10MB. Allowed +|Upload the file. Guidance for file: Has to be an image or a document. Maximum file size: 10 MB. Allowed file extensions depends in your server configuration. |=== == Create a new folder +image:spaces/attachments_folders_admin.png[View the folders in the administration interface] + +To create and manage attachments folders, click the *Folders* tab. + image:spaces/attachments_new_folder_form.png[Create a new folder for attachments form] .Create folder @@ -65,11 +70,39 @@ image:spaces/attachments_new_folder_form.png[Create a new folder for attachments |Required |Name of the folder -|Weight +|Order position |Optional -|Which order will it have in relation to the other folders. Having a lower number means a higher priority. For instance, if you have two folders, "Folder a" with weight "10" and "Folder b" with weight "0", then "Folder b" will be first when ordering. +|Which order it has in relation to the other folders. Having a lower number means a higher priority. For instance, if you have two folders, "Folder a" with weight "10" and "Folder b" with weight "0" then "Folder b" will be first when ordering. |Description |Required |A long description explaining what this folder is about. |=== + +== Manage attachments + +You can find all the attachments on the list in the administration panel, with: + +* *Title*: title of the attachment, given when creating or editing it. +* *Folder*: folder where the attachment is stored. +* *Type*: extension type of the attachment. +* *Size*: size of the attachment in bites. + +You can also access the folders list by clicking the "Folders" tab on top of the attachments list. + +== Actions + +.Components actions in component list +[cols="20h,10h,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|To edit the name, description, order position and the folder of the attachment. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete the attachment. + +|=== \ No newline at end of file diff --git a/docs/en/modules/admin/partials/page_categories.adoc b/docs/en/modules/admin/partials/page_categories.adoc index 7d0588ce39..49cb064844 100644 --- a/docs/en/modules/admin/partials/page_categories.adoc +++ b/docs/en/modules/admin/partials/page_categories.adoc @@ -1,40 +1,40 @@ = Categories +== Understand the basics Categories (and subcategories) are used for classifying resources inside of a space. An administrator can define them, can be assigned to when creating resources, and then participants can filter the -different resources by these categories. For instance, they can be set up in proposals, meetings and debates. +different resources by these categories. For instance, they can be used in proposals, meetings, and debates. -As an example of this mechanism in action you can see it in https://meta.decidim.org/processes/roadmap/f/122/[Propose new functionalities for Decidim software] process: +. Administrators define categories in a space. +. Participants can create resources and give them a category. +. Participants can then filter by categories. -. Administrators have defined the categories in the process. -. Participants can create proposals that have one category. -. Participants can filter by these categories and navigate among all the proposals. +image::spaces/categories_sidebar.png[Filter categories in proposals] -image:spaces/categories_sidebar.png[Filter categories in proposals] - -image:spaces/categories_form.png[Select a category when creating a proposal] - -NOTE: Once a category is in use it cannot be removed, as there are resources that are using it. +NOTE: Once a category is in use it can't be deleted, as there are resources that are linked to it. Decidim has other ways to classify resources, for instance xref:admin:scopes.adoc[Scopes] and xref:admin:features/hashtags.adoc[Hashtags]. The main difference is that Categories can be defined in a given space, Scopes are global for all the platform, and Hashtags -are defined by the participants. +can be defined by the participants. Categories can be nested, meaning that a category can have subcategories. -== Create a new category +== How to find it? + +To configure categories, click the *Categories* item in any participatory space. -For configuring a new category, go to the space admin panel and click on the "Categories" tab. +image::spaces/categories.png[View categories in a space administration page] -image:spaces/categories.png[View categories in a space admin page] +== Create a new category -Then click in "Add category" and fill the form. +Click in "New category" button on the top right. image:spaces/categories_new_form.png[Create a new category form] -.Create category +.Create category form +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -42,16 +42,34 @@ image:spaces/categories_new_form.png[Create a new category form] |Required |What is the name for this category. -|Weight +|Order position |Optional -|Which order will it have in relation to the other categories. Having a lower number means a higher priority. For instance, if you have two categories, "Category a" with weight "10" and "Category b" with weight "0", then "Category b" will be first when ordering. - -|Description -|Required -|A long description explaining what this category is about. +|Which order it has in relation to the other categories. Having a lower number means a higher priority. For instance, if you have two categories, "Category a" with weight "10" and "Category b" with weight "0" then "Category b" is first when ordering. |Parent |Optional |What is the parent category. |=== +== Manage categories + +You can find all the categories on the list in the administration panel, with: + +* *Name*: name of the category, given when creating or editing it by the administrator. + +== Actions + +.Components actions in component list +[cols="20h,10h,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|To edit the name, the order position and the parent of the category. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete the category. A category can't be deleted if it has resources attached to it. + +|=== diff --git a/docs/en/modules/admin/partials/page_components.adoc b/docs/en/modules/admin/partials/page_components.adoc index 79243f09e2..691aa84647 100644 --- a/docs/en/modules/admin/partials/page_components.adoc +++ b/docs/en/modules/admin/partials/page_components.adoc @@ -1,52 +1,80 @@ = Components +== Understand the basics + +As explained in the xref:admin:index.adoc[introduction page], to understand how Decidim works, you need to distinguish between *spaces* and *components*. +The participatory spaces are the channels that citizens can participate through when public decisions are being taken, whereas participatory components are +mechanisms that enable interaction between users of the platform and the various participatory spaces. + +All components can be enabled in each space, for example you can enable three Proposals components in a same participatory process, or having all the +components enabled in an assembly space. + include::partial$components_list.adoc[] -To configure components, click on *Components* from the space submenu. A list will appear showing the components -that have already been configured for the space. +== How to find it? + +To configure components, click the *Components* item in any participatory space. + +image::spaces/components/components.png[Components of space] + +There, you are able to manage the already added components, configure them, add new ones, etc. + +== Manage components + +You can find all the components on the list in the administration panel, with: -image::spaces/components.png[Components of space] +* *Component name*: title of the component, given when creating or editing it. +* *Component type*: type of the component. +* *Component scope*: in a same space, components can have different scopes. -To configure a new component, click on *Add component* from the upper right part of the screen and select the type of -component you wish to configure from the drop-down menu. +== Create a component -image::spaces/components_new_dropdown.png[Add a component in a space] +To configure a new component, click the *Add component* from the upper right part of the screen and select the type of +component you want. + +image::spaces/components/components_new_dropdown.png[Add a component in a space] == Actions +.Components actions in component list +[cols="20h,10h,~"] |=== |Icon |Name |Definition -|image:action_manage.png[Manage icon] +|image:icons/action_edit.png[Manage icon] |Manage |To manage all the resources inside of a component. For instance, all the Proposals of a Proposal component, the Meetings in a Meeting component, etc. -|image:action_publish.png[Publish icon] +|image:icons/action_share.png[Share icon] +|Share +|To share privately before publishing this component. Useful for getting reviews from other people of your organization. + +|image:icons/action_configure.png[Configure icon] +|Configure +|To configure a component with specific rules, for instance, in the case of Meetings: +are comments enabled, participants can create meetings or not, etc. + +|image:icons/action_publish.png[Publish icon] |Publish -|To publish a component. This means that the component will be visible to the public. +|To publish a component. This means that the component is then visible to the public. -|image:action_unpublish.png[Unpublish icon] +|image:icons/action_unpublish.png[Unpublish icon] |Unpublish -|To unpublish a component. This means that the component will be invisible to the public. +|To unpublish a component. This means that the component is then invisible to the public. -|image:action_configure.png[Configure icon] -|Configure -|To configure a component with the specific rules. Depends in the component type. For instance, in the case of Meetings: -are comments enabled, participants can create meetings, etc. +|image:icons/action_preview.png[Preview icon] +|Preview +|To preview the space before it's published. -|image:action_permissions.png[Permissions icon] +|image:icons/action_permissions.png[Permissions icon] |Permissions -|To configure which xref:customize:authorizations.adoc[Authorization] will be necessary to make certain actions in -this component. For instance, in the case of Proposals, which Verification will be necessary to create a new proposal or +|To configure which xref:customize:authorizations.adoc[Authorization] is necessary to make certain actions in +this component. For instance, in the case of Proposals, which Verification is needed to create a new proposal or to give supports. -|image:action_share.png[Share icon] -|Share -|To share privately before publishing this component. Useful for reviewing with other people inside of your organization. - -|image:action_delete.png[Delete icon] +|image:icons/action_delete.png[Delete icon] |Delete -|To delete this component. If there are contents most of the components will not let you delete them so it doesn't break +|To delete this component. If there are content inside, most of the components don't let you delete them so it doesn't break relations with other resources. In those cases it's recommended to just unpublish the component. |=== diff --git a/docs/en/modules/admin/partials/page_landing_page.adoc b/docs/en/modules/admin/partials/page_landing_page.adoc new file mode 100644 index 0000000000..c7f4567c45 --- /dev/null +++ b/docs/en/modules/admin/partials/page_landing_page.adoc @@ -0,0 +1,154 @@ += Landing page + +== Understand the basics + +Each process and assembly has a landing page, with different content blocks that can be added, deleted, enabled, ordered, and configured, +just as the xref:admin:homepage.adoc[Homepage] content blocks. + +In order to organize a landing page, enter the space and click the landing page item in the left navigation bar. +You are redirected to the landing page configuration panel. + +. Add different content blocks by clicking the "Add content block" button, and choose the one you want to add. +. Configure the content block when it's possible. +. Finally, move the content block in the active content blocks column to make it appear on the homepage. + +image::spaces/landing_page/landing_page_admin.png[Landing page content blocks] + +== Landing page content blocks + +Below, you'll find all the content blocks configuration guides and screenshots of how there are displayed on the homepage. + +=== Hero image and CTA + +The Hero image and CTA content blocks allow to display in the space landing page: + +* *title*: the space title. +* *hashtag*: the space hashtag redirecting to the X platform. +* *subtitle*: the space subtitle. +* *a call to action button*: by default, the button isn't display. To enable it, click the "Edit" icon of the content block. +* *an image*: the downloaded image is displayed with an opacity filter, to make sure the text is readable. + +image::spaces/landing_page/hero_admin.png[Landing page content Hero image content block form] + +.Admin hero image and CTA landing page content block form +|=== +|Field |Type |Description + +|Call To Action text +|Optional +|Text displayed on the CTA button. + +|Call To Action URL +|Optional +|URL where the button redirects participants. Can be an external URL, or a slug if inside the space. + +|Image +|Optional +|Image displayed in the content block background. Preferably a landscape image that does not have any text + +|=== + +image::spaces/landing_page/hero_front.png[Landing page content Hero image content block frontend] + +=== Announcement + +The announcement block display the content of the announcement field from the space configuration, in a announcement blue box. +It allows administrators to highlight important information. + +image::spaces/landing_page/announcement_front.png[Landing page content Announcement content block] + +=== Main data + +The main data block displays the short description and description of the space, and for assemblies, the purpose of action and composition. + +image::spaces/landing_page/main_data.png[Landing page content Main data content block] + +=== Phase / type & duration + +The phase & duration block displays the process start and end date, and the current xref:admin:spaces/processes/phases.adoc[phase] of processes. +For assemblies, it displays the duration of the assembly. + +image::spaces/landing_page/duration.png[Landing page content Phase and duration content block] + +=== Metadata + +The metadata block displays all the metadata fields entered in the space configuration. + +image::spaces/landing_page/metadata.png[Landing page content Metadata content block] + +=== Last activity + +The last activity block shows the last activities of the space, blog posts, comments, debates, etc. +You can configure the number of avatars displayed next to the title. + +image::spaces/landing_page/activities.png[Landing page content Last activity content block] + +=== Statistics + +image::spaces/landing_page/statistics.png[Landing page content Statistics content block] + +=== Metrics + +image::spaces/landing_page/metrics.png[Landing page content Metrics content block] + +=== Related processes + +image::spaces/landing_page/processes.png[Landing page content Related processes content block] + +You can configure the number of processes to display in this content block by clicking the "Edit" button on the content block. + +image::spaces/landing_page/processes_admin.png[Landing page content Related processes content block] + +=== Related assemblies + +image::spaces/landing_page/assemblies.png[Landing page content Related assemblies content block] + +You can configure the number of assemblies to display in this content block by clicking the "Edit" button on the content block. + +image::spaces/landing_page/assemblies_admin.png[Landing page content Related assemblies content block] + +=== Related documents + +The related documents allows administrator to display the xref:admin:spaces/processes/attachments.adoc[Attachments] on the landing page, except images. + +image::spaces/landing_page/documents.png[Landing page content Related documents content block] + +=== Related images + +The related images allows administrator to display the images xref:admin:spaces/processes/attachments.adoc[Attachments] on the landing page. + +image::spaces/landing_page/images.png[Landing page content Related images content block] + +=== Upcoming meetings + +The upcoming meetings allows administrator to display the upcoming xref:admin:spaces/components/meetings.adoc[Meetings] on the landing page with a map when they have a location. +You can configure the component to take the meetings from by clicking the Edit button of the content block. + +image::spaces/landing_page/meetings.png[Landing page content meetings content block] + +=== Posts + +The posts content block allows administrator to display the last posts published on the space, with their images if they were added as attachments to the posts. +You can configure the component to take the posts from by clicking the Edit button of the content block. + +image::spaces/landing_page/posts.png[Landing page content posts content block] + +=== Proposals + +The proposals allow to display a sample of proposals on the space landing page. + +image::spaces/landing_page/proposals.png[Landing page content proposals block edition] + +You can configure the display order and the Proposal component by clicking the Edit button of the content block. + +image::spaces/landing_page/proposals_admin.png[Landing page proposals content block] + +=== Results + +image::spaces/landing_page/results.png[Landing page results content block] + +You can configure the display order and the Accountability to take the results from component by clicking the Edit button of the content block. + +=== HTML + +The HTML block content block allows to add an editable HTML block on the landing page, and therefore to create a personalized section. \ No newline at end of file diff --git a/docs/en/modules/admin/partials/page_moderations.adoc b/docs/en/modules/admin/partials/page_moderations.adoc index c89ad5e71b..881e6eb0a6 100644 --- a/docs/en/modules/admin/partials/page_moderations.adoc +++ b/docs/en/modules/admin/partials/page_moderations.adoc @@ -2,8 +2,6 @@ Moderations inside of a space work like xref:global_moderations.adoc[Global moderations]. -The main difference is that if you want so you can invite Moderators of this specific -space and they will only have access to the reports made for +The main difference is that if you can invite Moderators of this specific space in the +xref:admin:spaces/processes/admins.adoc[space admins] section, so they only have access to the reports made for contents of this space. - -Moderators are a kind of space admins. See it for instance for xref:spaces/processes/admins.adoc[participatory processes admins]. diff --git a/docs/en/modules/admin/partials/page_private_participants.adoc b/docs/en/modules/admin/partials/page_private_participants.adoc index 2f438591e3..b8125c434f 100644 --- a/docs/en/modules/admin/partials/page_private_participants.adoc +++ b/docs/en/modules/admin/partials/page_private_participants.adoc @@ -1,20 +1,27 @@ = 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. +== Understand the basics -image:spaces/private_participants.png[Private participants list] +In some cases, you might want to restrict the participation to a specific group of participants. +For instance this could be a space dedicated to the members of a commission in a big organization. +For these cases you can use the private participants feature. -For inviting private participants of a space: +NOTE: Private participants list can only be reviewed in the administration panel, and is not publicly displayed. -. 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 +== How to find it? -== New participatory space private user +NOTE: Private participants are only available in private spaces. To enable them, make sure you tick the "Private space" checkbox when +creating or editing your process or assembly. + +To create and manage private participants, click the *Private participants* item in the left navigation bar of the space. + +image::spaces/private_participants.png[Private participants list] + +There, you are able to manage the private participants, import them in a batch, add new ones manually, etc. + +== Invite a private participant + +Click on the "New participatory space private user" button. image:spaces/private_participants_new_form.png[New private participant form] @@ -24,53 +31,66 @@ image:spaces/private_participants_new_form.png[New private participant form] |Name |Required -|What is the name of the new participant. +|The name of the new private participant. |Email |Required -|What is the email of the new participant. +|The email of the new private participant. |=== == Import via CSV -image:spaces/private_participants_csv_import.png[Import private participants via CSV] +Click on the "Import via CSV" button. + +image::spaces/private_participants_csv_import.png[Import private participants via CSV] -This form allows you to bulk import the participants of a space. +This form allows you to delete all private participants access at once, and to bulk import via CSV. -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 CSV must follow the following formatting: +* The file must have two columns, first one being emails and the second one being names of the participants you want to import. * 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 (",") +* The separator between columns must be a comma (","). -== Actions +== Invitation -After the participants has been invited, you can resend or delete the invitation. +NOTE: If the email is already linked to an account on the instance, the participant is already able to participate in the space +and won't receive an invitation email. -image:spaces/private_participants_actions.png[Private participants actions] +When a participant is added to the private participant list, but doesn't already have an account, they get an email +with a link for accepting the invitation: -|=== -|Icon |Name |Definition +image::spaces/private_participants_email_invite.png[Email invitation of a private participant] -|image:action_resend_invitation.png[Resend invitation] -|Resend invitation -|If the invitation wasn't accepted, send it again to the user +After clicking in the "Accept invitation" link in the email, they are redirected to the instance and have to finish creating +their account by setting their nickname, password and accepting the Terms of Service. -|image:action_delete.png[Delete invitation] -|Delete invitation -|Revoke the invitation sent to the user +image::spaces/private_participants_user_registration_form.png[User registration form of a private participant] -|=== +== Manage private participants -== Invitation +You can find all the private participants on the list in the administration panel, with: + +* *Name*: name of the private participant. If the account already exists, it is automatically changed for the account username. +* *Email*: email of the participant. +* *Invitation sent at*: date and hour when the invitation email was sent (when participant doesn't already have an account). +* *Invitation accepted at*: date and hour when the invitation email was accepted by the participant. -When a participant was invited they will get an email with a link for accepting the invitation: +You can sort the list by clicking on the columns header, filter it and search for participants by their name or email. -image:spaces/private_participants_email_invite.png[Email invitation of a private participant] +== Actions -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. +|=== +|Icon |Name |Definition -image:spaces/private_participants_user_registration_form.png[User registration form of a private participant] +|image:icons/action_resend.png[Resend invitation] +|Resend invitation +|If the invitation wasn't accepted, send it again to the participant. + +|image:icons/action_delete.png[Delete] +|Delete invitation +|Revoke the access granted to the participant. + +|===