Skip to content

Commit

Permalink
Fix vale linter
Browse files Browse the repository at this point in the history
  • Loading branch information
paulinebessoles committed Nov 7, 2024
1 parent 5c07e82 commit 5395b5c
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 16 deletions.
3 changes: 2 additions & 1 deletion .github/styles/config/vocabularies/Decidim/accept.txt
View file
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Decidim
Decidim
faq
16 changes: 8 additions & 8 deletions docs/en/modules/admin/pages/pages.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
= Pages and Topics
= Pages and topics

== What is it?
== Understand the basics

The pages tab allow you to publish static pages including, for example, your platform's Terms and Conditions, accessibility statements, FAQs, etc.
Those pages can be organized into different topics, acting as kind of folders.
You can organize these pages in different topics, acting as kind of folders.

These pages will be available to all the participants through the **Help** section in the navbar and in the footer.
These pages are available to all the participants through the **Help** section in the header and in the footer.

== How to configure it?
== Configuration

To access the Pages configuration panel, go in the administration panel and click on the "Pages" item in the admin navigation bar.
To access the Pages configuration panel, go in the administration panel and click the "Pages" item in the administration navigation bar.

image::pages/pages_menu.png[Pages: Access pages panel]

There, you will be able to create, update or delete xref:admin:pages/pages.adoc[Pages] and xref:admin:pages/topics.adoc[Topics].
You can start by creating only pages if you want, as you will be able to create topics and reorganize pages inside them at any moment.
There, you are able to create, update, or delete xref:admin:pages/pages.adoc[Pages] and xref:admin:pages/topics.adoc[Topics].
You can start by creating only pages if you want, as you are able to create topics and reorganize pages inside them at any moment.

== Examples

Expand Down
6 changes: 3 additions & 3 deletions docs/en/modules/admin/pages/pages/pages.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This is where you need to put your legal terms, for instance who owns the data c

== Create a new page

To create a new page, you need to click in "Create page".
To create a new page, you need to click on the "Create page" button.

image::pages/pages_backend_form.png[Backend: new page form]

Expand All @@ -36,7 +36,7 @@ image::pages/pages_backend_form.png[Backend: new page form]

|URL Slug
|Required
|String that will be used in the URL. Use partial paths, not full URLs here. Accepts letters, numbers, dashes and slashes, and must start with a letter. For instance if the slug is "faq" and your domain is "https://example.org", your page will be at "https://example.org/pages/faq"
|String that will be used in the URL. Use partial paths, not full URLs here. Accepts letters, numbers, dashes and slashes, and must start with a letter. For instance if the slug is "faq" and your domain is "https://example.org" your page will be at "https://example.org/pages/faq"

|Content
|Required
Expand All @@ -48,7 +48,7 @@ image::pages/pages_backend_form.png[Backend: new page form]

|Order position
|Optional
|Which order will it have in relation with the other pages. Having a lower number means a higher priority. For instance, if you have two pages, "Page a" with weight "10" and "Page b" with weight "0", then "Page b" will be first when ordering.
|Which order will it have in relation with the other pages. Having a lower number means a higher priority. For instance, if you have two pages, "Page a" with weight "10" and "Page b" with weight "0" then "Page b" will be first when ordering.

|===

Expand Down
8 changes: 4 additions & 4 deletions docs/en/modules/admin/pages/pages/topics.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ In this section, you can configure Topics, to organize your static pages and pro

== Manage the topics

To access the topics list, click on the Topics tab at the top of the panel.
Here, you will be able to edit, delete and create topics for your static pages.
To access the topics list, click the Topics tab at the top of the panel.
Here, you are able to edit, delete and create topics for your static pages.

Check warning on line 8 in docs/en/modules/admin/pages/pages/topics.adoc

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.OxfordComma] Use the Oxford comma in 'Here, you are able to edit, delete and'.

Raw Output:
{"message": "[Google.OxfordComma] Use the Oxford comma in 'Here, you are able to edit, delete and'.", "location": {"path": "docs/en/modules/admin/pages/pages/topics.adoc", "range": {"start": {"line": 8, "column": 1}}}, "severity": "WARNING"}

image::pages/pages_backend_list_topics.png[Backend: list topics of pages]

== Create a new topic

To create a new topic, click on "Create topic".
To create a new topic, click on the "Create topic" button.

Check warning on line 14 in docs/en/modules/admin/pages/pages/topics.adoc

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'click' or 'click in' instead of 'click on'.

Raw Output:
{"message": "[Google.WordList] Use 'click' or 'click in' instead of 'click on'.", "location": {"path": "docs/en/modules/admin/pages/pages/topics.adoc", "range": {"start": {"line": 14, "column": 24}}}, "severity": "WARNING"}

image::pages/pages_backend_topic_form.png[Backend: new topic form]

Expand All @@ -30,7 +30,7 @@ image::pages/pages_backend_topic_form.png[Backend: new topic form]

|Order position
|Optional
|Which order will it have in relation with the other topics. Having a lower number means a higher priority. For instance, if you have two topics, "Topic a" with weight "10" and "Topic b" with weight "0", then "Topic b" will be first when ordering.
|The order of the topic in relation with the other topics. Having a lower number means a higher priority. For instance, if you have two topics, "Topic a" with weight "10" and "Topic b" with weight "0" then "Topic b" will be first when ordering.

Check warning on line 33 in docs/en/modules/admin/pages/pages/topics.adoc

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/en/modules/admin/pages/pages/topics.adoc", "range": {"start": {"line": 33, "column": 217}}}, "severity": "WARNING"}

|Show in the footer
|Optional
Expand Down

0 comments on commit 5395b5c

Please sign in to comment.