Skip to content

Commit

Permalink
Fix some errors from Antora 3.0 update (decidim#96)
Browse files Browse the repository at this point in the history
* Add missing image in page_admins.adoc

* Remove unused images

* Fix 'level 0 sections can only be used when doctype is book'

* Remove incorrect note in homepage.adoc

* Add missing image in governance.adoc

* Add homepage content blocks missing images

* Add placeholder images for component skeleton page

* Fix names and xrefs on navigation

* Remove index pages from some sections

* Remove legacy page: 'How to access the administrator menu'

* Fix 'target of include not found' errors

* Fix 'target of xref not found' errors

* Don't comment asciidoctor extensions in antora configuration

* Add missing image in decidim-a-brief-overview.adoc

* Remove empty lines

* Remove duplicated heading
  • Loading branch information
andreslucena authored May 23, 2022
1 parent 08867b4 commit b3d8fe8
Show file tree
Hide file tree
Showing 37 changed files with 1,705 additions and 113 deletions.
18 changes: 8 additions & 10 deletions en/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
*** xref:services:smtp.adoc[SMTP]
*** xref:services:social_providers.adoc[Social Providers]
* xref:admin:index.adoc[Admin]
* Admin
** xref:admin:index.adoc[Introduction]
*** xref:admin:system.adoc[System panel]
*** xref:admin:dashboard.adoc[Dashboard]
Expand Down Expand Up @@ -104,7 +104,7 @@
**** xref:admin:components/proposals/participatory_texts.adoc[Participatory texts]
*** xref:admin:components/sortitions.adoc[Sortitions]
*** xref:admin:components/surveys.adoc[Surveys]
** xref:admin:features.adoc[Features]
** Features
*** xref:admin:features/badges.adoc[Badges]
*** xref:admin:features/comments.adoc[Comments]
*** xref:admin:features/conversations.adoc[Conversations]
Expand Down Expand Up @@ -136,32 +136,31 @@
** xref:admin:newsletters.adoc[Newsletters]
** xref:admin:global_moderations.adoc[Global moderations]
** Deprecated
*** xref:admin:how-to-access-administrator-menu.adoc[How to access the administrator menu]
*** xref:admin:information-pages.adoc[Information pages]
* xref:contribute:index.adoc[Contribute]
** xref:contribute:governance.adoc[Governance]
** xref:contribute:translations.adoc[Translations]
** xref:contribute:documentation.adoc[Documentation]
* xref:develop:index.adoc[Develop]
* Develop
** xref:develop:guide.adoc[Guide]
*** xref:develop:guide_example_apps.adoc[1. Example Applications]
*** xref:develop:guide_development_app.adoc[2. Development App]
*** xref:develop:guide_commands.adoc[3. Commands]
*** xref:develop:guide_conventions.adoc[4. Conventions]
*** xref:develop:guide_architecture.adoc[5. Architecture]
** xref:develop:security.adoc[Security]
** xref:develop:index.adoc[Advanced]
** Advanced
*** Concerns
**** xref:develop:authorable.adoc[Authorable]
**** xref:develop:embeddable.adoc[Embeddable]
**** xref:develop:endorsable.adoc[Endorsable]
**** xref:develop:followable.adoc[Followable]
**** xref:develop:reportable.adoc[Reportable]
**** xref:develop:traceable.adoc[Traceable]
**** xref:develop:translatable_resource.adoc[TranslatableResource aka Machine Translations]
**** xref:develop:shareable_tokens.adoc[Shareable with Tokens]
**** xref:develop:machine_translations.adoc[TranslatableResource aka Machine Translations]
**** xref:develop:share_tokens.adoc[Shareable with Tokens]
*** xref:develop:api.adoc[API]
*** xref:develop:components.adoc[Components]
*** xref:develop:content_processors.adoc[Content Processors]
Expand All @@ -170,7 +169,6 @@
*** xref:develop:docker.adoc[Docker]
*** xref:develop:fixing_locales.adoc[Fixing locales]
*** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow]
*** xref:develop:machine_translations.adoc[Machine translations]
*** xref:develop:maps.adoc[Maps]
*** xref:develop:managing_translations_i18n.adoc[i18n]
*** xref:develop:metrics.adoc[Metrics]
Expand Down Expand Up @@ -206,14 +204,14 @@
** xref:understand:social-contract.adoc[Social Contract]
*** xref:understand:social-contract-ca.adoc[Català]
*** xref:understand:social-contract-es.adoc[Castellano]
** xref:publications:index.adoc[Publications]
** Publications
*** xref:publications:catalan.adoc[Catalan]
*** xref:publications:english.adoc[English]
*** xref:publications:french.adoc[French]
*** xref:publications:german.adoc[German]
*** xref:publications:italian.adoc[Italian]
*** xref:publications:spanish.adoc[Spanish]
** xref:whitepaper:index.adoc[Whitepaper]
** Whitepaper
*** xref:whitepaper:decidim-a-brief-overview.adoc[Decidim: a brief overview]
* xref:releases:index.adoc[Release Notes]
Expand Down
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.
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion en/modules/admin/pages/components/budgets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -352,5 +352,5 @@ image:components/budgets/results_select_project.png[Select a project for impleme
image:components/budgets/results_selected.png[Selected projects after voting]
image:components/budgets/results_selected_frontend.png[Selected projects after voting in the frontend]

We strongly recommend that after you have selected projects then you enable the xref:admin:component_accountability.adoc[Accountability]
We strongly recommend that after you have selected projects then you enable the xref:components/accountability.adoc[Accountability]
component so participants can see the grade of impementation.
2 changes: 1 addition & 1 deletion en/modules/admin/pages/components/elections.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
= Elections

include::partial$development.adoc[]
include::admin:partial$development.adoc[]
2 changes: 1 addition & 1 deletion en/modules/admin/pages/components/meetings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we

Meetings can be created by participants if the setting is "Participants can create meetings" is checked.

If a participant belongs to a xref:admin:groups.adoc[user group], then she'll be able to create meetings as that group also.
If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create meetings as that group also.

image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)]
image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form (frontend)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ image:components/meetings/registrations/backend.png[Registrations settings in a

== Registration form

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

== Export all
Expand Down
2 changes: 1 addition & 1 deletion en/modules/admin/pages/components/proposals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ image:components/proposals/new_proposal_frontend.png[New proposal form]

Proposals can be created by participants if the setting is "Proposal creation enabled" is checked for the active phase.

If a participant belongs to a xref:admin:groups.adoc[user group], then she'll be able to create proposals as that group also.
If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create proposals as that group also.

This form depends a lot in which settings you've enabled in this component. It can be really short (with only a Title and
Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, Image and Attachment).
Expand Down
4 changes: 2 additions & 2 deletions en/modules/admin/pages/components/skeleton.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ certain actions in the skeletons:

== Manage skeletons

image:components/skeletons/manage_skeletons.png[Manage skeletons table]
image:components/skeleton/manage_skeletons.png[Manage skeletons table]

=== Export all

Expand All @@ -121,7 +121,7 @@ Allows exporting the skeletons in different formats.

=== New skeleton form

image:components/skeletons/new_skeleton.png[New skeleton form]
image:components/skeleton/new_skeleton.png[New skeleton form]

.New skeleton form
|===
Expand Down
8 changes: 7 additions & 1 deletion en/modules/admin/pages/dashboard.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
= Dashboard

After you've logged in as user Administrator, you'll see the Dashboard, were you'll have a summary of the last activity of the platform.
For your first time accessing to a Decidim plaform as Admin, you'll receive an invitation email so you can finish setting up your account with your nickname, name and password.

Once you've finished and you're logged-in, you'll be able to access the Admin panel, starting with the Dashboard page. For this you'll need to click on your username, and click on "Admin dashboard".

image::admin_dashboard_menu.png[Decidim Admin Dashboard in user menu]

Here, you'll have a summary of the last activity of the platform.

image::admin_dashboard.png[Decidim Admin Dashboard]

Expand Down
2 changes: 1 addition & 1 deletion en/modules/admin/pages/features/fingerprint.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Fingerprint

Although the platform should show the xref:admin:features/versions.doc[Versions] for almost all of the contents, it'd be
Although the platform should show the xref:admin:features/versions.adoc[Versions] for almost all of the contents, it'd be
still possible to manipulate the content by directly editing the database.

As mitigation for this risk, the platform shows a fingerprint for some important fields, for instance, a proposal body and title.
Expand Down
8 changes: 3 additions & 5 deletions en/modules/admin/pages/homepage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ These are the different content blocks enabled with the official Decidim modules

=== Hero image

NOTE: These area legacy settings that will be removed in the next version. https://github.com/decidim/decidim/pull/6284[See PR]. In this next version you're going to be able to change the button and path for this button from this same content block.

image::homepage_hero_image_back.png[Hero image in Homepage backend content block]

image::homepage_hero_image_front.png[Hero image in Homepage frontend content block]
Expand All @@ -58,9 +56,9 @@ image::homepage_footer_sub_hero_banner.png[Hero image in Homepage content block]

image::homepage_how_to_participate.png[How to participate in Homepage content block]

=== Upcoming events
=== Upcoming meetings

image::homepage_upcoming_events.png[Upcoming events in Homepage content block]
image::homepage_upcoming_meetings.png[Upcoming meetings in Homepage content block]

=== Last activity

Expand Down Expand Up @@ -100,4 +98,4 @@ image::homepage_organization_statistics.png[Organizations statistics in Homepage

=== Organization metrics

image::homepage_organization_metrics.png[Organzation metrics in Homepage content block]
image::homepage_organization_metrics.png[Organzation metrics in Homepage content block]
56 changes: 0 additions & 56 deletions en/modules/admin/pages/how-to-access-administrator-menu.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ image:authorizations_id_document_configuration.png[ID document authorization con

NOTE: As you can see, this authorization is based in the original implementers reality, in this case in the Spanish identities document types.
For instance, we're giving as options for document types "DNI, NIE or Passport" or we're asking for "Document number (with letter)"
You can change this by xref:customize:code.adoc[code customizing or overriding] these things. We also accept xref:ROOT:governance.adoc[Pull Request contributions]
You can change this by xref:customize:code.adoc[code customizing or overriding] these things. We also accept xref:contribute:governance.adoc[Pull Request contributions]
so it's possible to configure this.

.ID Documents authorization configuration
Expand Down
2 changes: 1 addition & 1 deletion en/modules/admin/pages/spaces/processes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ instance multiple squares in a City or multiple documents using the same partici

|Private space
|Optional
|Check if this process should only be accessible by xref:admin:process_private_participants.adoc[Private Participants]
|Check if this process should only be accessible by xref:admin:spaces/processes/private_participants.adoc[Private Participants]

|Promoted
|Optional
Expand Down
2 changes: 1 addition & 1 deletion en/modules/admin/pages/spaces/votings.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
= Votings

include::partial$development.adoc[]
include::admin:partial$development.adoc[]
2 changes: 1 addition & 1 deletion en/modules/admin/partials/page_categories.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ image:spaces/categories_form.png[Select a category when creating a proposal]

NOTE: Once a category is in use it cannot be removed, as there are resources that are using it.

Decidim has other ways to classify resources, for instance xref:admin:scopes.adoc[Scopes] and xref:admin:hashtags.adoc[Hashtags].
Decidim has other ways to classify resources, for instance xref:admin:scopes.adoc[Scopes] and xref:admin:features/hashtags.adoc[Hashtags].
The main difference is that Categories can be defined in a given space, Scopes are global for all the platform, and Hashtags
are defined by the participants.

Expand Down
23 changes: 9 additions & 14 deletions en/modules/features/pages/components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

*Proposals* are Decidim's most important component. They can be defined as the minimum decision unit.


Proposals can be made by any of the following *types of creators*:

* by the *official organisation* managing the platform
Expand Down Expand Up @@ -36,7 +35,7 @@ Other features associated with proposals include:

== Endorsements

include::partial$development.adoc[]
include::admin:partial$development.adoc[]

Participants can endorse proposals. Such endorsements can be interpreted as votes, signatures or any other format that demonstrates a positive agreement in accordance with the political will itself.
Participants can issue a single endorsement for each proposal they wish. The number of endorsements can be limited for each participant.
Expand Down Expand Up @@ -84,7 +83,6 @@ The *newsletter* component makes possible to send emails to everyone registered

Participants will automatically and directly be able to *unsubscribe* through the email itself by clicking on a link in it and it will also be possible to *track the number of visits* generated by the newsletter.


== Meetings

The *meeting* component offers organizations and participants the opportunity to:
Expand Down Expand Up @@ -118,27 +116,26 @@ Some of the meeting component’s advanced features include:

*The search engine* allows participants to perform searches across all of the platform’s indexable content, both generally and specifically, by searching within a specific participatory process or inside its components (proposals, results, etc.), through advanced searches.


= Secondary components
== Secondary components

There are other components that only exist on top of basic components are. These components are:

== Comments
=== Comments

The *comments* component enables participants to take part on a deliberative process on an issue or proposal.
Participants can respond to them, endorse them and receive notifications about responses.
Comments can be *ranked* in chronological order or by number of votes in favour.

== Participatory texts
=== Participatory texts

Participatory texts are defined as an ordered collection of proposals that make up a document with complete text. Participation in the text stems from interaction with the proposals that form it. This component basically allows three operations:

* *Breaking down a text document into ordered proposals* from a document in ODT, XDOC, MarkDown and HTML formats. If the text is structured in sections and subsections, ordered proposals will be created from the lower level subsection; if the text is not structured, a proposal will be created for each paragraph of text. The interface allows proposals to be re-edited, merged, separated, given titles, etc.
* *Composition of proposals in a unified text*: based on a series of proposals, these may be ordered and generate a unified and downloadable text.
* *Viewing and interacting* with documents composed of proposals: A collection of proposals will be shown as a unified text and may be amended or comments can be added in the margin.

== Accountability
=== Accountability

The *accountability* component works like a project management system built into the platform. . It offers the possibility of:

* subdividing results into projects or sub-projects
Expand All @@ -147,7 +144,7 @@ The *accountability* component works like a project management system built into

Results, projects and statuses can be updated through a CVS, or manually by the administration interface.

== Conferences
=== Conferences

The *conference* component allows an organization to join up a series predefined meetings (chats, workshops etc.) related to a participatory space.

Expand All @@ -162,9 +159,8 @@ Configuration settings include:
* Automatic links to digital-media websites covering the event.
* The ability to following events through *social networks* (e.g. by incorporating a Twitter feed).

== Participatory Spaces and Components


= Participatory Spaces and Components
*Participatory Spaces* and *Components* can be combined in different ways.
For example, the various phases of a Participatory Budgeting Process (Participatory Space) can combine *Components* like this:

Expand All @@ -177,8 +173,7 @@ For example, the various phases of a Participatory Budgeting Process (Participat
7. An assessment *Survey* can be launched afterwards for those who could not attend the *Meeting*.
8. Finally, the *Accountability* component may be activated to monitor the degree of execution of the selected projects, and people can comment on it.


= Displaying components: Cards
== Displaying components: Cards

Component items have their individual page but are also displayed as *cards* throughout the platform.

Expand Down
Loading

0 comments on commit b3d8fe8

Please sign in to comment.