Skip to content

Enhance create page blocks doc #2514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 14, 2024
Merged

Enhance create page blocks doc #2514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
720b62e
create_custom_page_block.md: Highlight that new block must be enabled…
adriendupuis Oct 8, 2024
5f8412a
data_migration_actions.md: Add add_block_to_available_blocks example
adriendupuis Oct 8, 2024
b37887f
Update docs/content_management/pages/create_custom_page_block.md
adriendupuis Oct 9, 2024
59ddbee
Apply suggestions from code review
adriendupuis Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/content_management/data_migration/data_migration_actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ The following migration actions are available out of the box:
- `remove_drafts` (Content type Update)
- `remove_field_by_identifier` (Content type Update)
- `unassign_content_type_group` (Content type Update)
- `add_block_to_available_blocks` (Content type Update)
- `assign_role_to_user` (Role Create / Update)
- `assign_role_to_user_group` (Role Create / Update)
- `assign_user_to_role` (User Create / Update)
Expand Down Expand Up @@ -103,6 +104,7 @@ mode: Update
- { action: unassign_content_type_group, value: 'Content' }
- { action: remove_field_by_identifier, value: 'short_title' }
- { action: remove_drafts, value: null }
- { action: add_block_to_available_blocks, fieldDefinitionIdentifier: 'page', blocks: ['event'] }
```

### Roles
Expand Down
7 changes: 5 additions & 2 deletions docs/content_management/pages/create_custom_page_block.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,5 +132,8 @@ The following UDW configuration is used so only an `event` typed content item ca

For more information, see [UDW configuration](browser.md#udw-configuration).

Your custom page block is now ready.
Before you can use it in Page Builder, you must [enable it in Page field settings]([[= user_doc =]]/content_management/configure_ct_field_settings/#block-display).
Your custom page block is now registered in the system.

!!! caution

To use the new block in Page Builder, add it to the list of available blocks in a given content type's settings. This can be done manually in [Page field settings]([[= user_doc =]]/content_management/configure_ct_field_settings/#block-display) or by using the migration action [`add_block_to_available_blocks`](data_migration_actions.md#content-types).
Loading