IBX-8917: Content fixes in Developer Documentation #2506

julitafalcondusza · 2024-10-03T13:09:21Z

Question	Answer
JIRA Ticket	(https://issues.ibexa.co/browse/IBX-8917)
Versions	4.6+

Content fixes in Developer Documentation

Checklist

Text renders correctly
Text has been checked with vale
Description metadata is up to date

adamwojs · 2024-10-25T15:03:58Z

@julitafalcondusza rebase is needed here

mnocon

Lots of work here, good job on preparing this - but there are some things to fix before we merge this:

Almost the whole Search reference is marked as Commerce only, this needs to be reverted
You're also changing the licence of a font we're using - let's revert it
Some includes have broken after the headers have been changed to use variables
There is one repeating error - a sentence starting with they're (lowercase). Please review this as well, as I'm not sure if I found all the occurances of this
In some places you're removing the dangling comma from card includes - but keeping it is a good practice, let's bring them back.
Changes to PHP API Reference will be lost when it's regenerated - and the code is not adjusted. Let's revert them as well (or create PRs fixing them in the code as a follow-up).
Have you regenerated the REST API reference, are the HTML changes to it consistent with the changes to the RAML files?

docs/administration/admin_panel/segments_admin_panel.md

docs/administration/back_office/content_tree.md

docs/administration/back_office/notifications.md

docs/administration/configuration/repository_configuration.md

docs/administration/content_organization/object_states.md

docs/infrastructure_and_maintenance/security/reporting_issues.md

docs/infrastructure_and_maintenance/security/security_checklist.md

docs/permissions/permission_use_cases.md

...pi/php_api/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-GatewayBasedStorage.html

docs/administration/back_office/back_office_configuration.md

docs/administration/back_office/back_office_elements/formatting_date_and_time.md

docs/update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish.md

docs/update_and_migration/migrate_to_ibexa_dxp/common_issues.md

docs/update_and_migration/from_4.5/update_from_4.5.md

julitafalcondusza · 2024-11-26T11:20:40Z

Lots of work here, good job on preparing this - but there are some things to fix before we merge this:

Almost the whole Search reference is marked as Commerce only, this needs to be reverted

You're also changing the licence of a font we're using - let's revert it

Some includes have broken after the headers have been changed to use variables

There is one repeating error - a sentence starting with they're (lowercase). Please review this as well, as I'm not sure if I found all the occurances of this

In some places you're removing the dangling comma from card includes - but keeping it is a good practice, let's bring them back.

Changes to PHP API Reference will be lost when it's regenerated - and the code is not adjusted. Let's revert them as well (or create PRs fixing them in the code as a follow-up).

Have you regenerated the REST API reference, are the HTML changes to it consistent with the changes to the RAML files?

Reverted ✅
Reverted ✅
Fixed ✅
Reviewed, fixed missed occurrences. ✅
Fixed ✅
PHP API Reference files are now excluded from PR (changes are reverted). ✅
REST API Reference files are now excluded from PR (changes are reverted). ✅

6&7 - we can think about separate PR with the fixes in .raml and .html files.

mnocon

Thank you!

docs/api/rest_api/rest_api_usage/rest_responses.md

dabrt

Minor issues reported offline

adriendupuis

I end my review at docs/personalization/api_reference/tracking_api.md as the PR seems already merged. No big changes asked.

adriendupuis · 2024-11-28T11:13:57Z

docs/content_management/pages/page_builder_guide.md

@@ -7,7 +7,8 @@ edition: experience

 ## What is page

-[Page](pages.md) is a block-based type of content. You can create and modify it with a visual drag-and-drop editor - Page Builder.
+[Page](pages.md) is a block-based type of content.
+You can create and modify it with a visual drag-and-drop editor - Page Builder.


Suggested change

You can create and modify it with a visual drag-and-drop editor - Page Builder.

You can create and modify it with a visual drag-and-drop editor - the Page Builder.

adriendupuis · 2024-11-28T11:15:04Z

docs/content_management/pages/react_app_block.md

@@ -8,8 +8,7 @@ React App block allows an editor to embed a preconfigured React application into
 It's configured in YAML files, under the `ibexa_fieldtype_page` key.
 Page block configuration isn't SiteAccess-aware.

-Another element of React App Block is `\Ibexa\FieldTypePage\FieldType\Page\Block\Event\Listener\ReactBlock` Listener 
-which adds component and props variables.
+Another element of React App Block is `\Ibexa\FieldTypePage\FieldType\Page\Block\Event\Listener\ReactBlock` Listener  which adds component and props variables.


Suggested change

Another element of React App Block is `\Ibexa\FieldTypePage\FieldType\Page\Block\Event\Listener\ReactBlock` Listener which adds component and props variables.

Another element of React App Block is `\Ibexa\FieldTypePage\FieldType\Page\Block\Event\Listener\ReactBlock` Listener which adds component and props variables.

adriendupuis · 2024-11-28T12:13:14Z

docs/ibexa_products/ibexa_commerce.md

@@ -34,7 +35,7 @@ With a help of documentation and trainings, any developer familiar with Symfony

 Version control systems and environment variables allow you to deploy your extensions and settings on several environments, such as [Ibexa Cloud](ibexa_cloud_guide.md).

-[[= product_name_com =]] is built on [[[= product_name_exp =]]](ibexa_experience.md) and includes all bundles, APIs, and features that come with both [Headless](ibexa_headless.md#core-features) and [Experience](ibexa_experience.md#core-features) editions.
+[[= product_name_com =]] is built on [Ibexa Experience](ibexa_experience.md) and includes all bundles, APIs, and features that come with both [Headless](ibexa_headless.md#core-features) and [Experience](ibexa_experience.md#core-features) editions.


This one was properly working and might not be necessary.

Suggested change

[[= product_name_com =]] is built on [Ibexa Experience](ibexa_experience.md) and includes all bundles, APIs, and features that come with both [Headless](ibexa_headless.md#core-features) and [Experience](ibexa_experience.md#core-features) editions.

[[= product_name_com =]] is built on [[[= product_name_exp =]]](ibexa_experience.md) and includes all bundles, APIs, and features that come with both [Headless](ibexa_headless.md#core-features) and [Experience](ibexa_experience.md#core-features) editions.

Are we authorized to nickname "Ibexa Experience" as "Experience" and "Ibexa Headless" as "Headless"? (I would say that we are if not overused.)

docs/personalization/api_reference/tracking_api.md

* Content updates, capitalization fixes * New fixes * New fixes * New fixes * New fixes * Fixes * Typo fix * Field -> field * Capitalization fixes * Fixes * Fixes * Fixes * Fixes * Fixes * Fixes * Variables fix * More fixes * More fixes * More fixes * Batch of fixes * Tabs fixes * 'Will' fixes * 'Won't' fixes * 'e.g.' fixes * Fixes in 'back office' section * Fixes in 'configuration' section * Fixes in 'content organization' section * Fixes * Fixes in'api' section * Fixes in 'cdp' section * Fixes in 'commerce' * Fixes in 'content management' section * Fixes in 'customer management' * Fixes in 'getting started' section * Fixes in 'ibexa cloud' * Fixes in 'ibexa engage' section * Fixes in 'ibexa products' section * Fixes in 'cache' section * Fixes in 'clustering' * Fixes in 'security' * Fixes in 'infrastructure' section * Fixes in 'languages' * Fixes in 'site factory and siteaccess' sections * Fixes in 'multisite' * Fixes in 'permissions' section * Fixes in 'personalization' * Fixes in 'pim' * Fixes in 'resources' * Fixes in 'search references' and aggregations * Fixes in 'search' * Fixes in 'snippets' * Fixes in 'templates' * Fixes in 'tutorials' * Fixes in 'users' * Fixes - 'field' * Fixes - 'section' * Fixes - 'location' * Fixes - 'subtree' * Fixes - 'value object' * Fixes - 'search criteria' * Fixes - 'product' * Fixes - 'sort clauses' * Fixes - 'elasticsearch' * Fix 'storefront' * Fixes - 'etc.' * Fixes - 'policies' * Fixes * Fixes * Fixes * Fixes * Fixes * Links fixed (variables removed) * Fixes after review * Fixes after review * Revert changes in api .raml and .html files * fix * fixes

julitafalcondusza added 30 commits October 3, 2024 15:07

Content updates, capitalization fixes

2abc3ef

New fixes

7255d1a

New fixes

2a2efd2

New fixes

60a52f8

New fixes

2f6e6de

Fixes

880aa0a

Typo fix

1bf737c

Field -> field

c880dda

Capitalization fixes

705aa0f

Fixes

5388580

Fixes

44e0229

Fixes

fa50644

Fixes

88aac46

Fixes

6c158a1

Fixes

94f89b4

Variables fix

28c7a8f

More fixes

99a61d9

More fixes

5602150

More fixes

7679df7

Batch of fixes

dd8018e

Tabs fixes

447a3f5

'Will' fixes

089c485

'Won't' fixes

ccdc2f0

'e.g.' fixes

9a8a1d2

Fixes in 'back office' section

b598eac

Fixes in 'configuration' section

2c1ee6b

Fixes in 'content organization' section

048289e

Fixes

cfc3b8d

Fixes in'api' section

078e3cb

Fixes in 'cdp' section

3dea47d

julitafalcondusza added 4 commits October 17, 2024 14:06

Fixes

9bb7b01

Fixes

5a99844

Fixes

f8fe289

Links fixed (variables removed)

a9bd8f1

julitafalcondusza marked this pull request as ready for review October 17, 2024 13:14

julitafalcondusza added the Needs DOC review label Oct 17, 2024

Merge branch 'master' into IBX-8917

7fa6f16

mnocon mentioned this pull request Oct 29, 2024

IBX-8823: Manage user data from CLI #2527

Merged

4 tasks

mnocon requested changes Nov 20, 2024

View reviewed changes

Fixes after review

ac5d231

dabrt reviewed Nov 25, 2024

View reviewed changes

julitafalcondusza added 3 commits November 25, 2024 15:04

Fixes after review

6f77524

Revert changes in api .raml and .html files

e524c96

fix

5ce27af

julitafalcondusza and others added 2 commits November 27, 2024 10:17

Merge remote-tracking branch 'origin/master' into IBX-8917

4fc5f62

Merge branch 'master' into IBX-8917

702ff7a

julitafalcondusza requested review from mnocon, adriendupuis and dabrt November 27, 2024 10:24

mnocon approved these changes Nov 27, 2024

View reviewed changes

adriendupuis reviewed Nov 28, 2024

View reviewed changes

docs/api/rest_api/rest_api_usage/rest_responses.md Show resolved Hide resolved

dabrt approved these changes Nov 28, 2024

View reviewed changes

fixes

364ab9f

julitafalcondusza merged commit cceaa73 into master Nov 28, 2024
4 of 5 checks passed

julitafalcondusza deleted the IBX-8917 branch November 28, 2024 13:36

julitafalcondusza removed the Needs DOC review label Nov 28, 2024

adriendupuis approved these changes Nov 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IBX-8917: Content fixes in Developer Documentation #2506

IBX-8917: Content fixes in Developer Documentation #2506

julitafalcondusza commented Oct 3, 2024 •

edited

Loading

adamwojs commented Oct 25, 2024

mnocon left a comment

julitafalcondusza commented Nov 26, 2024

mnocon left a comment

dabrt left a comment

adriendupuis left a comment •

edited

Loading

adriendupuis Nov 28, 2024

adriendupuis Nov 28, 2024

adriendupuis Nov 28, 2024

	You can create and modify it with a visual drag-and-drop editor - Page Builder.
	You can create and modify it with a visual drag-and-drop editor - the Page Builder.

	Another element of React App Block is `\Ibexa\FieldTypePage\FieldType\Page\Block\Event\Listener\ReactBlock` Listener which adds component and props variables.
	Another element of React App Block is `\Ibexa\FieldTypePage\FieldType\Page\Block\Event\Listener\ReactBlock` Listener which adds component and props variables.

	[[= product_name_com =]] is built on [Ibexa Experience](ibexa_experience.md) and includes all bundles, APIs, and features that come with both [Headless](ibexa_headless.md#core-features) and [Experience](ibexa_experience.md#core-features) editions.
	[[= product_name_com =]] is built on [[[= product_name_exp =]]](ibexa_experience.md) and includes all bundles, APIs, and features that come with both [Headless](ibexa_headless.md#core-features) and [Experience](ibexa_experience.md#core-features) editions.

IBX-8917: Content fixes in Developer Documentation #2506

IBX-8917: Content fixes in Developer Documentation #2506

Conversation

julitafalcondusza commented Oct 3, 2024 • edited Loading

Checklist

adamwojs commented Oct 25, 2024

mnocon left a comment

Choose a reason for hiding this comment

julitafalcondusza commented Nov 26, 2024

mnocon left a comment

Choose a reason for hiding this comment

dabrt left a comment

Choose a reason for hiding this comment

adriendupuis left a comment • edited Loading

Choose a reason for hiding this comment

adriendupuis Nov 28, 2024

Choose a reason for hiding this comment

adriendupuis Nov 28, 2024

Choose a reason for hiding this comment

adriendupuis Nov 28, 2024

Choose a reason for hiding this comment

julitafalcondusza commented Oct 3, 2024 •

edited

Loading

adriendupuis left a comment •

edited

Loading