Skip to content
Merged
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: 4 additions & 2 deletions docs/en/modules/admin/pages/components/blog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ image::components/blog/example02.png[Example of a blog post]

== Configuration

=== Create a blog component

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

image::components/blog/component_blog.png[Add Blog component button]
Expand Down Expand Up @@ -85,14 +87,14 @@ image::components/blog/component.png[Add component form]

|===

== Manage posts
=== Manage posts

To start creating and managing posts, click on the component title in the navigation bar or on the component list, or click on the
image:icons/action_edit.png[Manage component icon] icon on the components list.

image:components/blog/manage_posts.png[Manage posts table]

== Create a post
=== Create a post

To create a post, click the "New post" button on the top right of the page.

Expand Down
14 changes: 8 additions & 6 deletions docs/en/modules/admin/pages/components/budgets/projects.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

== Understand the basics

Projects are the entities making part of the budgets.
Projects are parts of budgets.

== Create a project
== Configuration

=== Create a project

To access the creation and management of projects, click the title of the budget or the image:icons/action_list.png[Manage projects icon]
icon on the budgets list.
Expand All @@ -30,15 +32,15 @@ image::components/budgets/new_project.png[New project form]

|Budget amount
|Required
|What's the budget amount for this project. How much money it costs to implement this project?
|Whats the budget amount for this project. How much money does it cost to implement this project?

|Address
|Optional
|The address of the project. It allows to display a pin on a map for participants to locate the project.

|Category
|Optional
|Which Category has the project. Used for filtering in the budgets list.
|What Category is assigned to the project. Used for filtering in the budgets list.

|Proposals
|Optional
Expand All @@ -50,7 +52,7 @@ image::components/budgets/new_project.png[New project form]

|===

== Manage projects
=== Manage projects

image::components/budgets/results_selected.png[Selected projects after voting]

Expand Down Expand Up @@ -113,7 +115,7 @@ For this to work:
. The following settings in the proposals component need to be enabled:
.. Proposal answering enabled
.. Enable costs on proposal answers
. A valuator or administrator need to Answer proposals:
. A valuator or administrator needs to answer proposals:
.. Review the proposals
.. Accept or reject them according to your normative
.. Add costs to the proposals if were accepted
Expand Down
6 changes: 4 additions & 2 deletions docs/en/modules/admin/pages/components/debates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ image::components/debates/example01.png[Debates listing example]

== Configuration

=== Create a debate component

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

image::components/debates/component_debate.png[Add Debate component button]
Expand Down Expand Up @@ -96,7 +98,7 @@ then "component b" is first when ordering.

|===

== Create a debate
=== Create a debate

image::components/debates/new_debate_backend.png[New debate backend form]

Expand Down Expand Up @@ -144,7 +146,7 @@ there isn't any time frame.

|===

== Manage debates
=== Manage debates

To start creating and managing debates, click in the component title in the navigation bar or in the component list, or click in the
image:icons/action_edit.png[Manage component icon] icon on the components list.
Expand Down
4 changes: 3 additions & 1 deletion docs/en/modules/admin/pages/components/meetings/agenda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ of every item and sub-item.

image::components/meetings/agenda/agenda_frontend.png[Agenda in the frontend]

== New agenda form
== Configuration

=== New agenda form

To define an agenda for a meeting, click the image:icons/action_agenda.png[Agenda icon] Agenda icon.

Expand Down
10 changes: 6 additions & 4 deletions docs/en/modules/admin/pages/components/meetings/close.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ and contributions there were, and what proposals were discussed.

image::components/meetings/close/frontend.png[Close report in the frontend]

== Close a meeting
== Configuration

=== Official meetings
=== Close a meeting

==== Official meetings

To close a meeting as an administrator, click the image:icons/action_close.png[Close button] "Close" icon.

Expand Down Expand Up @@ -59,7 +61,7 @@ image::components/meetings/close/form_backend.png[Close meeting form in the back

|===

=== Citizens meetings
==== Participants meetings

Just like participants can create meetings, they can also close a meeting. They have fewer fields to fill than administrators.

Expand Down Expand Up @@ -89,7 +91,7 @@ image::components/meetings/close/form_frontend.png[Close meeting form in the fro

|===

== Related proposals
=== Related proposals

If you link a proposal to a meeting when closing it, the meeting also appears in the proposal page.

Expand Down
4 changes: 3 additions & 1 deletion docs/en/modules/admin/pages/components/pages.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ image::components/page/example01.png[Example of a page component in a participat

== Configuration

=== Create a page component

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

image::components/page/component_page.png[Add Page component button]
Expand Down Expand Up @@ -67,7 +69,7 @@ then "component b" is first when ordering.

|===

== Create a page
=== Create a page

Once you created the Page component, click the Edit icon to write the content to be displayed on the page.

Expand Down
14 changes: 8 additions & 6 deletions docs/en/modules/admin/pages/components/proposals/answers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,29 @@ NOTE: To learn more about valuators, refer to xref:admin:participants/admins.ado

image::components/proposals/answers/proposal_answer_state_accepted.png[Proposal answer state: Accepted]

== Answer a proposal
== Configuration

=== Answer a proposal

For answering a proposal, search for the proposal you want to answer and click in the image:icons/action_answers.png[Answer proposal icon]
Answer icon.

You are then redirected on the answer page, that contains three sections:

=== Metadata
==== Metadata

This section displays the general information about the proposal, like its link, its author, the proposal description,
how many votes, likes, or comments it received, etc.

image::components/proposals/answers/proposal_answer_metadata.png[Proposal answer metadata form]

=== Private notes
==== Private notes

The Private notes section allows administrators or valuators to leave internal notes, not visible by the participants.

image::components/proposals/answers/proposal_answer_notes.png[Proposal answer private notes form]

=== Answer
==== Answer

This section allows administrators or valuators to give an answer and a status to the proposal.

Expand Down Expand Up @@ -75,7 +77,7 @@ A number that indicates the cost of the proposal.

|===

== Statuses
=== Statuses

If the proposals component setting "Publish proposal answers immediately" is checked, then the answer is visible to the public
immediately after you clicked on the "Answer" button.
Expand Down Expand Up @@ -113,7 +115,7 @@ A preview of the answer box and tag is displayed at the bottom of the form.

image::components/proposals/answers/proposal_status_form.png[Proposal new status form]

== Publication
=== Publication

You can control when the answers are published by using the "Publish proposal answers immediately" checkbox in the proposal configuration.
For enabling automatic publication, check this box.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ your component.
Depending on whether you want to gather only participants proposals, or you also want to create official proposals, read the
relevant section.

== Proposals creation
=== Proposals creation

=== Official proposals
==== Official proposals

To start creating official proposals, the first thing to do is to create your first proposal, by clicking the "New proposal" button.

Expand Down Expand Up @@ -65,7 +65,7 @@ the proposal grid list.

|===

=== Participants proposals
==== Participants proposals

Once you enabled participant proposals creation for the active phase, participants can see a "New proposal" button on the proposal
listing page.
Expand Down Expand Up @@ -125,7 +125,7 @@ They can click the "Publish" button to finalize the publication of the proposal.

image::components/proposals/new_proposal_frontend_published.png[Published proposal made by a participant]

== Manage proposals
=== Manage proposals

Once there are multiple proposals in the process, administrators can manage them.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Those specific configurations are more rarely used, and require a good knowledge

== Configuration

All three features can be enable in the Global settings of the proposal component configuration form.
All three features can be enabled in the Global settings of the proposal component configuration form.

image::components/proposals/component_specific_conf.png[Add component form - Specific configurations]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ image::components/proposals/component_specific_conf.png[Add component form - Spe

|===

== Create an amendment
=== Create an amendment

Let's imagine a participant sees another participant's proposal, and wants to enhance it.
When amendments are enabled, they can click the "Amend" button on the proposal page.
Expand All @@ -65,7 +65,7 @@ The participant can then preview their amendment before publishing it.

image::components/proposals/amendments/publish_amendment_draft.png[Publish amendment draft]

== Review an amendment
=== Review an amendment

All the participants can see the amendment drafts made on proposals, on the proposal page.
Amendments also appear as proposals in the proposal list and grid and can be filtered by participants.
Expand All @@ -80,13 +80,13 @@ The author can then accept or reject the amendment. By clicking on the "Accept"

image::components/proposals/amendments/proposal_amendment_review.png[Proposal amendment review]

Once the amendment is approved, the original proposal is updated, and the fact that it was amended appear on the proposal.
Once the amendment is approved, the original proposal is updated, and the fact that it was amended appears on the proposal.

image::components/proposals/amendments/proposal_amended_accepted.png[Proposal amendment accepted]

The versions history for the proposal and its successive amendments is available by clicking the "See other versions" link at the bottom.
The version history for the proposal and its successive amendments is available by clicking the "See other versions" link at the bottom.

== Promote an amendment
=== Promote an amendment

If a proposal is rejected and the "Amendment promotion enabled" is enabled, then the amendment author can promote it to create
a new proposal.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To configure "Collaborative Drafts" in proposals, enable the "Collaborative Draf

image::components/proposals/component_specific_conf.png[Add component form - Specific configurations]

== Create a draft
=== Create a draft

Once collaborative drafts are enabled, participants can see a "Access collaborative drafts" button in the proposals list.

Expand All @@ -37,7 +37,7 @@ reject eventual collaboration requests.

image::components/proposals/collaborative_drafts/collaborative_draft.png[Collaborative draft page]

== Collaborate on a draft
=== Collaborate on a draft

Other participants can then request to join the collaborative draft to make some changes and appear as authors.

Expand All @@ -56,7 +56,7 @@ All authors can edit the collaborative draft by clicking in the "Edit collaborat

The versions history for the draft and its successive changes is available by clicking the "See other versions" link at the bottom.

== Publish a draft
=== Publish a draft

Once the original author is satisfied with the collaborative draft, they can publish it by clicking the "Publish" button.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ easier to see the formatting. link:{attachmentsdir}/participatory_text.md[Downlo

Click the "Upload document" button to see the participatory text preview.

== Preview the document
=== Preview the document

image::components/proposals/participatory_texts/preview_participatory_text.png[Preview participatory text]

Expand Down
6 changes: 3 additions & 3 deletions docs/en/modules/admin/pages/components/sortitions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and uniform distributions.

For example, it can be useful for sorting candidates for a jury, or participatory budgeting proposals.

to conduct a sortition, you need a dice or another random way to generate a number from 1 to 6, as well as witnesses.
To conduct a sortition, you need a dice or another random way to generate a number from 1 to 6, as well as witnesses.

image::components/sortitions/example01.png[Example of a sortition]

Expand Down Expand Up @@ -61,7 +61,7 @@ then "component b" is first when ordering.

|===

== Create a sortition
=== Create a sortition

image::components/sortitions/new_sortition_backend.png[New sortition backend form]

Expand Down Expand Up @@ -101,7 +101,7 @@ number in front of some witnesses. This contributes to the quality and guarantee

|===

== Manage sortitions
=== Manage sortitions

To start creating and managing sortitions, click in the component title in the navigation bar or in the component list, or click in the
image:icons/action_edit.png[Manage component icon] Manage icon on the components list.
Expand Down
7 changes: 4 additions & 3 deletions docs/en/modules/admin/pages/components/surveys.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ image::components/surveys/example01.png[Example of a survey]

== Configuration

=== Create a survey component

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

image::components/surveys/component_survey.png[Add Survey component button]
Expand Down Expand Up @@ -97,7 +99,7 @@ but participants can use the Private navigation option and make multiple answers

|===

== Create a survey
=== Create a survey

NOTE: Do you have repetitive surveys? For instance the same feedback form for every process? You can have a survey that
gets copied and is used as a blueprint so you don't have to manually configure the same survey each time. Learn more
Expand Down Expand Up @@ -279,7 +281,7 @@ They can also be used alone, in a one page survey.

image::components/surveys/title_description_backend.png[Title and description in back end]

== Export answers
=== Export answers

It's possible to export the survey participant answers to different formats: CSV, JSON, XLSX (Excel) or PDF.

Expand All @@ -291,4 +293,3 @@ done externally.
Some examples of where this component is used:

* https://consultation.quebec.ca/processes/donneesquebec/f/82/[Data Quebec: participate in its improvement in Québec consultations]
* https://meta.decidim.org/conferences/decidimfest2020/f/1403/?locale=en[DecidimFest2020 Assessment Survey]
Loading
Loading