Skip to content

Commit 84aecd4

Browse files
author
paulinebessoles
committed
Update reviewed pages structure and fix typos
1 parent 1d1bde4 commit 84aecd4

25 files changed

Lines changed: 133 additions & 94 deletions

docs/en/modules/admin/pages/components/blog.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ image::components/blog/example02.png[Example of a blog post]
1212

1313
== Configuration
1414

15+
=== Create a blog component
16+
1517
To create a Blog component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it.
1618

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

8688
|===
8789

88-
== Manage posts
90+
=== Manage posts
8991

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

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

95-
== Create a post
97+
=== Create a post
9698

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

docs/en/modules/admin/pages/components/budgets/projects.adoc

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
== Understand the basics
44

5-
Projects are the entities making part of the budgets.
5+
Projects are parts of budgets.
66

7-
== Create a project
7+
== Configuration
8+
9+
=== Create a project
810

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

3133
|Budget amount
3234
|Required
33-
|What's the budget amount for this project. How much money it costs to implement this project?
35+
|Whats the budget amount for this project. How much money does it cost to implement this project?
3436

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

3941
|Category
4042
|Optional
41-
|Which Category has the project. Used for filtering in the budgets list.
43+
|What Category is assigned to the project. Used for filtering in the budgets list.
4244

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

5153
|===
5254

53-
== Manage projects
55+
=== Manage projects
5456

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

@@ -113,7 +115,7 @@ For this to work:
113115
. The following settings in the proposals component need to be enabled:
114116
.. Proposal answering enabled
115117
.. Enable costs on proposal answers
116-
. A valuator or administrator need to Answer proposals:
118+
. A valuator or administrator needs to answer proposals:
117119
.. Review the proposals
118120
.. Accept or reject them according to your normative
119121
.. Add costs to the proposals if were accepted

docs/en/modules/admin/pages/components/debates.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ image::components/debates/example01.png[Debates listing example]
99

1010
== Configuration
1111

12+
=== Create a debate component
13+
1214
To create a Debate component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it.
1315

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

9799
|===
98100

99-
== Create a debate
101+
=== Create a debate
100102

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

@@ -144,7 +146,7 @@ there isn't any time frame.
144146

145147
|===
146148

147-
== Manage debates
149+
=== Manage debates
148150

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

docs/en/modules/admin/pages/components/meetings/agenda.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ of every item and sub-item.
88

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

11-
== New agenda form
11+
== Configuration
12+
13+
=== New agenda form
1214

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

docs/en/modules/admin/pages/components/meetings/close.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ and contributions there were, and what proposals were discussed.
1212

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

15-
== Close a meeting
15+
== Configuration
1616

17-
=== Official meetings
17+
=== Close a meeting
18+
19+
==== Official meetings
1820

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

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

6062
|===
6163

62-
=== Citizens meetings
64+
==== Citizens meetings
6365

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

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

9092
|===
9193

92-
== Related proposals
94+
=== Related proposals
9395

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

docs/en/modules/admin/pages/components/pages.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ image::components/page/example01.png[Example of a page component in a participat
1212

1313
== Configuration
1414

15+
=== Create a page component
16+
1517
To create a Page component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it.
1618

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

6870
|===
6971

70-
== Create a page
72+
=== Create a page
7173

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

docs/en/modules/admin/pages/components/proposals/answers.adoc

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,29 @@ NOTE: To learn more about valuators, refer to xref:admin:participants/admins.ado
1010

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

13-
== Answer a proposal
13+
== Configuration
14+
15+
=== Answer a proposal
1416

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

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

20-
=== Metadata
22+
==== Metadata
2123

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

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

27-
=== Private notes
29+
==== Private notes
2830

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

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

33-
=== Answer
35+
==== Answer
3436

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

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

7678
|===
7779

78-
== Statuses
80+
=== Statuses
7981

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

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

116-
== Publication
118+
=== Publication
117119

118120
You can control when the answers are published by using the "Publish proposal answers immediately" checkbox in the proposal configuration.
119121
For enabling automatic publication, check this box.

docs/en/modules/admin/pages/components/proposals/proposals.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ your component.
1414
Depending on whether you want to gather only participants proposals, or you also want to create official proposals, read the
1515
relevant section.
1616

17-
== Proposals creation
17+
=== Proposals creation
1818

19-
=== Official proposals
19+
==== Official proposals
2020

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

@@ -65,7 +65,7 @@ the proposal grid list.
6565

6666
|===
6767

68-
=== Participants proposals
68+
==== Participants proposals
6969

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

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

128-
== Manage proposals
128+
=== Manage proposals
129129

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

docs/en/modules/admin/pages/components/proposals/special_configurations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Those specific configurations are more rarely used, and require a good knowledge
77

88
== Configuration
99

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

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

docs/en/modules/admin/pages/components/proposals/special_configurations/amendments.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ image::components/proposals/component_specific_conf.png[Add component form - Spe
5050

5151
|===
5252

53-
== Create an amendment
53+
=== Create an amendment
5454

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

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

68-
== Review an amendment
68+
=== Review an amendment
6969

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

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

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

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

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

89-
== Promote an amendment
89+
=== Promote an amendment
9090

9191
If a proposal is rejected and the "Amendment promotion enabled" is enabled, then the amendment author can promote it to create
9292
a new proposal.

0 commit comments

Comments
 (0)