Skip to content

Commit

Permalink
Add Introduction, Spaces and Components in Admin manual
Browse files Browse the repository at this point in the history
  • Loading branch information
andreslucena committed Sep 3, 2021
1 parent b660028 commit 96dc98b
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 25 deletions.
Binary file added en/modules/admin/assets/images/introduction.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 added en/modules/admin/assets/images/spaces_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 added en/modules/admin/assets/images/spaces_visitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion en/modules/admin/pages/components.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
= Components

include::partial$under-construction.adoc[]
Through components an administrator can enable and configure different participatory mechanisms.

include::partial$components_list.adoc[]
12 changes: 7 additions & 5 deletions en/modules/admin/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,17 @@ Deploying Decidim means taking account of all the activities that play a part in
None of these aspects are strictly technical but they do involve a series of political decisions over how we want Decidim to be, what messages and contents it has to contain, what the moderation policy for comments and debates has to be and, above all, how a specific participatory platform has to be, and what functions it has to have active. This is why it is essential to understand the socio-technical implications of the Decidim platform’s administration and management when it comes to deploying the platform.

To understand how Decidim works, we need to distinguish between *participatory spaces* and *components*. The participatory spaces are the channels that citizens can participate through when public decisions are being taken. These are participatory processes, initiatives, consultations and assemblies.
To understand how Decidim works, we need to distinguish between xref:spaces.adoc[*spaces*] and xref:components.adoc[*components*]. The participatory spaces are the channels that citizens can participate through when public decisions are being taken. These are participatory processes, initiatives, consultations and assemblies.
Whereas participatory components are mechanisms that enable interaction between users of the platform and the various participatory spaces. These include meetings, pages, proposals and surveys.

image:introduction.png[Spaces and components]

Therefore, a participatory space as a participatory process, in the various stages, can incorporate several components such as face-to-face meetings, proposals, surveys and results and the monitoring of these.

So, participatory spaces are configured by defining (and configuring) the components they are going to have. It is important to bear in mind that these participatory components and the various functions are repeated in the various spaces, offering many opportunities when it comes to configuring the various spaces. This simplifies learning as once a space has been configured, it is then easier to configure another.
image:introduction_process.png[Components in a participatory process]

This chapter provides a full description of how to configure the Decidim platform for a local authority (or instance) and how to configure, manage and administer the various participatory processes. A description has been given in tutorial format, to help with understanding administration tasks, following Decidim’s literal fields and enclosing screenshots to facilitate their interpretation. This tutorial is subject to the Decidim v09del version and may be amended as it is updated to new versions, especially when it comes to incorporating new components and participatory spaces and modules.
So, participatory spaces are configured by defining (and configuring) the components they are going to have. It is important to bear in mind that these participatory components and the various functions are repeated in the various spaces, offering many opportunities when it comes to configuring the various spaces. This simplifies learning as once a space has been configured, it is then easier to configure another.

Managing (administering) the Decidim platform is relatively simple and intuitive and no specific IT knowledge is required. The administrators of a Decidim platform, in other words, those with the necessary authorization for managing the platform, can configure the platform in a general way (images, information etc.,) and manage the various participatory processes (configuring, editing, analysing and concluding).
This section provides a full description of how to configure the Decidim platform for any kind of organization and how to configure, manage and administer the various participatory processes. A description has been given in tutorial format, to help with understanding administration tasks, following Decidim’s literal fields and enclosing screenshots to facilitate their interpretation.

What is more, they can authorize several individuals to configure certain participatory processes (“process administrators”) or monitor the processes (“collaborators”). Collaborators, can see what is on the process administrator menu though they cannot edit.
Managing (administering) the Decidim platform is relatively simple and intuitive and no specific IT knowledge is required. The administrators of a Decidim platform, in other words, those with the necessary authorization for managing the platform, can configure the platform in a general way (images, information pages, etc.,) and manage the various participatory processes (configuring, editing, analysing and concluding).
11 changes: 10 additions & 1 deletion en/modules/admin/pages/spaces.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
= Spaces

include::partial$under-construction.adoc[]
The participatory spaces are the channels that citizens can participate through when public decisions are being taken. By default
the platform is provided with participatory processes, initiatives, consultations, conferences, votings and assemblies, but
any organization can develop its own mechanisms through xref:develop:modules.adoc[Modules].

They are accessible through the main sidebar in the administration panel, and also through the main navigation menu in the
public interface.

image:spaces_admin.png[Spaces in admin sidebar]

image:spaces_visitor.png[Spaces visible in the public interface]
19 changes: 19 additions & 0 deletions en/modules/admin/partials/components_list.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

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/elections.adoc[*Elections*]: to have end-to-end auditable elections in a space. Uses the same
external system as xref:admin:spaces/votings.adoc[Votings] space.
* xref:admin:components/meetings.adoc[*Meetings*]: gatherings in person or online through videoconferences platforms.
* 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/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].
19 changes: 1 addition & 18 deletions en/modules/admin/partials/page_components.adoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,6 @@
= Components

Spaces 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/elections.adoc[*Elections*]: to have end-to-end auditable elections in a space. Uses the same
external system as xref:admin:votings.adoc[Votings] space.
* xref:admin:components/meetings.adoc[*Meetings*]: gatherings in person or online through videoconferences platforms.
* 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/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].
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.
Expand Down

0 comments on commit 96dc98b

Please sign in to comment.