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

Initiatives #182

Merged
merged 15 commits into from
Jan 10, 2025
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 @@ -6,6 +6,7 @@ CSV
[Ff]aq
[Ff]avicon
[Gg]amification
initializer
[Kk]akogawa
Keka
Mautic
Expand Down
11 changes: 11 additions & 0 deletions docs/en/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,17 @@
**** xref:admin:spaces/assemblies/private_participants.adoc[Private participants]
**** xref:admin:spaces/assemblies/moderations.adoc[Moderations]
*** xref:admin:spaces/initiatives.adoc[Initiatives]
**** xref:admin:spaces/initiatives/types.adoc[Initiatives types]
**** xref:admin:spaces/initiatives/initiative_creation.adoc[Initiative creation]
***** xref:admin:spaces/initiatives/author_manage/committee.adoc[Promoter’s committee]
***** xref:admin:spaces/initiatives/author_manage/manage.adoc[Author actions]
**** xref:admin:spaces/initiatives/manage.adoc[Initiative management]
***** xref:admin:spaces/initiatives/admin_manage/committee.adoc[Committee members]
***** xref:admin:spaces/initiatives/admin_manage/components.adoc[Components]
***** xref:admin:spaces/initiatives/admin_manage/attachments.adoc[Attachments]
***** xref:admin:spaces/initiatives/admin_manage/moderations.adoc[Moderations]
***** xref:admin:spaces/initiatives/admin_manage/answer.adoc[Answer an initiative]
**** xref:admin:spaces/initiatives/sign.adoc[Sign an initiative]
*** xref:admin:spaces/conferences.adoc[Conferences]
**** xref:admin:spaces/conferences/components.adoc[Components]
**** xref:admin:spaces/conferences/categories.adoc[Categories]
Expand Down
Binary file not shown.
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 not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
377 changes: 58 additions & 319 deletions docs/en/modules/admin/pages/spaces/initiatives.adoc

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
= Answer an initiative

== Understand the basics

Initiatives should receive an answer from your organization at some point. It could be before the end of the signature collection period,
because it's been accepted or rejected already by an organ of your structure, or because it reached the number of signatures needed
before the end of the collection period.

== Answer an initiative

Click the "Answer" icon on the list of initiatives to answer an initiative.

image::spaces/initiatives/initiative_backend_answer.png[Initiative backend answer]

On this page, you can see the initiative title, description, creation date, state, and signature number, as well as the
answer fields.

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

|Answer
|Optional
|Content of the initiative answer, that is visible on the initiative page.

|Answer URL
|Optional
|Link added on the answer content.

|Start of signature collection period
|Required
|Date of the start of the signature collection.

|End of signature collection period
|Required
|Date of the end of the signature collection. You can put it the day before if you want to close the initiative to new signatures.

|===

image::spaces/initiatives/initiative_frontend_answer.png[Initiative frontend answer]

== Accept or reject

In order to operate the change on the initiatives list, the administrator needs to go on the edit page of the initiative and
click the button corresponding to the initiative situation.
Once a published initiative collection period is over, there are two options:

. The initiative got enough signatures: Click the "Accept initiative" button
. The initiative didn't get enough signatures: Click the "Reject initiative" button
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

include::partial$page_attachments.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
= Committee members

== Understand the basics

NOTE: Promoter's committee explanation is available on xref:admin:spaces/initiatives/author_manage/committee.adoc[Promoter’s committee].

Committee members might be necessary, depending on the rules set for the initiative types.
Participants can manage them from their initiative edition form, but administrators can also access the list of
committee members.

== Manage committee members

To access the committee members list, click in the secondary navigation panel on the "Committee members" item.

image::spaces/initiatives/initiative_members_admin.png[Initiative committee members list in administration]

There, the author can see and copy the initiative invitation link, and see the list of committee members.

== Actions

|===
|Icon |Name |Definition

|image:icons/action_delete.png[Delete icon]
|Revoke
|Allows to refuse or revoke the committee members right on this initiative.

|image:icons/action_publish.png[Approve icon]
|Approve
|To approve the membership request.

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

include::partial$page_components.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

include::partial$page_moderations.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
= Promoter's committee

== Understand the basics

A promoter's committee is a group of people carrying and promoting the initiative jointly. For example, it could be a collective initiative that needs to be
carried out by several citizens to be accepted by the administration, etc.
Promoter's committee rules are set by the administrators when managing the initiative types, so they can be optional for some initiatives, and mandatory for others,
with the necessity of having three people carrying an initiative for example.

For those initiatives that need a minimum number of members in the promoter's committee, the author needs to send them a link for them to be able to join the committee
before it can be sent for technical validation.

NOTE: Committee members can only be added before the initiative is sent to technical validation.

== Inviting a committee member

During the initiative creation process, or later on the initiative page and edit form, the author can copy an invitation link.
They should send this link to the other initiative promoters.

image::spaces/initiatives/promoter_link_show.png[Promoter's committee link in initiative show]

image::spaces/initiatives/promoter_link_edit.png[Promoter's committee link in initiative edit form]

When going on the link, the invited committee member can see the initiative title and content, and can request to become a member of the promoter committee.

image::spaces/initiatives/promoter_link_page.png[Promoter's committee request page]

The author of an initiative can manage the committee members requests in the edition page of the initiative.

image::spaces/initiatives/promoter_members_edit.png[Promoter's committee management in initiative edit form]

All the approved committee members are then able to access the initiative, edit it, manage its members, and send it to technical validation.
The initiative can't be sent to technical validation until it meets the minimum number of committee members required.
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
= Manage initiative as an author

== Understand the basics

Initiatives have the peculiarity of being both manageable by administrators and their authors.
Administrators have greater rights, but authors can also manage a certain number of configurations of their initiatives.

== Edit the initiative

Once the initiative is created, the author can see the initiative page, but until the initiative is reviewed and accepted by an administrator, through the technical validation,
it is not published and visible for all the participants.

image::spaces/initiatives/initiative_show.png[Initiative show]

Once the initiative is created and before it's sent to technical validation, an author can edit and correct the initiative if it has any error.

image::spaces/initiatives/initiative_edit.png[Initiative edit]

If the xref:admin:spaces/initiatives/author_manage/committee.adoc[Promoting committee] is enabled for the initiative type of this initiative, the author of an initiative can manage requests and committee members at the end of the edit form.

== Send to technical validation

Once all the conditions are right, if the initiative is ready and has enough committee members, the author can send the initiative to technical validation.
When clicking on the "Send to technical validation" button, a modal is displayed to warn the author that they won't be able to edit it after this action.

image::spaces/initiatives/initiative_send_to_technical_validation.png[Send initiative to technical validation]

== Retrieve created initiatives

Authors can also find their initiatives in the initiatives index by un-checking the "Open" status filter, and clicking on the "My initiatives" filter.

image::spaces/initiatives/initiative_filters_my_initiatives.png[Filters for my initiatives]
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
= Initiative creation

== Understand the basics

Once you configured the xref:admin:spaces/initiatives/types.adoc[initiatives types and scopes], you should be able to access the initiative space in the user interface.

image::spaces/initiatives/initiatives_index_front.png[Initiatives index in front without initiatives]

Participants are now able to create initiatives.
Depending on how the initiatives module is configured in the initializer or how the initiative type is configured, it may need to ask for an authorization.

== Initiative creation steps

To start creating an initiative, the participant must click in the "New initiative" button.
Depending on the configuration of your instance, they have to pass different steps before being able to send their initiative to technical validation, where it gets reviewed
by an administrator before being published and starting collecting signatures.

=== Initiative type choice

If the instance has multiple initiative types, then the first step is the choice of the initiative type.

image::spaces/initiatives/initiative_new_step_type.png[Initiative creation: initiative type choice]

If there is only one initiative type configured, this step is automatically skipped.

=== Content creation

image::spaces/initiatives/initiative_new_step_content.png[Initiative creation: initiative content creation]

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

|Title
|Required
|The title of the initiative.

|Description
|Required
|The content of the initiative.

|Hashtag
|Optional
|A hashtag for the initiative, to communicate about it on the platform and social media.

|Signature collection type
|Required
|Depends on the configuration of the initiative type.

|Scope
|Required
|Depends on the configuration of the initiative type and type scopes.

|End of signature collection period
|Optional
|If the author wants to change the signature collection end date. Can be configured from the initiative type.

|Area
|Optional
|If the author wants to categorize their initiative.

|Add documents
|Optional
|If the author wants to add attachments to their initiative.

|Add image
|Optional
|If the author wants to add an image, that is then displayed on the initiative card in the initiatives list.

|===

=== Similarity comparison

Can be disabled by your organization implementer.
Checks the rest of the initiatives if there are other similar initiatives. If there are, the system shows them before continuing.
This is a way to avoid duplicates and encourage participants to support other similar initiatives.

=== Promoter committee

If promoter committee is enabled for this initiative type, this step allows participants to understand what they need to do before being able to send their initiative for publication.

image::spaces/initiatives/initiative_new_step_committee.png[Initiative creation: initiative promoting committee]

See the xref:admin:spaces/initiatives/author_manage/committee.adoc[Promoting committee] article for more information.

=== Finish

The finish step announces the initiative creation to the participant, and shows them different buttons depending if they still need to find promoting committee members.

image::spaces/initiatives/initiative_new_step_finish.png[Initiative creation: initiative finish]

If the initiative type doesn't require multiple committee members, participants can directly send their initiative to technical validation.

NOTE: The initiative won't be publicly visible on the initiatives list until reviewed and published by an administrator.

From this page, participants can:

* Go back to the initiatives list
* Edit their initiative
* Go to their initiatives
* Send their initiate to technical validation
83 changes: 83 additions & 0 deletions docs/en/modules/admin/pages/spaces/initiatives/manage.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
= Manage initiatives

== Understand the basics

When a participant creates an initiative, it doesn't only create a resource like a proposal, it creates a whole space,
allowing administrators to manage in the administration:

* xref:admin:spaces/initiatives/admin_manage/committee.adoc[Committee members]
* xref:admin:spaces/initiatives/admin_manage/components.adoc[Components]
* xref:admin:spaces/initiatives/admin_manage/attachments.adoc[Attachments]
* xref:admin:spaces/initiatives/admin_manage/moderations.adoc[Moderations]
* xref:admin:spaces/initiatives/admin_manage/answer.adoc[Answer an initiative]

NOTE: If you didn't configure it, once an initiative is created, it gets the Meetings and Page component enabled by
default. Ask your instance implementer to modify this parameter if you don't need it, or want other components enabled by default.

image:initiative_admin_show.png[Admin initiative show page]

== Manage initiatives

After the initiative was sent to technical validation by a participant, an administrator can view all the initiatives in the administration panel.

image::spaces/initiatives/initiative_admin_list.png[Admin initiatives list]

You can find all the processes on this list with:

* *ID*: identification number of the initiative.
* *Initiatives*: title of the initiative.
* *Signatures*: sum of online and in-person signatures.
* *Created at*: date of creation of the initiative.
* *Published at*: date of publication of the initiative.

You can filter and sort this list by clicking the "Filter" button and the columns headers.
You can also search for initiatives by their title in the search bar.

image::spaces/initiatives/initiative_list_filters.png[Initiatives list filtered]

== Actions

|===
|Icon |Name |Definition

|image:icons/action_edit.png[Edit icon]
|Edit
|To edit the initiative, its attachments, committee members, components, etc.

|image:icons/action_answer.png[Answer icon]
|Answer
|Allows to xref:admin:spaces/initiatives/admin_manage/answer.adoc[Answer an initiative].

|image:icons/action_preview.png[Preview icon]
|Preview
|To see how the initiative looks in the frontend to participants.

|image:icons/action_permissions.png[Permissions icon]
|Permissions
|To edit permissions on this initiative.

|===

== Edit an initiative

When clicking the "Edit" button or the initiative title on the initiative list in administration, the administrator is
redirected to the initiative edit form, and can see that the secondary navigation bar on the left also allows to manage
the initiative committee members, its components, attachments and reported content.

image::spaces/initiatives/initiative_edit_form_admin.png[Initiative edit form in administration]

On the edition form, the administrator can review and modify the initiative's title, description, scope, area, etc.
They can also send the initiative to technical validation.

== Publish an initiative

Once an initiative is sent to technical validation, the administrator can decide to publish it or discard it.
To publish an initiative in technical validation, go on the initiative edition page and click the "Publish" button.

== Export signatures

After the initiative started to get signatures, administrators can export the signatures in the initiative edit form, in CSV or in .pdf.

image::spaces/initiatives/initiative_actions_export.png[Initiative actions with Export to PDF]

image::spaces/initiatives/initiative_actions_export_pdf.png[Initiative exported PDF]
Loading
Loading