Skip to content

Commit

Permalink
Update initiative signature article
Browse files Browse the repository at this point in the history
  • Loading branch information
paulinebessoles committed Dec 20, 2024
1 parent ed99bed commit 6531220
Show file tree
Hide file tree
Showing 15 changed files with 172 additions and 105 deletions.
Binary file not shown.
Binary file not shown.
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.
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.
87 changes: 87 additions & 0 deletions docs/en/modules/admin/pages/spaces/initiatives.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,93 @@ In this documentation section, you can find how to configure and manage all of t
** xref:admin:spaces/initiatives/admin_manage/answer.adoc[Answer an initiative]
* xref:admin:spaces/initiatives/sign.adoc[Sign an initiative]

== Initiatives life-cycle

Initiatives pass through different steps, and follow a specific life-cycle:

* *Created*: The author created the initiative, it's only visible by author, promoter committee members and administrators.
* *Technical validation*: The initiative is ready for review by an administrator.
* *Published*: An administrator reviewed the initiative and published it.
* *Expired*: If no administrator published it before a time configured in the initiative initializer.
* *Discarded*: If the initiative didn't pass the review by an administrator.
* *Rejected*: If the initiative didn't receive enough signatures in the signature collection period.
* *Accepted*: If the initiative received enough signatures in the signature collection period.

[plantuml]
....
@startuml
:Created;
:Technical validation;
if (has passed the maximum validation time?) then (yes)
#pink:Expired;
kill;
elseif (validated?) then (no)
#pink:Discarded;
kill;
else (yes)
#palegreen:Published;
if (enough signatures?) then (no)
#pink:Rejected
(not enough signatures);
kill;
else (yes)
#palegreen:Accepted
(enough signatures);
stop;
endif;
endif
@enduml
....

Finally, these are all the relevant settings in every moment in the initiatives life cycle:

[plantuml]
....
@startuml
(*) --> "Create a new initiative"
if "Has only one type?" then
--> [Yes] "Fill initiative form"
else
--> [No] "Select initiative type"
--> "Fill initiative form"
Endif
partition Created {
if "Is the User a UserGroup?" then
--> [Yes] "Send to Technical Validation"
else
--> [No] Collect the minimum number of committee members
--> "Send to Technical Validation"
Endif
}
partition Validating {
if "Has passed the maximum time for validation (60 days by default)?" then
--> [Yes] "Expired"
else
--> [No] if "Is accepted by an administrator?" then
--> [No] "Discarded"
else
--> [Yes] "Publish"
endIf
endIf
}
partition Published {
--> "Signature process"
if "Has passed the configured time window for validation (60 days by default)?"
--> [Yes] "Expired"
else
--> [No] Export PDF to signatures
--> Check signatures with offline signatures for duplicates (if the Initiative has them)
--> if "Has the initiative get the number of signatures required?" then
--> [No] Rejected
else
--> [Yes] Accepted
endIf
endIf
}
--> (*)
@enduml
....

== How to find it?

To access the initiatives panel, go in the administration panel and click the "Initiatives" item in the administration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
image::spaces/initiatives/initiatives_index_front_with_initiatives.png[Initiatives index in front with initiatives]
= Answer an initiative

== 6. Answer an initiative
== Understand the basics

After the initiative has collected all the signatures then it can be answered by an administrator. An initiative answer don't have different types.

Expand Down
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 administrator 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
@@ -1,10 +1,2 @@

include::partial$page_components.adoc[]

=== Components

Once an initiative has been created it gets the Meetings and Page component enabled by
default. The initiative author has no control over these - an admin will need to manage
them. All of the other usual components may be added by an admin too.

image:initiative_admin_show.png[Admin initiative show page]
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ 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.
Expand Down
117 changes: 31 additions & 86 deletions docs/en/modules/admin/pages/spaces/initiatives/manage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,92 +2,21 @@

== Understand the basics

Initiatives pass through different steps, and follow a specific life-cycle:

* *Created*: The author created the initiative, it's only visible by author, promoter committee members and administrators.
* *Technical validation*: The initiative is ready for review by an administrator.
* *Published*: An administrator reviewed the initiative and published it.
* *Expired*: If no administrator published it before a time configured in the initiative initializer.
* *Discarded*: If the initiative didn't pass the review by an administrator.
* *Rejected*: If the initiative didn't receive enough signatures in the signature collection period.
* *Accepted*: If the initiative received enough signatures in the signature collection period.

[plantuml]
....
@startuml
:Created;
:Technical validation;
if (has passed the maximum validation time?) then (yes)
#pink:Expired;
kill;
elseif (validated?) then (no)
#pink:Discarded;
kill;
else (yes)
#palegreen:Published;
if (enough signatures?) then (no)
#pink:Rejected
(not enough signatures);
kill;
else (yes)
#palegreen:Accepted
(enough signatures);
stop;
endif;
endif
@enduml
....

Finally, these are all the relevant settings in every moment in the initiatives life cycle:

[plantuml]
....
@startuml
(*) --> "Create a new initiative"
if "Has only one type?" then
--> [Yes] "Fill initiative form"
else
--> [No] "Select initiative type"
--> "Fill initiative form"
Endif
partition Created {
if "Is the User a UserGroup?" then
--> [Yes] "Send to Technical Validation"
else
--> [No] Collect the minimum number of committee members
--> "Send to Technical Validation"
Endif
}
partition Validating {
if "Has passed the maximum time for validation (60 days by default)?" then
--> [Yes] "Expired"
else
--> [No] if "Is accepted by an administrator?" then
--> [No] "Discarded"
else
--> [Yes] "Publish"
endIf
endIf
}
partition Published {
--> "Signature process"
if "Has passed the configured time window for validation (60 days by default)?"
--> [Yes] "Expired"
else
--> [No] Export PDF to signatures
--> Check signatures with offline signatures for duplicates (if the Initiative has them)
--> if "Has the initiative get the number of signatures required?" then
--> [No] Rejected
else
--> [Yes] Accepted
endIf
endIf
}
--> (*)
@enduml
....

== Initiatives management
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.

Expand Down Expand Up @@ -129,6 +58,22 @@ image::spaces/initiatives/initiative_list_filters.png[Initiatives list filtered]

|===

== 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.
Expand Down
27 changes: 18 additions & 9 deletions docs/en/modules/admin/pages/spaces/initiatives/sign.adoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
== 4. Sign an initiative
= Sign an initiative

This action is done by **a participant**.
== Understand the basics

After the initiative was published, it'll be visible in the initiatives listing page (/initiatives):
Initiatives are meant to be signed, wether with online or in-person signatures. The goal of an initiative author is to promote its initiative
and gather support for it.

image:initiative_list_published.png[Initiative list after it was published]
== Signature process

image:initiative_admin_show_published.png[Admin initiative show after it was published]
image:initiative_show_published.png[Initiative show after it was published]
Once the initiative is published by an administrator, it becomes visible in the initiatives listing page.

And authorized participants can sign it:
image::spaces/initiatives/initiatives_index_front_with_initiatives.png[Initiatives index in front with initiatives]

image:initiative_admin_show_published_detail.png[Admin initiative show after it was published (detail)]
The initiative page displays a "Sign" button and a signature counter, with the signature goal to reach and the current signature number.

image:initiative_show_signed.png[Initiative show after it was signed]
image::spaces/initiatives/initiative_show_published.png[Initiative show after it was published]

Authorized participants only have to click the "Sign" button for their signature to be taken into account.

NOTE: Depending on the authorizations you ask for signing, the process may be different and include additional steps.

Once the participant clicked the button, the signature is incremented in the signature counter.
If it's authorized for this initiative type, participants can also undo their signature by clicking the "Already signed" button.

image::spaces/initiatives/initiative_show_signed.png[Initiative show after it was signed]

0 comments on commit 6531220

Please sign in to comment.