Add page for taxonomies #253
Conversation
📝 WalkthroughWalkthroughThree documentation files were updated to introduce Taxonomies feature documentation. Changes include adding a new navigation entry in the ROOT navigation file, updating the Settings navigation with Taxonomies, and creating a comprehensive new documentation page explaining Taxonomies concept, configuration steps, and usage guidelines. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@docs/en/modules/admin/pages/settings.adoc`:
- Around line 23-28: Update the Scopes and Areas list entries to clarify their
relationship to Taxonomies: edit the xref:admin:settings/scopes.adoc[Scopes] and
xref:admin:settings/areas.adoc[Areas] lines to add a short parenthetical note
such as “(legacy — superseded by
xref:admin:settings/taxonomies.adoc[Taxonomies])” or “(still available in vX,
replaced by Taxonomies)”, ensuring the Taxonomies xref remains and clearly
indicates replacement; keep the wording brief and consistent with the other list
items.
In `@docs/en/modules/admin/pages/settings/taxonomies.adoc`:
- Line 9: Replace the abbreviated "e.g." in the sentence "Administrators can
define various taxonomies (e.g., territorial scopes, thematic areas) and apply
them consistently across different participation spaces and components." with
the full phrase "for example" so it reads "Administrators can define various
taxonomies (for example, territorial scopes, thematic areas) and apply them
consistently across different participation spaces and components." This change
will satisfy the Vale lint rule and unblock CI.
- Line 21: Replace the abbreviation "e.g." with the phrase "for example" in the
sentence that reads 'Enter the name of the taxonomy (e.g., "Geographic Scope" or
"Thematic Area")' so it becomes 'Enter the name of the taxonomy (for example,
"Geographic Scope" or "Thematic Area")' to satisfy the Vale lint rule; update
the text in the taxonomies.adoc content where that exact sentence occurs.
🧹 Nitpick comments (2)
docs/en/modules/admin/pages/settings/taxonomies.adoc (2)
31-38: Tighten wording to meet style rules (active voice, “will”, “click on”, “functionality”).Several Vale warnings can be addressed with a small rewrite.
✏️ Proposed fix
-4. Use the drag-and-drop functionality to reorder items as desired. +4. Use the drag-and-drop feature to reorder items as desired. -You can create filters with all or some taxonomy items that will be used to classify and filter participation spaces and components: +You can create filters with all or some taxonomy items to classify and filter participation spaces and components: -1. From the Actions menu, click on **Apply filters** to create or see the existing filters of a taxonomy. -2. Click on the **New filter** button, enter the label of the filter, that is the title that will be displayed in the frontend, and select which items are available for that filter. You can select only parents or only children. +1. From the Actions menu, click **Apply filters** to create or view existing filters for a taxonomy. +2. Click the **New filter** button, enter the filter label (the title displayed in the frontend), and select which items are available for that filter. You can select only parents or only children.
63-63: Prefer active voice here.Small style fix to avoid passive phrasing.
✏️ Proposed fix
-Taxonomy filters can also be associated with components to facilitate content classification: +You can also associate taxonomy filters with components to facilitate content classification:
| * xref:admin:settings/configuration.adoc[Configuration]: to configure general settings. | ||
| * xref:admin:settings/appearance.adoc[Appearance]: to configure the instance look and feel. | ||
| * xref:admin:settings/homepage.adoc[Homepage]: to configure what to display on the homepage. | ||
| * xref:admin:settings/homepage.adoc[Homepage]: to configure what to display on the homepage. | ||
| * xref:admin:settings/taxonomies.adoc[Taxonomies]: to manage taxonomies, a categorization feature. | ||
| * xref:admin:settings/scopes.adoc[Scopes]: to manage scopes, a categorization feature. | ||
| * xref:admin:settings/areas.adoc[Areas]: to manage areas, another categorization feature. |
There was a problem hiding this comment.
Clarify coexistence vs. replacement of Scopes/Areas now that Taxonomies is listed.
The new Taxonomies page says it replaces Categories/Scopes/Areas, but this settings list still presents Scopes/Areas as first-class options. Consider adding a brief note (e.g., “legacy” or “still available in vX”) to avoid confusion.
🤖 Prompt for AI Agents
In `@docs/en/modules/admin/pages/settings.adoc` around lines 23 - 28, Update the
Scopes and Areas list entries to clarify their relationship to Taxonomies: edit
the xref:admin:settings/scopes.adoc[Scopes] and
xref:admin:settings/areas.adoc[Areas] lines to add a short parenthetical note
such as “(legacy — superseded by
xref:admin:settings/taxonomies.adoc[Taxonomies])” or “(still available in vX,
replaced by Taxonomies)”, ensuring the Taxonomies xref remains and clearly
indicates replacement; keep the wording brief and consistent with the other list
items.
|
|
||
| NOTE: They replace the previous classification systems, such as Categories, Scopes, and Areas, providing a more streamlined approach to content organization. | ||
|
|
||
| Administrators can define various taxonomies (e.g., territorial scopes, thematic areas) and apply them consistently across different participation spaces and components. |
There was a problem hiding this comment.
Replace “e.g.” with “for example” to satisfy Vale.
The lint failure blocks CI; update the sentence accordingly.
✏️ Proposed fix
-Administrators can define various taxonomies (e.g., territorial scopes, thematic areas) and apply them consistently across different participation spaces and components.
+Administrators can define various taxonomies (for example, territorial scopes, thematic areas) and apply them consistently across different participation spaces and components.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Administrators can define various taxonomies (e.g., territorial scopes, thematic areas) and apply them consistently across different participation spaces and components. | |
| Administrators can define various taxonomies (for example, territorial scopes, thematic areas) and apply them consistently across different participation spaces and components. |
🧰 Tools
🪛 GitHub Actions: Vale linting
[info] 9-9: Use parentheses judiciously.
🪛 GitHub Check: prose
[failure] 9-9:
[vale] reported by reviewdog 🐶
[Google.Latin] Use 'for example' instead of 'e.g.'.
Raw Output:
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/en/modules/admin/pages/settings/taxonomies.adoc", "range": {"start": {"line": 9, "column": 47}}}, "severity": "ERROR"}
[warning] 9-9:
[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/en/modules/admin/pages/settings/taxonomies.adoc", "range": {"start": {"line": 9, "column": 46}}}, "severity": "INFO"}
🤖 Prompt for AI Agents
In `@docs/en/modules/admin/pages/settings/taxonomies.adoc` at line 9, Replace the
abbreviated "e.g." in the sentence "Administrators can define various taxonomies
(e.g., territorial scopes, thematic areas) and apply them consistently across
different participation spaces and components." with the full phrase "for
example" so it reads "Administrators can define various taxonomies (for example,
territorial scopes, thematic areas) and apply them consistently across different
participation spaces and components." This change will satisfy the Vale lint
rule and unblock CI.
| === Create a new taxonomy | ||
|
|
||
| 1. Click on the **New Taxonomy** button. | ||
| 2. Enter the name of the taxonomy (e.g., "Geographic Scope" or "Thematic Area"). |
There was a problem hiding this comment.
Use “for example” instead of “e.g.” (CI lint failure).
This is the second Vale error.
✏️ Proposed fix
-2. Enter the name of the taxonomy (e.g., "Geographic Scope" or "Thematic Area").
+2. Enter the name of the taxonomy (for example, "Geographic Scope" or "Thematic Area").📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 2. Enter the name of the taxonomy (e.g., "Geographic Scope" or "Thematic Area"). | |
| 2. Enter the name of the taxonomy (for example, "Geographic Scope" or "Thematic Area"). |
🧰 Tools
🪛 GitHub Check: prose
[failure] 21-21:
[vale] reported by reviewdog 🐶
[Google.Latin] Use 'for example' instead of 'e.g.'.
Raw Output:
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/en/modules/admin/pages/settings/taxonomies.adoc", "range": {"start": {"line": 21, "column": 36}}}, "severity": "ERROR"}
[warning] 21-21:
[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/en/modules/admin/pages/settings/taxonomies.adoc", "range": {"start": {"line": 21, "column": 35}}}, "severity": "INFO"}
🤖 Prompt for AI Agents
In `@docs/en/modules/admin/pages/settings/taxonomies.adoc` at line 21, Replace the
abbreviation "e.g." with the phrase "for example" in the sentence that reads
'Enter the name of the taxonomy (e.g., "Geographic Scope" or "Thematic Area")'
so it becomes 'Enter the name of the taxonomy (for example, "Geographic Scope"
or "Thematic Area")' to satisfy the Vale lint rule; update the text in the
taxonomies.adoc content where that exact sentence occurs.
Remove the local configuration from antora.yml please
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.