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

Components #184

Draft
wants to merge 20 commits into
base: develop
Choose a base branch
from
Draft
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
6 changes: 6 additions & 0 deletions .github/styles/config/vocabularies/Decidim/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ Config
CSV
[Dd]ecidim
[Ee]mail
end_date
Etherpad
[Ff]aq
[Ff]avicon
[Gg]amification
initializer
Jitsi
[Kk]akogawa
Keka
Mautic
Expand All @@ -16,7 +19,10 @@ Mautic
[Oo]fficializing
[Oo]fficialize
[Oo]fficialized
proposals_ids
proposal_url
[Rr]eoffficialize
start_date
[Un]nfollow
[Uu]nhide
[Uu]npublish
Expand Down
7 changes: 7 additions & 0 deletions docs/en/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,17 @@
**** xref:admin:spaces/conferences/moderations.adoc[Moderations]
** xref:admin:components.adoc[Components]
*** xref:admin:components/accountability.adoc[Accountability]
**** xref:admin:components/accountability/results.adoc[Results]
**** xref:admin:components/accountability/statuses.adoc[Statuses]
**** xref:admin:components/accountability/timeline.adoc[Project evolution]
**** xref:admin:components/accountability/import.adoc[Import and export results]
*** xref:admin:components/blog.adoc[Blog]
*** xref:admin:components/budgets.adoc[Budgets]
**** xref:admin:components/budgets/budgets.adoc[Budgets]
**** xref:admin:components/budgets/projects.adoc[Projects]
*** xref:admin:components/debates.adoc[Debates]
*** xref:admin:components/meetings.adoc[Meetings]
**** xref:admin:components/meetings/meetings.adoc[Meetings creation]
**** xref:admin:components/meetings/registrations.adoc[Registrations]
**** xref:admin:components/meetings/agenda.adoc[Agenda]
**** xref:admin:components/meetings/polls.adoc[Polls]
Expand Down
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.
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.
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/components/blog/example02.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.
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.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified docs/en/modules/admin/assets/images/components/page/new_page.png
70 changes: 70 additions & 0 deletions docs/en/modules/admin/pages/components.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,75 @@
= Components

== Understand the basics

Through components an administrator can enable and configure different participatory mechanisms.
All components are available in all the different xref:admin:spaces.adoc[spaces].

When you create a participatory space, by default, it won't have any component in it.

include::partial$components_list.adoc[]

== How to find it?

Components are accessible in each xref:admin:spaces.adoc[space], through the administration secondary navigation bar.

image::components/components_index_back.png[Component index backend in an assembly]

To create a component, click the "Add component" button and select the type of component you want to create.

Once you start publishing components, participants see links to the different components appear in the space "Main data"
content block in the landing page, in the general search engine, and in the dedicated homepage content blocks.

image::components/components_index_front.png[Component index frontend in an assembly]

== Manage components

On this page, you are able to manage components and create new ones.

You can find all the components of the space on the list, with:

* *Component name*: title of the component, chosen at its creation and editable.
* *Component type*: type of component.
* *Component scope*: the xref:admin:scopes.adoc[scope] of the component.

== Actions

[cols="10h,~,~"]
|===
|Icon |Name |Definition

|image:icons/action_edit.png[Manage component icon]
|Manage
|To edit the resources inside the component, like blog posts, proposals, meetings, etc.

|image:icons/action_share.png[Share icon]
|Share
|Creates a link with a token to share the component with other users.

|image:icons/action_configure.png[Configure icon]
|Configure
|To edit the general configuration of the component.

|image:icons/action_publish.png[Publish component icon]
|Publish
|To publish the component.

|image:icons/action_unpublish.png[Unpublish component icon]
|Unpublish
|To unpublish the component.

|image:icons/action_preview.png[Preview component icon]
|Preview
|Preview of how the component looks in the user interface.

|image:icons/action_permissions.png[Permissions icon]
|Permissions
|To configure which kind of xref:admin:participants/authorizations.adoc[Authorizations]
a participant need to have to be able to perform certain actions in a component.

|image:icons/action_delete.png[Delete component icon]
|Delete
|To delete the component, only possible when there is no participant participation in it.

|===

106 changes: 100 additions & 6 deletions docs/en/modules/admin/pages/components/accountability.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,104 @@
= Accountability

The Accountability component allows people to follow project implementations. It works like a project management system built into the platform. It offers the following features:
== Understand the basics

* creating results that represent projects to be implemented
* subdividing results into projects or sub-projects
* defining and applying progress in implementation statuses (0% to 100% implemented) around their implementation
* displaying the extent of the results’ implementation grouped by categories and scopes
The Accountability component allows administrators to present a summary of the achievements decided upon in assemblies, during
participatory processes, or any other space. Administrators create Results they can then categorize and link to proposals, meetings, or
investment projects (for example, as part of a participatory budget).

Results, projects and statuses can be updated through a CSV (comma-separated values), or manually by the administration interface.
image::components/accountability/example01.png[Example of results list]

Results can be closely monitored, with a history of modifications saved, and percentages of completion and milestones
indicating their progress. The results, projects, and states can be updated manually through the administration panel or through a CSV.

image::components/accountability/example02.png[Example of a result]

In this documentation section, you can find how to configure and manage all of those items:

* xref:admin:components/accountability/results.adoc[Results]
* xref:admin:components/accountability/statuses.adoc[Statuses]
* xref:admin:components/accountability/timeline.adoc[Project evolution]
* xref:admin:components/accountability/import.adoc[Import and export results]

== Configuration

To create an Accountability component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it.

image::components/accountability/component_accountability.png[Add Accountability component button]

Then:

. Click on the "Components" item in the secondary menu
. Click the "Add component" button
. Select "Accountability"
. Fill the component creation form

You can still update this form and the configuration after creating the component, by clicking the
image:icons/action_configure.png[Configure icon] in the components list.

image::components/accountability/component.png[Add component form]

.Accountability form
[cols="20h,10h,~"]
|===
|Field |Type |Description

|Name
|Required
|What is the title of this component. For instance "Accountability"

|Order position
|Optional
|The order of the component in relation with the other components. Having a lower number means a higher priority.
For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0"
then "component b" is first when ordering.

|===

.Global settings
[cols="20h,10h,~"]
|===
|Field |Type |Description

|Scopes enabled
|Optional
|Check if you want to have xref:admin:scopes.adoc[Scopes] filtering available in this component.

|Scope
|Optional
|Which xref:admin:scopes.adoc[Scope] does this component belongs to.

|Comments enabled
|Optional
|Whether you want to have comments in the component.

|Comments max length
|Optional
|The characters limit that participants have when making comments. Leave 0 for the default value.

|Intro
|Optional
|A general introduction that’ll be displayed on the accountability landing page.

|Display progress
|Optional
|Check it if you want a progress bar to be displayed on the results with aa progress level.

|===

.Step settings
[cols="20h,10h,~"]
|===
|Field |Type |Description

|Comments blocked
|Optional
|Whether you want to enable comments for this phase.
|===

== Examples

Below, you can find some links to examples Accountability components:

* https://www.decidim.barcelona/processes/pam/f/8/[2016-2019 Municipal Action Plan in Decidim Barcelona]
* https://ecrivons.angers.fr/processes/BP2022/f/411/[Results for 2022 participatory budget in Angers]
58 changes: 58 additions & 0 deletions docs/en/modules/admin/pages/components/accountability/import.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
= Import results

== Understand the basics

Sometimes, the accountability content is used after an internal process in an organization, such as evaluating the cost of
participatory budget projects in external files, so it can be useful to import new results and results modifications in a batch.

For this, you can use the functionalities of exporting and importing results.

== Export results

You can export results and their comments in different formats by clicking the "Export all" button in the results list:

* Results as CSV
* Results as JSON
* Results as Excel
* Comments as CSV
* Comments as JSON
* Comments as Excel

image::components/accountability/export.png[Import results from CSV form]

== Import results

You can also import results by clicking the "Import" button in the results list in the administration panel.

image::components/accountability/import.png[Import results from CSV form]

=== Import from a component

You can import results directly from a xref:admin:components/budgets.adoc[Budget] component of the same participatory space,
and choose if you want to import all the projects into results or only the one selected for implementation.

image:components/accountability/import_component.png[Import results from CSV form]

=== Import from a CSV

You can also import results from a CSV file.

image:components/accountability/import_csv.png[Import results from CSV form]

To do this, you should follow these steps:

. Create the xref:admin:components/accountability/statuses.adoc[Statuses] for the Results that you want to add
. Create at least one xref:admin:components/accountability/results.adoc[Results] manually through this administration panel
before doing the import, to have a better understanding of the format and what you'll need to fill out.
. Download the xref:_export_results[Export with CSV format]
. Make the changes locally. You can only change the following columns of the CSV:
** category/id: ID for the result category
** scope/id: ID for the result scope
** parent/id: ID of the parent (for related Results). Optional
** title/en: Title in english language. This depends on your platform language configuration.
** description/en: Description in english language. This depends on your platform language configuration.
** start_date: date when the result starts execution (format YYYY-MM-DD)
** end_date: date when the result ends execution (format YYYY-MM-DD)
** status/id: ID of the Status for this result
** progress: Percentage (from 0 to 100) of the execution
** proposals_ids: internal ID of the related proposals (separated with a comma). It gets automatically converted to proposal_url
Loading
Loading