Skip to content

Update reviewed pages structure and fix typos n°2 #210

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

Draft
wants to merge 5 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: 3 additions & 3 deletions docs/en/modules/admin/pages/components/meetings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ image::components/meetings/example01.png[Example meeting detail 01]

== Configuration

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

image::components/meetings/component_meeting.png[Add Meetings component button]

Expand Down Expand Up @@ -90,11 +90,11 @@ Learn more in xref:components/meetings/registrations.adoc[Registrations].

|Enable pads creation
|Optional
|If you want an Etherpad embedded in your meetings. Must have the xref:services:etherpad.adoc[Etherpad] integration configurated.
|If you want an Etherpad embedded in your meetings. Must have the xref:services:etherpad.adoc[Etherpad] integration configured.

|Participants can create meetings
|Optional
|Allows participants to create new meetings. Learn more in xref:_citizens_meetings[Citizens meetings].
|Allows participants to create new meetings. Learn more in xref:components/meetings/meetings.adoc#_participants_meetings[Participants meetings].

|Maps enabled
|Optional
Expand Down
6 changes: 3 additions & 3 deletions docs/en/modules/admin/pages/components/meetings/polls.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

You can add as many questions and answer options as you want.

== Manage
=== Manage

Prior to the meeting, if the administrators already configured the polls questions, participants can see a button "Reply poll"
on the meeting page, warning them that a poll is going to be published on this meeting.
Expand All @@ -56,6 +56,6 @@

image::components/meetings/polls/poll_participant_replies_sent.png[Polls replies view for participant]

== Export
=== Export

Participants answers can be exported through the "Export all" button in CSV, JSON, Excel and PDF.
Participants' answers can be exported through the "Export all" button in CSV, JSON, Excel and PDF.

Check warning on line 61 in docs/en/modules/admin/pages/components/meetings/polls.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('be exported'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('be exported').", "location": {"path": "docs/en/modules/admin/pages/components/meetings/polls.adoc", "range": {"start": {"line": 61, "column": 27}}}, "severity": "INFO"}
20 changes: 11 additions & 9 deletions docs/en/modules/admin/pages/components/meetings/registrations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@

image::components/meetings/registrations/frontend_join_meeting.png[Join a meeting button on meeting page]

Depending in how this feature is configured, then administrators can:
Depending on how this feature is configured, then administrators can:

Check warning on line 15 in docs/en/modules/admin/pages/components/meetings/registrations.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is configured'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is configured').", "location": {"path": "docs/en/modules/admin/pages/components/meetings/registrations.adoc", "range": {"start": {"line": 15, "column": 31}}}, "severity": "INFO"}

. define how many slots are available for controlling the maximum capacity for this meeting
. create a xref:_registration_form[custom registration form] to ask information to participants
. send xref:_invitations[invitations] to other participants or people not registered in the platform
. control attendance to the meeting through xref:_registration_code[registration codes]

== Register to a meeting
== Configuration

=== Register to a meeting

When a participant clicks on the "Register" button, they get asked

Expand All @@ -28,7 +30,7 @@

image::components/meetings/registrations/frontend_confirm.png[Join a meeting confirm modal]

== Manage registrations
=== Manage registrations

Once you chose to deal with registrations "On this platform" when creating a meeting, you can manage registrations by clicking the
image:icons/action_registrations.png[Registrations icon] Registrations icon.
Expand Down Expand Up @@ -71,19 +73,19 @@

|Registration terms
|Required
|What terms of services participants need to accept to register or join the meeting.
|What terms of service participants need to accept to register or join the meeting.

|===

== Registration form
=== Registration form

This feature allows you to define a custom form like the xref:admin:components/surveys.adoc[Surveys] component to ask participants
for registration information.

To create a registration form, check the "Registration form enabled" on the registrations page, and click the "Save" button.
Then, you can click the "Registration form" button in the top right of the page.

== Export all
=== Export all

You can export registrations in multiple formats: CSV, JSON and XLSX (Excel).

Expand All @@ -95,14 +97,14 @@
* user/email: the email of the user
* user/user_group: the group of the user if they have selected that they represent a group when registering

== Invitations
=== Invitations

This feature allows you to invite attendees to a meeting. They can be active participants or non-existing participants
in the platform.

image::components/meetings/registrations/invite_attendee.png[Invite attendee for registration in a meeting]

== Registration code
=== Registration code

This feature allows you to check if an attendee is well registered in the meeting.

Expand All @@ -116,6 +118,6 @@

image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting]

Once the code gets verified, the attendee is considered to having participated in the meeting, and the code is marked as validated.
Once the code has been verified, the attendee is considered to have participated in the meeting and the code is marked as validated.

Check warning on line 121 in docs/en/modules/admin/pages/components/meetings/registrations.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('been verified'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('been verified').", "location": {"path": "docs/en/modules/admin/pages/components/meetings/registrations.adoc", "range": {"start": {"line": 121, "column": 19}}}, "severity": "INFO"}

Check warning on line 121 in docs/en/modules/admin/pages/components/meetings/registrations.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is considered'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is considered').", "location": {"path": "docs/en/modules/admin/pages/components/meetings/registrations.adoc", "range": {"start": {"line": 121, "column": 47}}}, "severity": "INFO"}

Check warning on line 121 in docs/en/modules/admin/pages/components/meetings/registrations.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is marked'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is marked').", "location": {"path": "docs/en/modules/admin/pages/components/meetings/registrations.adoc", "range": {"start": {"line": 121, "column": 110}}}, "severity": "INFO"}

image:components/meetings/registrations/frontend_confirmed_w_code.png[Registration code in a meeting frontend]
8 changes: 6 additions & 2 deletions docs/en/modules/admin/pages/moderations/reported_users.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
= Reported participants

== Understand the basics

There are instances where participants might violate the xref:pages/pages.html#_the_terms_and_conditions_page[Terms and Conditions] of the
platform, so it's useful to have the option for reporting and blocking participants.
You can block participants from the xref:participants/participants.adoc[participants
section in the administration panel] or through the "Reported participants" section.

== Report a participant
== Configuration

=== Report a participant

Any logged in participant can report another participant through the "Report" button in the participant
profile.
Expand All @@ -21,7 +25,7 @@ directly block the user and hide all their contents. They have to provide a just

image:moderations/reported_participant_modal_admin.png[Give reason for reporting a participant modal administrators]

== Manage reported participants
=== Manage reported participants

Reported participants are visible on the "Reported participants" section of the Global moderations panel.

Expand Down
6 changes: 4 additions & 2 deletions docs/en/modules/admin/pages/spaces/initiatives/sign.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

== Understand the basics

Initiatives are meant to be signed, wether with online or in-person signatures. The goal of an initiative author is to promote its initiative
Initiatives are meant to be signed, whether with online or in-person signatures. The goal of an initiative author is to promote its initiative

Check warning on line 5 in docs/en/modules/admin/pages/spaces/initiatives/sign.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('are meant'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('are meant').", "location": {"path": "docs/en/modules/admin/pages/spaces/initiatives/sign.adoc", "range": {"start": {"line": 5, "column": 13}}}, "severity": "INFO"}

Check warning on line 5 in docs/en/modules/admin/pages/spaces/initiatives/sign.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('be signed'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('be signed').", "location": {"path": "docs/en/modules/admin/pages/spaces/initiatives/sign.adoc", "range": {"start": {"line": 5, "column": 26}}}, "severity": "INFO"}
and gather support for it.

== Signature process
== Configuration

=== Signature process

Once the initiative is published by an administrator, it becomes visible in the initiatives listing page.

Expand Down