Skip to content

Commit 7748bd3

Browse files
IBX-8590: Reorganizing documentation in terms of Product Guides (#2479)
* Fixes: new cards, mkdocs updated * Updates * New description, updates * Typo fix * Fixes after rev * Fixes after rev * Updates in the features table, fixes * Redirects fixed * Fix * Fix - docs removed from the redirect path
1 parent 95aa56e commit 7748bd3

File tree

32 files changed

+423
-292
lines changed

32 files changed

+423
-292
lines changed

docs/cdp/cdp_guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
description: The Ibexa CDP (Customer Data Platform) product guide provides a full description of its features as well as the benefits it brings to the client.
2+
description: The Ibexa CDP product guide describes all the possibilities that the Customer Data Platform offers to help you build great customer experiences.
33
edition: experience
44
---
55

6-
# [[= product_name_cdp =]] product guide
6+
# Ibexa Customer Data Platform (CDP) product guide
77

88
## What is [[= product_name_cdp =]]
99

@@ -45,7 +45,7 @@ This approach helps you create a single customer view.
4545

4646
To create a personalized customer experience, you need to group your clients into specified audiences.
4747
[[= product_name =]] comes with a ready solution - segment groups.
48-
Segment group information is reused by various [[= product_name =]] functionalities, such as [Personalization](https://doc.ibexa.co/en/latest/personalization/personalization_brochure/) or content targeting.
48+
Segment group information is reused by various [[= product_name =]] functionalities, such as [Personalization](personalization_guide.md) or content targeting.
4949

5050
You can [create a segment group](https://doc.ibexa.co/projects/userguide/en/latest/personalization/segment_management/) in the Back Office of [[= product_name =]]. It serves as a container for all segments data generated by [[= product_name_cdp =]].
5151
When you create a segment group, you need to provide its name and identifier.

docs/content_management/content_management.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ page_type: landing_page
66
# Content management
77

88
[[= cards([
9+
"content_management/content_management_guide",
910
"content_management/content_model",
1011
"content_management/locations",
1112
"content_management/field_types/field_type_reference/field_type_reference",

docs/content_management/content_management_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: The content management product guide provides a full description of its features as well as the benefits it brings to the client.
2+
description: Read the content management product guide and learn how to create, modify, and display information to the target audience.
33
---
44

55
# Content management product guide

docs/content_management/field_types/field_type_reference/formfield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ The Form Field Type stores a Form consisting of one or more form fields.
1212

1313

1414

15-
See [Forms](forms.md) for more information about working with Forms.
15+
See [Forms](work_with_forms.md) for more information about working with Forms.

docs/content_management/forms/form_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ edition: experience
77

88
## Form submissions
99

10-
To manage form submissions created in the [Form Builder](forms.md), use `FormSubmissionServiceInterface`.
10+
To manage form submissions created in the [Form Builder](form_builder_guide.md), use `FormSubmissionServiceInterface`.
1111

1212
### Getting form submissions
1313

docs/content_management/forms/form_builder_guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: The Form Builder product guide provides a full description of its features as well as the benefits it brings to the client.
2+
description: See the Form Builder product guide and learn how to create various forms to increase the functionality of your website.
33
edition: experience
44
---
55

@@ -64,7 +64,7 @@ To learn more, see [Work with forms]([[= user_doc =]]/content_management/work_wi
6464

6565
### Forms management
6666

67-
[Form](forms.md) is one of available [content items]([[= user_doc =]]/content_management/content_items/) that you can find in the platform.
67+
[Form](work_with_forms.md) is one of available [content items]([[= user_doc =]]/content_management/content_items/) that you can find in the platform.
6868
You can work with it as with other regular items: create new one, edit existing one, move, etc.
6969

7070
You can manage all the existing forms. To do it, in a selected place of the content tree find your form and click on it.
Lines changed: 11 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,18 @@
11
---
2-
description: Form Builder enables creating dynamic forms to use in surveys, questionnaires, sign-up forms and others.
2+
description: Forms are a type of content item that you can use to improve the functionality of your website.
33
edition: experience
4+
page_type: landing_page
45
---
56

67
# Forms
78

8-
You can build forms consisting of different fields in the Form Builder.
9+
Forms are a type of content item that you can use to improve the functionality of your website.
910

10-
!!! tip
11-
12-
To learn how to get, create, and delete form submissions by using the PHP API,
13-
see [Form API](form_api.md).
14-
15-
[[% include 'snippets/forms_caution.md' %]]
16-
17-
## Existing Form fields
18-
19-
### Captcha field
20-
21-
The Captcha Form field is based on [Gregwar/CaptchaBundle](https://github.com/Gregwar/CaptchaBundle).
22-
23-
![Captcha field](extending_form_builder_captcha_default.png)
24-
25-
You can customize the field by adding configuration to `config/packages/gregwar_captcha.yaml` under `gregwar_captcha`:
26-
27-
``` yaml
28-
gregwar_captcha:
29-
as_url: true
30-
width: 150
31-
invalid_message: Code does not match, please retry.
32-
reload: true
33-
```
34-
35-
The example configuration above resizes the Captcha image (line 3), changes the error message (line 4),
36-
and enables the user to reload the code (line 5).
37-
38-
![Custom captcha field](extending_form_builder_captcha_result.png)
39-
40-
For information about available options, see [Gregwar/CaptchaBundle's documentation](https://github.com/Gregwar/CaptchaBundle#options).
41-
42-
!!! note
43-
44-
If your installation uses Varnish to manage content cache, you must modify the configuration to avoid issues with the Captcha field. For more information, see [Ensure proper captcha behavior](reverse_proxy.md#ensure-proper-captcha-behavior).
45-
46-
## Form submission purging
47-
48-
You can purge all submissions of a given form.
49-
To do this, run the following command, where `form-id` stands for Content ID
50-
of the form for which you want to purge data:
51-
52-
```bash
53-
php bin/console ibexa:form-builder:purge-form-submissions [options] [--] <form-id>
54-
```
55-
56-
The following table lists some of the available options and their meaning:
57-
58-
| Switch | Option | Description |
59-
|--------------|------------|------------|
60-
| `-l` | `--language-code=LANGUAGE-CODE` | Passes a language code, for example, "eng-GB". |
61-
| `-u` | `--user[=USER]` | Passes a repository username. By default it is "admin". |
62-
| `-c` | `--batch-size[=BATCH-SIZE]` | Passes a number of URLs to check in a single iteration. Set it to avoid using too much memory. By default it is set to 50. |
63-
| | `--siteaccess[=SITEACCESS]` | Passes a SiteAccess to use for operations. If not provided, the default SiteAccess is used. |
64-
65-
## Form-uploaded files
66-
67-
You can use Forms to enable the user to upload files.
68-
The default Location for files uploaded in this way is `/Media/Files/Form Uploads`.
69-
You can change it with the following configuration:
70-
71-
``` yaml
72-
ibexa:
73-
system:
74-
default:
75-
form_builder:
76-
upload_location_id: 54
77-
```
78-
79-
This applies only if no specific Location is defined in the Form itself.
11+
[[= cards([
12+
"content_management/forms/form_builder_guide",
13+
"content_management/forms/work_with_forms",
14+
"content_management/forms/form_api",
15+
"content_management/forms/create_form_attribute",
16+
"content_management/forms/create_custom_form_field",
17+
"content_management/forms/customize_email_notifications"
18+
], columns=3) =]]
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
description: Form Builder enables creating dynamic forms to use in surveys, questionnaires, sign-up forms and others.
3+
edition: experience
4+
---
5+
6+
# Forms
7+
8+
You can build forms consisting of different fields in the Form Builder.
9+
10+
!!! tip
11+
12+
To learn how to get, create, and delete form submissions by using the PHP API,
13+
see [Form API](form_api.md).
14+
15+
[[% include 'snippets/forms_caution.md' %]]
16+
17+
## Existing Form fields
18+
19+
### Captcha field
20+
21+
The Captcha Form field is based on [Gregwar/CaptchaBundle](https://github.com/Gregwar/CaptchaBundle).
22+
23+
![Captcha field](extending_form_builder_captcha_default.png)
24+
25+
You can customize the field by adding configuration to `config/packages/gregwar_captcha.yaml` under `gregwar_captcha`:
26+
27+
``` yaml
28+
gregwar_captcha:
29+
as_url: true
30+
width: 150
31+
invalid_message: Code does not match, please retry.
32+
reload: true
33+
```
34+
35+
The example configuration above resizes the Captcha image (line 3), changes the error message (line 4),
36+
and enables the user to reload the code (line 5).
37+
38+
![Custom captcha field](extending_form_builder_captcha_result.png)
39+
40+
For information about available options, see [Gregwar/CaptchaBundle's documentation](https://github.com/Gregwar/CaptchaBundle#options).
41+
42+
!!! note
43+
44+
If your installation uses Varnish to manage content cache, you must modify the configuration to avoid issues with the Captcha field. For more information, see [Ensure proper captcha behavior](reverse_proxy.md#ensure-proper-captcha-behavior).
45+
46+
## Form submission purging
47+
48+
You can purge all submissions of a given form.
49+
To do this, run the following command, where `form-id` stands for Content ID
50+
of the form for which you want to purge data:
51+
52+
```bash
53+
php bin/console ibexa:form-builder:purge-form-submissions [options] [--] <form-id>
54+
```
55+
56+
The following table lists some of the available options and their meaning:
57+
58+
| Switch | Option | Description |
59+
|--------------|------------|------------|
60+
| `-l` | `--language-code=LANGUAGE-CODE` | Passes a language code, for example, "eng-GB". |
61+
| `-u` | `--user[=USER]` | Passes a repository username. By default it is "admin". |
62+
| `-c` | `--batch-size[=BATCH-SIZE]` | Passes a number of URLs to check in a single iteration. Set it to avoid using too much memory. By default it is set to 50. |
63+
| | `--siteaccess[=SITEACCESS]` | Passes a SiteAccess to use for operations. If not provided, the default SiteAccess is used. |
64+
65+
## Form-uploaded files
66+
67+
You can use Forms to enable the user to upload files.
68+
The default Location for files uploaded in this way is `/Media/Files/Form Uploads`.
69+
You can change it with the following configuration:
70+
71+
``` yaml
72+
ibexa:
73+
system:
74+
default:
75+
form_builder:
76+
upload_location_id: 54
77+
```
78+
79+
This applies only if no specific Location is defined in the Form itself.

docs/content_management/pages/page_builder_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: The Page Builder product guide provides a full description of its features as well as the benefits it brings to the client.
2+
description: Read about the Page Builder - a powerful tool for creating and modifying pages in Ibexa DXP.
33
edition: experience
44
---
55

docs/content_management/pages/pages.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ page_type: landing_page
88
Pages are block-based special types of content that editors can create and modify by using a visual drag-and-drop editor.
99

1010
[[= cards([
11+
"content_management/pages/page_builder_guide",
1112
"content_management/pages/page_blocks",
1213
"content_management/pages/page_block_attributes",
1314
"content_management/pages/page_block_validators",
1415
"content_management/pages/create_custom_page_block",
15-
], columns=4) =]]
16+
], columns=3) =]]

0 commit comments

Comments
 (0)