Skip to content
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.

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

IBX-8916: Updates in User documentation #313

Merged
merged 4 commits into from
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions docs/content_management/content_management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---

Check warning on line 1 in docs/content_management/content_management.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_management.md#L1

[Ibexa.ReadingLevel] The grade level is 25.00. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 25.00. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/content_management/content_management.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Content management enables you to create, edit, and manage content items and content types. It also includes content translation and publication scheduling.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
---

# Content management

Content management enables you to create, edit, and manage content items and content types. It also includes content translation and publication scheduling.

Check warning on line 7 in docs/content_management/content_management.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_management.md#L7

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/content_management/content_management.md", "range": {"start": {"line": 7, "column": 1}}}, "severity": "WARNING"}
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

[[= cards([
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
"content_management/content_items",
"content_management/create_edit_content_items",
"content_management/create_edit_pages",
"content_management/block_reference",
"content_management/preview_content_items",
"content_management/translate_content",
"content_management/work_with_forms",
"content_management/taxonomy/taxonomy",
"content_management/taxonomy/work_with_tags",
"content_management/content_versions",
"content_management/workflow_management/work_with_versions",
"content_management/workflow_management/editorial_workflow",
"content_management/workflow_management/view_workflow_list",
"content_management/content_organization/copy_move_hide_content",
"content_management/content_organization/classify_content",
"content_management/content_organization/manage_locations_urls"
], columns=4) =]]
3 changes: 2 additions & 1 deletion docs/content_management/create_edit_content_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: Create content for your website with different Fields, rich text, t

The new content item becomes a child of the content item that you originally selected.

- In the upper-right corner of the [My dashboard](../getting_started/discover_ui.md#my-dashboard) screen, click **Create content**.
- In the **Quick actions** block of the [Dashboard](../getting_started/discover_ui.md#dashboard) screen, click **Create content**.
Then choose a location for the new item in [Content Browser](../getting_started/discover_ui.md#content-browser) and click **Create**.

!!! tip
Expand All @@ -32,6 +32,7 @@ description: Create content for your website with different Fields, rich text, t
1. [Fill in the Fields](#edit-new-or-existing-content-items) of the content item.

1. Click **Preview** to see how the content item could look to an end-user.

!!! tip

A content item can look different on different [SiteAccesses](translate_content.md#siteaccess).
Expand Down
14 changes: 14 additions & 0 deletions docs/customer_management/customer_management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---

Check warning on line 1 in docs/customer_management/customer_management.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/customer_management/customer_management.md#L1

[Ibexa.ReadingLevel] The grade level is 18.77. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 18.77. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/customer_management/customer_management.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Customer management allows you to manage and view accounts for customers and organizations in your system, as well as create customer portals and allows for company self-registration.
---

# Customer management

Customer management allows you to manage and view accounts for customers and organizations in your system, as well as create customer portals and allow for company self-registration.

Check warning on line 7 in docs/customer_management/customer_management.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/customer_management/customer_management.md#L7

[Ibexa.Wordy] Use 'and' instead of 'as well as'.
Raw output
{"message": "[Ibexa.Wordy] Use 'and' instead of 'as well as'.", "location": {"path": "docs/customer_management/customer_management.md", "range": {"start": {"line": 7, "column": 108}}}, "severity": "WARNING"}
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

[[= cards([
"customer_management/customer_portal",
"customer_management/build_customer_portal",
"customer_management/manage_customers",
"customer_management/company_self_registration"
], columns=4) =]]
2 changes: 1 addition & 1 deletion docs/getting_started/dashboard/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Get to know about dashboard.
Dashboard is the first screen that you see after you log into [[= product_name =]].
It provides users a quick overview about specific content to make better business decisions based on data and work more efficiently with a clear and easy access to important information.

Dashboard in [[= product_name_headless =]] contains the following blocks:
Default dashboard in [[= product_name_headless =]] contains the following blocks:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Default dashboard in [[= product_name_headless =]] contains the following blocks:
The default dashboard in [[= product_name_headless =]] contains the following blocks:


- [Review queue](dashboard_block_reference.md#review-queue-block)
- [My content](dashboard_block_reference.md#my-content-block)
Expand Down
12 changes: 6 additions & 6 deletions docs/getting_started/dashboard/work_with_dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@
|Redo|![Redo](dashboard_redo.png)|Redo latest change.|
|Structure view|![Structure view](dashboard_structure_view.png)|Access Structure view toolbar.|
|Dashboard blocks|![Dashboard blocks](dashboard_blocks.png)|Access Dashboard blocks toolbar.|
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
|View switch|![View switch](dashboard_switch_toolbar.png)|Move Elements / Structure toolbar to the other side of the screen.|
|View switch|![View switch](dashboard_switch_toolbar.png)|Move toolbar to the other side of the screen.|
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

Dashboard Builder has two main toolbars that you can use while creating a dashboard:
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

- **Elements** - consists of all available blocks that you can use by dragging them and dropping on a drop zone.
- **Dashboard blocks** - consists of all available blocks that you can use by dragging them and dropping on a drop zone.

![Dashboard blocks](dashboard_blocks_toolbar.png)

Expand All @@ -71,7 +71,7 @@

### Add blocks

In Dashboard Builder, you can access a menu of **Elements**, which includes a set of blocks of content that you can add to the zones of the dashboard.
In Dashboard Builder, you can access a menu of **Dashboard blocks**, which includes a set of blocks of content that you can add to the zones of the dashboard.

Check warning on line 74 in docs/getting_started/dashboard/work_with_dashboard.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/dashboard/work_with_dashboard.md#L74

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.", "location": {"path": "docs/getting_started/dashboard/work_with_dashboard.md", "range": {"start": {"line": 74, "column": 4}}}, "severity": "WARNING"}

Check warning on line 74 in docs/getting_started/dashboard/work_with_dashboard.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/dashboard/work_with_dashboard.md#L74

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.", "location": {"path": "docs/getting_started/dashboard/work_with_dashboard.md", "range": {"start": {"line": 74, "column": 50}}}, "severity": "WARNING"}
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

!!! Tip

Expand All @@ -84,14 +84,14 @@

- drag and drop block in the desired location on a drop zone
- use **Move up block** or **Move down block** option from the block toolbar
- access Structure view and use 'Move up' and 'Move down' function in the settings of the block
- access Structure view and use **Move up** or **Move down** option in the settings of the block
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

When you add a new block to the drop zone, drop it in the blue highlighted area.
Before you drop it, a bold line appears - it helps you see the position of the newly added block in relation to other, already added blocks.

![Drop zone line](dashboard_blue_line.png)

When you add a block by dragging it from Elements menu into the drop zone, the block settings panel open immediately where you can configure all block properties.
When you add a block by dragging it from **Dashboard blocks** menu into the drop zone, the block settings panel open immediately where you can configure all block properties.

Check warning on line 94 in docs/getting_started/dashboard/work_with_dashboard.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/dashboard/work_with_dashboard.md#L94

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.", "location": {"path": "docs/getting_started/dashboard/work_with_dashboard.md", "range": {"start": {"line": 94, "column": 44}}}, "severity": "WARNING"}

![Block properties](dashboard_block_properties.png)

Expand Down Expand Up @@ -122,7 +122,7 @@

You can also work with the block, for example, duplicate it, change its position, or delete it.

Hover over the block and the toolbar appears.
When you hover over the block, the drop zone toolbar appears.
Click the three dots icon to see more options.

The following actions are available:
Expand Down
12 changes: 6 additions & 6 deletions docs/getting_started/discover_ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ G\. User avatar with a drop-down menu with access to [user profile and settings]
## Dashboard

The first screen that you see after logging in is [Dashboard](dashboard.md).
It is the default dashboard and contains selected blocks.
It's the default dashboard and contains selected blocks.

![Dashboard](dashboard.png "Dashboard")

Expand Down Expand Up @@ -77,7 +77,7 @@ Hidden content is greyed out in the tree view.

To simplify the Content Tree, big lists are collapsed and include a **Show more** icon.
You can select it to expand the branches of the tree.
Available from the context menu, the **Collapse all** option that closes all expanded sections.
**Collapse all** option, which is available in the context menu, closes all expanded sections.

For more information on custom configuration, go to [Content Tree]([[= developer_doc =]]/administration/back_office/content_tree/) in developer documentation.

Expand Down Expand Up @@ -111,12 +111,12 @@ Focus mode helps editors focus on information that is only relevant to their lin
It is enabled by default, after you log in.
If you need access to certain settings or technical details, you can [disable the focus mode](#disable-focus-mode) at any time.

Dark theme for Content Tree
- **Dark theme for Content Tree**
: In areas where the Content Tree is displayed, for example, in **Content structure**, the tree is displayed on a dark background.

![Dark theme for Content Tree](img/FM_dark_content_tree.png "Dark theme for Content Tree")

Content item view
- **Content item view**
: If you select a specific [SiteAccess](translate_content.md#siteaccess) from the **Site context** drop-down list on the right side of the top bar and then browse content items in Content Tree, they are displayed in full view, with a limited set of actions available.
To display the content item details view with more actions, click **Exit full view**.

Expand All @@ -126,13 +126,13 @@ To display the content item details view with more actions, click **Exit full vi

Even when you're out of the full view or not in Focus mode, you can still preview the content item in the **View** tab.

Different details view tabs in Focus mode and when it is disabled
- **Different details view tabs**
: In Focus mode, the tabs in content item's detail view are different than the ones visible when it is disabled.
Additionally, they are displayed in different order to expose the ones that are more important from the editor's perspective.

![Content item tabs in Focus mode](img/FM_less_ci_tabs.png "Content item tabs in Focus mode")

Different columns available for selection
- **Different columns available for selection**
: You can decide which columns are displayed in the **Sub-items** table, to adjust the view to your use case.
The list of columns available for selection is limited in Focus mode.

Expand Down
6 changes: 3 additions & 3 deletions docs/getting_started/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ products, media, as well as manage other functionalities and administer the plat

Depending on the product edition, [[= product_name =]] can provide advanced capabilities in such areas as:

- content editing: [editing and creating pages](../content_management/create_edit_pages.md), [editorial workflow](../content_management/workflow_management/editorial_workflow.md), etc.
- product management: [managing catalogs](../pim/work_with_catalogs.md), [managing product categories](../pim/work_with_product_categories.md)
- customer data management: [managing customers](../customer_management/manage_customers.md), etc.
- [content management](content_management.md)
- [product management](pim.md)
- [customer management](customer_management.md)

!!! note "Installation"

Expand Down
2 changes: 1 addition & 1 deletion docs/ibexa_engage/ibexa_engage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

To use [[= product_name_engage =]], you must make arrangements with [[= product_name_base =]] to define the initial configuration, and then get and set up a user account.

1\. Go to the Back Office.
1\. On the left menu panel, go to **Ibexa Engage**.

Check failure on line 16 in docs/ibexa_engage/ibexa_engage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_engage/ibexa_engage.md#L16

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_engage =]]' instead of 'Ibexa Engage'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_engage =]]' instead of 'Ibexa Engage'", "location": {"path": "docs/ibexa_engage/ibexa_engage.md", "range": {"start": {"line": 16, "column": 37}}}, "severity": "ERROR"}

2\. On the left panel, go to **Ibexa Engage**.

Expand Down
Binary file modified docs/ibexa_engage/img/welcome_page_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ nav:
- Create and edit content types: content_management/create_edit_content_types.md
- Configure content type Fields: content_management/configure_ct_field_settings.md
- Content management:
- Content management: content_management/content_management.md
- Content items: content_management/content_items.md
- Create and edit content items: content_management/create_edit_content_items.md
- Create and edit pages:
Expand Down Expand Up @@ -105,6 +106,7 @@ nav:
- DAM:
- Ibexa DAM: dam/ibexa_dam.md
- Customer management:
- Customer management: customer_management/customer_management.md
- Customer Portal: customer_management/customer_portal.md
- Create and edit Customer Portal: customer_management/build_customer_portal.md
- Manage customers: customer_management/manage_customers.md
Expand Down
Loading