Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Admin #171

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Admin #171

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
*** xref:services:smtp.adoc[SMTP]
*** xref:services:social_providers.adoc[Social Providers]

* Admin
* xref:admin:index.adoc[Admin]
** xref:admin:index.adoc[Introduction]
*** xref:admin:system.adoc[System panel]
*** xref:admin:dashboard.adoc[Dashboard]
Expand Down
Binary file modified docs/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.
Binary file not shown.
62 changes: 45 additions & 17 deletions docs/en/modules/admin/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,55 @@
= Introduction

Deploying Decidim means taking account of all the activities that play a part in the configuration of the platform and the deployment of the participatory processes. Acquiring knowledge in administering Decidim enables control over fundamental matters such as:
== Understand the basics

* configuring a participatory process
* activating a consultation and receiving votes
* moderating the platform
* managing associated legal texts (as the privacy policy)
* managing authorization from the administrators
* monitoring and verifying organizations
Deploying Decidim means taking account of all the activities that play a part in the configuration of the platform and the deployment
of the participatory processes. Acquiring knowledge in administering Decidim enables control over fundamental matters such as:

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.
* configuring a participatory process
* creating an assembly and managing its members
* opening an initiative space
* moderating the contents of the platform
* managing associated legal texts, such as the privacy policy
* managing access rights of administrators
* monitoring and verifying participants and their organizations

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.
None of these aspects are strictly technical but they do involve a series of political decisions over how you want your instance to work,
what messages and contents it contains, what the moderation policy should be, and overall how you want your participatory
platform to function. This is why it is essential to understand the socio-technical implications of the Decidim platform’s

Check warning on line 18 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Contractions] Use 'it's' instead of 'it is'. Raw Output: {"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 18, "column": 35}}}, "severity": "INFO"}
administration and management.

image:introduction.png[Spaces and components]
To understand how Decidim works, you first need to distinguish between xref:spaces.adoc[*spaces*] and xref:components.adoc[*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.
* *Participatory spaces* are the channels that citizens can participate through (participatory processes, assemblies, initiatives and conferences.)

Check warning on line 23 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 23, "column": 81}}}, "severity": "INFO"}
* *Participatory components* are mechanisms that enable interaction between participants and the participatory spaces (meetings, pages, proposals, surveys, etc.)

Check warning on line 24 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 24, "column": 119}}}, "severity": "INFO"}

image:introduction_process.png[Components in a participatory process]
Therefore, all participatory spaces can incorporate several components, such as meetings, proposals, surveys, or results.

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.

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.
image:introduction.png[Spaces and components]

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).
So, administrators configure participatory spaces by defining and configuring the components they are going to need.

Check warning on line 30 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Contractions] Use 'they're' instead of 'they are'. Raw Output: {"message": "[Google.Contractions] Use 'they're' instead of 'they are'.", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 30, "column": 94}}}, "severity": "INFO"}
It's important to bear in mind that these participatory components and the various functions are repeated in the various spaces,

Check warning on line 31 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('are repeated'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('are repeated').", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 31, "column": 94}}}, "severity": "INFO"}
offering many opportunities when it comes to configuring the various spaces.
This simplifies learning as once a space is configured, it's then easier to configure others.

Check warning on line 33 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is configured'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is configured').", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 33, "column": 42}}}, "severity": "INFO"}

This documentation section provides a full description of how to configure the Decidim platform for any kind of organization
and how to configure, manage and administer your various participatory processes. A description has been given in tutorial format,

Check warning on line 36 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('been given'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('been given').", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 36, "column": 101}}}, "severity": "INFO"}
to help with understanding administration tasks, following Decidim’s literal fields and enclosing screenshots to facilitate their
interpretation.

Managing (administering) the Decidim platform is quite intuitive and don't require specific IT knowledge.

Check warning on line 40 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 40, "column": 10}}}, "severity": "INFO"}
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

Check warning on line 42 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 42, "column": 45}}}, "severity": "INFO"}
(configuring, editing, analysing and concluding).

Check warning on line 43 in docs/en/modules/admin/pages/index.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/en/modules/admin/pages/index.adoc", "range": {"start": {"line": 43, "column": 1}}}, "severity": "INFO"}

== Get started

* xref:admin:.adoc[Getting started]
* xref:admin:.adoc[Settings]
* xref:admin:pages.adoc[Pages and topics]
* xref:admin:participants.adoc[Participants]
* xref:admin:.adoc[Global moderation]
* xref:admin:spaces.adoc[Spaces]
* xref:admin:components.adoc[Components]
* xref:admin:.adoc[Features]
* xref:admin:.adoc[Templates]
Loading