Skip to content

Commit

Permalink
Update component partials
Browse files Browse the repository at this point in the history
  • Loading branch information
paulinebessoles committed Dec 6, 2024
1 parent d59a362 commit f9a3e90
Show file tree
Hide file tree
Showing 13 changed files with 57 additions and 35 deletions.
3 changes: 2 additions & 1 deletion .github/styles/config/vocabularies/Decidim/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ CSV
[Oo]fficializing
[Oo]fficialize
[Rr]eoffficialize
[Uu]nreport
[Uu]nhide
[Uu]npublish
[Uu]nreport
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.
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.
Binary file not shown.
20 changes: 9 additions & 11 deletions docs/en/modules/admin/partials/components_list.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@

The platform currently have the following official components:

* xref:admin:components/accountability.adoc[*Accountability*]: allows to keep track of the results execution of a space.
It allows administrators to also relate them to the proposals and meetings that originated them.
* xref:admin:components/blog.adoc[*Blog*]: allows administrators to publish posts with news regarding a space.
* xref:admin:components/budgets.adoc[*Budgets*]: allows participants to vote in projects with amounts predefined. Used for
participatory budgeting processes. Allows to define different kind of rules, for instance a minimum percentage of the total budget or a minimum amount of projects.
* xref:admin:components/debates.adoc[*Debates*]: allows participants to have debates. Debates can be time limited or not.
* xref:admin:components/meetings.adoc[*Meetings*]: gatherings in person or online through videoconferences platforms.
* xref:admin:components/accountability.adoc[*Accountability*]: allows to keep track of ongoing projects.
* xref:admin:components/blog.adoc[*Blog*]: allows administrators to publish blog posts and news.
* xref:admin:components/budgets.adoc[*Budgets*]: allows participants to vote for projects with amounts predefined, for
participatory budgeting for example.
* xref:admin:components/debates.adoc[*Debates*]: allows participants to have debates.
* xref:admin:components/meetings.adoc[*Meetings*]: in person or online gatherings, agenda, minutes, etc.
* xref:admin:components/pages.adoc[*Page*]: static pages with multi-language support.
* xref:admin:components/proposals.adoc[*Proposals*]: contributions posted by participants which can be given support.
* xref:admin:components/sortitions.adoc[*Sortitions*]: this allows different kind of proposals to be selected randomly.
For instance the proposals could be candidates who form part of a group (such as a committee).
* xref:admin:components/proposals.adoc[*Proposals*]: contributions posted by participants.
* xref:admin:components/sortitions.adoc[*Sortitions*]: allows to randomly selected proposals.
* xref:admin:components/surveys.adoc[*Survey*]: for conducting surveys with different kinds of questions.
In the cases where your needs are not covered by one of the above components, you can create your own component through a xref:develop:modules.adoc[Module].
In the cases where your needs are not covered by one of those components, you can create your own component through a xref:develop:modules.adoc[Module].
65 changes: 42 additions & 23 deletions docs/en/modules/admin/partials/page_components.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
= Components

== Understand the basics

include::partial$components_list.adoc[]

To configure components, click on *Components* from the space submenu. A list will appear showing the components
that have already been configured for the space.
== How to find it?

To configure components, click the *Components* item in any participatory space.

image::spaces/components/components.png[Components of space]

There, you are able to manage the already added components, configure them, add new ones, etc.

== Manage components

You can find all the components on the list in the administration panel, with:

* *Component name*: title of the component, given when creating or editing it.
* *Component type*: type of the component.
* *Component scope*: in a same space, components can have different scopes.

image::spaces/components.png[Components of space]
== Create a component

To configure a new component, click on *Add component* from the upper right part of the screen and select the type of
component you wish to configure from the drop-down menu.
To configure a new component, click the *Add component* from the upper right part of the screen and select the type of
component you want.

image::spaces/components_new_dropdown.png[Add a component in a space]

Expand All @@ -17,36 +32,40 @@ image::spaces/components_new_dropdown.png[Add a component in a space]
|===
|Icon |Name |Definition

|image:action_manage.png[Manage icon]
|image:icons/action_edit.png[Manage icon]
|Manage
|To manage all the resources inside of a component. For instance, all the Proposals of a Proposal component, the Meetings
in a Meeting component, etc.

|image:action_publish.png[Publish icon]
|image:icons/action_share.png[Share icon]
|Share
|To share privately before publishing this component. Useful for getting reviews from other people of your organization.

|image:icons/action_configure.png[Configure icon]
|Configure
|To configure a component with specific rules, for instance, in the case of Meetings:
are comments enabled, participants can create meetings or not, etc.

|image:icons/action_publish.png[Publish icon]
|Publish
|To publish a component. This means that the component will be visible to the public.
|To publish a component. This means that the component is then visible to the public.

|image:action_unpublish.png[Unpublish icon]
|image:icons/action_unpublish.png[Unpublish icon]
|Unpublish
|To unpublish a component. This means that the component will be invisible to the public.
|To unpublish a component. This means that the component is then invisible to the public.

|image:action_configure.png[Configure icon]
|Configure
|To configure a component with the specific rules. Depends in the component type. For instance, in the case of Meetings:
are comments enabled, participants can create meetings, etc.
|image:icons/action_preview.png[Preview icon]
|Preview
|To preview the space before it's published.

|image:action_permissions.png[Permissions icon]
|image:icons/action_permissions.png[Permissions icon]
|Permissions
|To configure which xref:customize:authorizations.adoc[Authorization] will be necessary to make certain actions in
this component. For instance, in the case of Proposals, which Verification will be necessary to create a new proposal or
|To configure which xref:customize:authorizations.adoc[Authorization] is necessary to make certain actions in
this component. For instance, in the case of Proposals, which Verification is needed to create a new proposal or
to give supports.

|image:action_share.png[Share icon]
|Share
|To share privately before publishing this component. Useful for reviewing with other people inside of your organization.

|image:action_delete.png[Delete icon]
|image:icons/action_delete.png[Delete icon]
|Delete
|To delete this component. If there are contents most of the components will not let you delete them so it doesn't break
|To delete this component. If there are content inside, most of the components don't let you delete them so it doesn't break
relations with other resources. In those cases it's recommended to just unpublish the component.
|===
4 changes: 4 additions & 0 deletions docs/en/modules/admin/partials/page_landing_page.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,14 @@ image::spaces/landing_page/images.png[Landing page content Related images conten
=== Upcoming meetings

The upcoming meetings allows administrator to display the upcoming xref:admin:spaces/components/meetings.adoc[Meetings] on the landing page with a map when they have a location.
You can configure the component to take the meetings from by clicking the Edit button of the content block.

image::spaces/landing_page/meetings.png[Landing page content meetings content block]

=== Posts

The posts content block allows administrator to display the last posts published on the space, with their images if they were added as attachments to the posts.
You can configure the component to take the posts from by clicking the Edit button of the content block.

image::spaces/landing_page/posts.png[Landing page content posts content block]

Expand All @@ -145,6 +147,8 @@ image::spaces/landing_page/proposals_admin.png[Landing page proposals content bl

image::spaces/landing_page/results.png[Landing page results content block]

You can configure the display order and the Accountability to take the results from component by clicking the Edit button of the content block.

=== HTML

The HTML block content block allows to add an editable HTML block on the landing page, and therefore to create a personalized section.

0 comments on commit f9a3e90

Please sign in to comment.