diff --git a/.github/styles/config/vocabularies/Decidim/accept.txt b/.github/styles/config/vocabularies/Decidim/accept.txt index d1dcd78004..31e7bdab35 100644 --- a/.github/styles/config/vocabularies/Decidim/accept.txt +++ b/.github/styles/config/vocabularies/Decidim/accept.txt @@ -15,4 +15,5 @@ Keka [Rr]eoffficialize [Un]nfollow [Uu]nhide +[Uu]npublish [Uu]nreport diff --git a/docs/en/modules/admin/assets/images/icons/action_configure.png b/docs/en/modules/admin/assets/images/icons/action_configure.png new file mode 100644 index 0000000000..9766f07b4c Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_configure.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_permissions.png b/docs/en/modules/admin/assets/images/icons/action_permissions.png new file mode 100644 index 0000000000..991323b28e Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_permissions.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_publish.png b/docs/en/modules/admin/assets/images/icons/action_publish.png new file mode 100644 index 0000000000..96b75d3904 Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_publish.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_unpublish.png b/docs/en/modules/admin/assets/images/icons/action_unpublish.png new file mode 100644 index 0000000000..e55816278b Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_unpublish.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/admins_form.png b/docs/en/modules/admin/assets/images/spaces/admins_form.png index d69d640c1c..9534d9b862 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/admins_form.png and b/docs/en/modules/admin/assets/images/spaces/admins_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/admins_list.png b/docs/en/modules/admin/assets/images/spaces/admins_list.png new file mode 100644 index 0000000000..961a6b3c5c Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/admins_list.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/admins_role_admin01.png b/docs/en/modules/admin/assets/images/spaces/admins_role_admin01.png index c949a6c74c..ab798d11a3 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/admins_role_admin01.png and b/docs/en/modules/admin/assets/images/spaces/admins_role_admin01.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/admins_role_admin02.png b/docs/en/modules/admin/assets/images/spaces/admins_role_admin02.png index 19aab7fa0c..6049b9397c 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/admins_role_admin02.png and b/docs/en/modules/admin/assets/images/spaces/admins_role_admin02.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/admins_role_collaborator.png b/docs/en/modules/admin/assets/images/spaces/admins_role_collaborator.png index 38f323cc3e..4ed1990bcd 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/admins_role_collaborator.png and b/docs/en/modules/admin/assets/images/spaces/admins_role_collaborator.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/admins_role_moderator.png b/docs/en/modules/admin/assets/images/spaces/admins_role_moderator.png index ed7dafd6b8..7dea2be7aa 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/admins_role_moderator.png and b/docs/en/modules/admin/assets/images/spaces/admins_role_moderator.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/admins_role_valuator.png b/docs/en/modules/admin/assets/images/spaces/admins_role_valuator.png index 798c6c8ec3..bad6220a81 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/admins_role_valuator.png and b/docs/en/modules/admin/assets/images/spaces/admins_role_valuator.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/attachments.png b/docs/en/modules/admin/assets/images/spaces/attachments.png index 3274d47e2d..5323503d08 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/attachments.png and b/docs/en/modules/admin/assets/images/spaces/attachments.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/attachments_admin.png b/docs/en/modules/admin/assets/images/spaces/attachments_admin.png index 170242178f..de3f32de6c 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/attachments_admin.png and b/docs/en/modules/admin/assets/images/spaces/attachments_admin.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/attachments_folder.png b/docs/en/modules/admin/assets/images/spaces/attachments_folder.png deleted file mode 100644 index 27d1e2607e..0000000000 Binary files a/docs/en/modules/admin/assets/images/spaces/attachments_folder.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/attachments_folders_admin.png b/docs/en/modules/admin/assets/images/spaces/attachments_folders_admin.png new file mode 100644 index 0000000000..61613a6f4a Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/attachments_folders_admin.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/attachments_new_folder_form.png b/docs/en/modules/admin/assets/images/spaces/attachments_new_folder_form.png index 6e54583d03..ff8f1d9506 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/attachments_new_folder_form.png and b/docs/en/modules/admin/assets/images/spaces/attachments_new_folder_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/attachments_new_form.png b/docs/en/modules/admin/assets/images/spaces/attachments_new_form.png index d15d32bc55..c7e83bcd5b 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/attachments_new_form.png and b/docs/en/modules/admin/assets/images/spaces/attachments_new_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/categories.png b/docs/en/modules/admin/assets/images/spaces/categories.png index b99f36a0fd..528190c095 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/categories.png and b/docs/en/modules/admin/assets/images/spaces/categories.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/categories_form.png b/docs/en/modules/admin/assets/images/spaces/categories_form.png deleted file mode 100644 index e85b118fb2..0000000000 Binary files a/docs/en/modules/admin/assets/images/spaces/categories_form.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/categories_new_form.png b/docs/en/modules/admin/assets/images/spaces/categories_new_form.png index 33d6aba202..1f0fb420b3 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/categories_new_form.png and b/docs/en/modules/admin/assets/images/spaces/categories_new_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/categories_sidebar.png b/docs/en/modules/admin/assets/images/spaces/categories_sidebar.png index 04f56175ab..e57cfc6511 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/categories_sidebar.png and b/docs/en/modules/admin/assets/images/spaces/categories_sidebar.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/components.png b/docs/en/modules/admin/assets/images/spaces/components.png deleted file mode 100644 index 5506322476..0000000000 Binary files a/docs/en/modules/admin/assets/images/spaces/components.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/components/components.png b/docs/en/modules/admin/assets/images/spaces/components/components.png new file mode 100644 index 0000000000..200a9158fa Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/components/components.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/components/components_new_dropdown.png b/docs/en/modules/admin/assets/images/spaces/components/components_new_dropdown.png new file mode 100644 index 0000000000..d298f0c49e Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/components/components_new_dropdown.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/components_new_dropdown.png b/docs/en/modules/admin/assets/images/spaces/components_new_dropdown.png deleted file mode 100644 index cec94ef25b..0000000000 Binary files a/docs/en/modules/admin/assets/images/spaces/components_new_dropdown.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/activities.png b/docs/en/modules/admin/assets/images/spaces/landing_page/activities.png new file mode 100644 index 0000000000..04cbec678f Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/activities.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/announcement_front.png b/docs/en/modules/admin/assets/images/spaces/landing_page/announcement_front.png new file mode 100644 index 0000000000..6d8419a9d8 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/announcement_front.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/assemblies.png b/docs/en/modules/admin/assets/images/spaces/landing_page/assemblies.png new file mode 100644 index 0000000000..c382abc549 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/assemblies.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/assemblies_admin.png b/docs/en/modules/admin/assets/images/spaces/landing_page/assemblies_admin.png new file mode 100644 index 0000000000..7dbf6547b3 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/assemblies_admin.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/dates_metadata.png b/docs/en/modules/admin/assets/images/spaces/landing_page/dates_metadata.png new file mode 100644 index 0000000000..39e4622484 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/dates_metadata.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/documents.png b/docs/en/modules/admin/assets/images/spaces/landing_page/documents.png new file mode 100644 index 0000000000..2c31738af7 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/documents.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/duration.png b/docs/en/modules/admin/assets/images/spaces/landing_page/duration.png new file mode 100644 index 0000000000..3e6e85fa7a Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/duration.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/hero_admin.png b/docs/en/modules/admin/assets/images/spaces/landing_page/hero_admin.png new file mode 100644 index 0000000000..bd63445966 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/hero_admin.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/hero_front.png b/docs/en/modules/admin/assets/images/spaces/landing_page/hero_front.png new file mode 100644 index 0000000000..0c80b054bd Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/hero_front.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/images.png b/docs/en/modules/admin/assets/images/spaces/landing_page/images.png new file mode 100644 index 0000000000..dba50948ed Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/images.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/landing_page_admin.png b/docs/en/modules/admin/assets/images/spaces/landing_page/landing_page_admin.png new file mode 100644 index 0000000000..7cc4197613 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/landing_page_admin.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/main_data.png b/docs/en/modules/admin/assets/images/spaces/landing_page/main_data.png new file mode 100644 index 0000000000..6019e04fc1 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/main_data.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/meetings.png b/docs/en/modules/admin/assets/images/spaces/landing_page/meetings.png new file mode 100644 index 0000000000..014f34553d Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/meetings.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/metadata.png b/docs/en/modules/admin/assets/images/spaces/landing_page/metadata.png new file mode 100644 index 0000000000..64323b5651 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/metadata.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/metrics.png b/docs/en/modules/admin/assets/images/spaces/landing_page/metrics.png new file mode 100644 index 0000000000..4b54fe1f13 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/metrics.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/posts.png b/docs/en/modules/admin/assets/images/spaces/landing_page/posts.png new file mode 100644 index 0000000000..a90cbc3c82 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/posts.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/processes.png b/docs/en/modules/admin/assets/images/spaces/landing_page/processes.png new file mode 100644 index 0000000000..93e0670ff7 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/processes.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/processes_admin.png b/docs/en/modules/admin/assets/images/spaces/landing_page/processes_admin.png new file mode 100644 index 0000000000..338a46e0b7 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/processes_admin.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/proposals.png b/docs/en/modules/admin/assets/images/spaces/landing_page/proposals.png new file mode 100644 index 0000000000..03ffb65479 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/proposals.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/proposals_admin.png b/docs/en/modules/admin/assets/images/spaces/landing_page/proposals_admin.png new file mode 100644 index 0000000000..d048d0d286 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/proposals_admin.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/results.png b/docs/en/modules/admin/assets/images/spaces/landing_page/results.png new file mode 100644 index 0000000000..be30903930 Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/results.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/social_networks.png b/docs/en/modules/admin/assets/images/spaces/landing_page/social_networks.png new file mode 100644 index 0000000000..ed7c47dbaf Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/social_networks.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/landing_page/statistics.png b/docs/en/modules/admin/assets/images/spaces/landing_page/statistics.png new file mode 100644 index 0000000000..092003c04d Binary files /dev/null and b/docs/en/modules/admin/assets/images/spaces/landing_page/statistics.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/private_participants.png b/docs/en/modules/admin/assets/images/spaces/private_participants.png index aa421081fa..99ba0c7e81 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/private_participants.png and b/docs/en/modules/admin/assets/images/spaces/private_participants.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/private_participants_actions.png b/docs/en/modules/admin/assets/images/spaces/private_participants_actions.png deleted file mode 100644 index cbc0e7f469..0000000000 Binary files a/docs/en/modules/admin/assets/images/spaces/private_participants_actions.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/spaces/private_participants_csv_import.png b/docs/en/modules/admin/assets/images/spaces/private_participants_csv_import.png index 199ca73a3f..233b821bba 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/private_participants_csv_import.png and b/docs/en/modules/admin/assets/images/spaces/private_participants_csv_import.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/private_participants_new_form.png b/docs/en/modules/admin/assets/images/spaces/private_participants_new_form.png index e188a853ad..314ed3acdc 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/private_participants_new_form.png and b/docs/en/modules/admin/assets/images/spaces/private_participants_new_form.png differ diff --git a/docs/en/modules/admin/assets/images/spaces/private_participants_user_registration_form.png b/docs/en/modules/admin/assets/images/spaces/private_participants_user_registration_form.png index cba02ab654..e8292c970c 100644 Binary files a/docs/en/modules/admin/assets/images/spaces/private_participants_user_registration_form.png and b/docs/en/modules/admin/assets/images/spaces/private_participants_user_registration_form.png differ 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. + +|===