Skip to content

Commit

Permalink
Partials (decidim#179)
Browse files Browse the repository at this point in the history
* Create landing page partial

* Add assembly landing page and include partial

* Rename screenshots and add assemblies specific content blocks

* Update component partials

* Update categories partial

* Update attachment partial

* Update space admins partial

* Fix folder screenshot

* Update private participants partial

* Update moderations partial

* Fix some vale warnings

* Add component explanation

---------

Co-authored-by: paulinebessoles <[email protected]>
  • Loading branch information
paulinebessoles and paulinebessoles authored Dec 20, 2024
1 parent 060be3b commit ea6d8c4
Show file tree
Hide file tree
Showing 63 changed files with 438 additions and 140 deletions.
1 change: 1 addition & 0 deletions .github/styles/config/vocabularies/Decidim/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ Keka
[Rr]eoffficialize
[Un]nfollow
[Uu]nhide
[Uu]npublish
[Uu]nreport
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/modules/admin/assets/images/spaces/admins_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/modules/admin/assets/images/spaces/attachments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/modules/admin/assets/images/spaces/categories.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Diff not rendered.
10 changes: 10 additions & 0 deletions docs/en/modules/admin/pages/spaces/assemblies/landing_page.adoc
Original file line number Diff line number Diff line change
@@ -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]
21 changes: 10 additions & 11 deletions docs/en/modules/admin/partials/components_list.adoc
Original file line number Diff line number Diff line change
@@ -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].
83 changes: 60 additions & 23 deletions docs/en/modules/admin/partials/page_admins.adoc
Original file line number Diff line number Diff line change
@@ -1,66 +1,103 @@
= 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]

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]
73 changes: 53 additions & 20 deletions docs/en/modules/admin/partials/page_attachments.adoc
Original file line number Diff line number Diff line change
@@ -1,60 +1,65 @@
= 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

|Attachment or image name
|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
|Which folder this attachment belongs to.

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

|===
62 changes: 40 additions & 22 deletions docs/en/modules/admin/partials/page_categories.adoc
Original file line number Diff line number Diff line change
@@ -1,57 +1,75 @@
= 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

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

|===
Loading

0 comments on commit ea6d8c4

Please sign in to comment.