forked from decidim/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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
1 parent
060be3b
commit ea6d8c4
Showing
63 changed files
with
438 additions
and
140 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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.
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
BIN
+127 KB
(510%)
docs/en/modules/admin/assets/images/spaces/admins_role_admin01.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 modified
BIN
+197 KB
(550%)
docs/en/modules/admin/assets/images/spaces/admins_role_admin02.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 modified
BIN
+140 KB
(580%)
docs/en/modules/admin/assets/images/spaces/admins_role_collaborator.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 modified
BIN
+132 KB
(580%)
docs/en/modules/admin/assets/images/spaces/admins_role_moderator.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 modified
BIN
+362 KB
(1700%)
docs/en/modules/admin/assets/images/spaces/admins_role_valuator.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 modified
BIN
+164 KB
(770%)
docs/en/modules/admin/assets/images/spaces/attachments_admin.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.
Binary file added
BIN
+130 KB
docs/en/modules/admin/assets/images/spaces/attachments_folders_admin.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 modified
BIN
+77.2 KB
(700%)
docs/en/modules/admin/assets/images/spaces/attachments_new_folder_form.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 modified
BIN
+82.3 KB
(300%)
docs/en/modules/admin/assets/images/spaces/attachments_new_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.
Binary file not shown.
Binary file modified
BIN
+49.5 KB
(360%)
docs/en/modules/admin/assets/images/spaces/categories_new_form.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 modified
BIN
+425 KB
(1800%)
docs/en/modules/admin/assets/images/spaces/categories_sidebar.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.
Binary file added
BIN
+299 KB
docs/en/modules/admin/assets/images/spaces/components/components_new_dropdown.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 removed
BIN
-48.3 KB
docs/en/modules/admin/assets/images/spaces/components_new_dropdown.png
Binary file not shown.
Binary file added
BIN
+300 KB
docs/en/modules/admin/assets/images/spaces/landing_page/activities.png
Oops, something went wrong.
Binary file added
BIN
+53.5 KB
docs/en/modules/admin/assets/images/spaces/landing_page/announcement_front.png
Oops, something went wrong.
Binary file added
BIN
+991 KB
docs/en/modules/admin/assets/images/spaces/landing_page/assemblies.png
Oops, something went wrong.
Binary file added
BIN
+52 KB
docs/en/modules/admin/assets/images/spaces/landing_page/assemblies_admin.png
Oops, something went wrong.
Binary file added
BIN
+42.4 KB
docs/en/modules/admin/assets/images/spaces/landing_page/dates_metadata.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+624 KB
docs/en/modules/admin/assets/images/spaces/landing_page/hero_admin.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+194 KB
docs/en/modules/admin/assets/images/spaces/landing_page/landing_page_admin.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+88.5 KB
docs/en/modules/admin/assets/images/spaces/landing_page/processes_admin.png
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+51.1 KB
docs/en/modules/admin/assets/images/spaces/landing_page/proposals_admin.png
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+47.4 KB
docs/en/modules/admin/assets/images/spaces/landing_page/social_networks.png
Oops, something went wrong.
Binary file added
BIN
+58.1 KB
docs/en/modules/admin/assets/images/spaces/landing_page/statistics.png
Oops, something went wrong.
Binary file modified
BIN
+166 KB
(480%)
docs/en/modules/admin/assets/images/spaces/private_participants.png
Oops, something went wrong.
Binary file removed
BIN
-681 Bytes
docs/en/modules/admin/assets/images/spaces/private_participants_actions.png
Diff not rendered.
Binary file modified
BIN
+128 KB
(440%)
docs/en/modules/admin/assets/images/spaces/private_participants_csv_import.png
Oops, something went wrong.
Binary file modified
BIN
+38.4 KB
(580%)
docs/en/modules/admin/assets/images/spaces/private_participants_new_form.png
Oops, something went wrong.
Binary file modified
BIN
+141 KB
(460%)
...ules/admin/assets/images/spaces/private_participants_user_registration_form.png
Oops, something went wrong.
10 changes: 10 additions & 0 deletions
10
docs/en/modules/admin/pages/spaces/assemblies/landing_page.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|=== |
Oops, something went wrong.