Skip to content

Commit 7b4f444

Browse files
committed
Update docs
1 parent 7699c1b commit 7b4f444

7 files changed

Lines changed: 20 additions & 14 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Netgen Tags Bundle
77
[![Latest stable](https://img.shields.io/packagist/v/netgen/tagsbundle.svg?style=flat-square)](https://packagist.org/packages/netgen/tagsbundle)
88
[![License](https://img.shields.io/github/license/netgen/TagsBundle.svg?style=flat-square)](https://packagist.org/packages/netgen/tagsbundle)
99

10-
Netgen Tags Bundle is an Ibexa Platform bundle for taxonomy management and easier classification of content, providing more functionality for tagging content than `ibexa_keyword` field type included in Ibexa Platform kernel.
10+
Netgen Tags Bundle is an Ibexa DXP bundle for taxonomy management and easier classification of content, providing more functionality for tagging content than `ibexa_keyword` field type included in Ibexa core.
1111

1212
Implemented features
1313
--------------------
@@ -19,7 +19,7 @@ Implemented features
1919
* `TagId` and `TagKeyword` search criteria
2020
* Solr indexing of `eztags` field type
2121
* Tag router and path generator
22-
* Admin interface (standalone, as well integrated into Ibexa Platform Admin UI)
22+
* Admin interface (standalone, as well integrated into Ibexa Admin UI)
2323
* REST interface
2424
* HTTP cache tagging and purging
2525

bundle/AdminUI/EventListener/MainMenuBuilderListener.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public static function getSubscribedEvents(): array
2727
}
2828

2929
/**
30-
* This method adds Netgen Tags menu items to Ibexa Platform admin interface.
30+
* This method adds Netgen Tags menu items to Ibexa admin interface.
3131
*/
3232
public function onMainMenuBuild(ConfigureMenuEvent $event): void
3333
{
@@ -39,7 +39,7 @@ public function onMainMenuBuild(ConfigureMenuEvent $event): void
3939
}
4040

4141
/**
42-
* Adds the Netgen Tags submenu to Ibexa Platform admin interface.
42+
* Adds the Netgen Tags submenu to Ibexa admin interface.
4343
*/
4444
private function addTagsSubMenu(ItemInterface $menu): void
4545
{

bundle/Resources/config/default_settings.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# It is not recommended to change these settings directly
2-
# Use Ibexa Platform semantic config instead
2+
# Use Ibexa semantic config instead
33

44
parameters:
55

@@ -53,6 +53,6 @@ parameters:
5353
netgen_tags.admin.default_pager_template: '@@NetgenTags/admin/pagerfanta.html.twig'
5454

5555
# Enables or disables persistence cache.
56-
# It will reuse Ibexa Platform persistence cache configuration.
56+
# It will reuse Ibexa persistence cache configuration.
5757
# Not exposed through semantic config due to it being NON-siteaccess aware.
5858
netgen_tags.enable_persistence_cache: true

bundle/Resources/config/pagerfanta.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ services:
1717

1818
netgen_tags.pagerfanta.view.netgen_tags_admin:
1919
class: Netgen\TagsBundle\Core\Pagination\Pagerfanta\View\TagsAdminView
20-
# Not being lazy results in out of memory exceptions on Ibexa Platform 2.0,
20+
# Not being lazy results in out of memory exceptions on Ibexa 2.0,
2121
# probably due to @twig dependency
2222
lazy: true
2323
arguments:

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "netgen/tagsbundle",
3-
"description": "Netgen Tags Bundle is an Ibexa Platform bundle for taxonomy management and easier classification of content, providing more functionality for tagging content than ibexa_keyword field type included in Ibexa Platform kernel.",
3+
"description": "Netgen Tags Bundle is an Ibexa DXP bundle for taxonomy management and easier classification of content, providing more functionality for tagging content than ibexa_keyword field type included in Ibexa core.",
44
"license": "GPL-2.0-only",
55
"type": "ibexa-bundle",
66
"keywords": [

doc/INSTALL.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Netgen Tags Bundle installation instructions
44
Requirements
55
------------
66

7-
* Ibexa Platform 4.0+
7+
* Ibexa DXP 5.0+
88

99
Installation steps
1010
------------------
@@ -28,32 +28,32 @@ netgen_tags:
2828
2929
### Import database tables
3030
31-
Netgen Tags Bundle uses custom database tables to store the tags. Use the following command to add the tables to your Ibexa Platform database:
31+
Netgen Tags Bundle uses custom database tables to store the tags. Use the following command to add the tables to your Ibexa database:
3232
3333
```
3434
$ mysql -u<user> -p<password> -h<host> <db_name> < vendor/netgen/tagsbundle/bundle/Resources/sql/mysql/schema.sql
3535
```
3636

3737
PostgreSQL variant of the above schema file is also available at `vendor/netgen/tagsbundle/bundle/Resources/sql/postgresql/schema.sql`
3838

39-
Note: Netgen Tags supports Ibexa Platform schema builder, making it possible to automatically install its database tables when installing
40-
clean/demo data of Ibexa Platform. In that case, there's no need to install the tables manually.
39+
Note: Netgen Tags supports Ibexa schema builder, making it possible to automatically install its database tables when installing
40+
clean/demo data of Ibexa. In that case, there's no need to install the tables manually.
4141

4242
### Update Anonymous Role permissions
4343

4444
Give 'Read' permissions to the 'Tags' module for the `Anonymous` role otherwise the field value is **empty**
4545

4646
### Clear the caches
4747

48-
Clear the Ibexa Platform caches with the following command:
48+
Clear the caches with the following command:
4949

5050
```bash
5151
$ php bin/console cache:clear
5252
```
5353

5454
### Install assets
5555

56-
Run the following to correctly install assets for Ibexa Platform Admin UI:
56+
Run the following to correctly install assets for Ibexa Admin UI:
5757

5858
```bash
5959
$ php bin/console assets:install --symlink --relative

doc/UPGRADE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
Netgen Tags Bundle upgrade instructions
22
=======================================
33

4+
Upgrade from 5.0 to 6.0
5+
-----------------------
6+
7+
* Minimum supported version of PHP is now PHP 8.3
8+
* Minimum supported version of Ibexa DXP is now 5.0
9+
410
Upgrade from 4.0 to 5.0
511
-----------------------
612

0 commit comments

Comments
 (0)