Skip to content
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
6 changes: 3 additions & 3 deletions docs/content_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@

For more information about users and permissions, see [Users](site_organization/organizing_the_site.md#users).

For more information about site skeletons, see [Site skeletons](https://doc.ibexa.co/en/latest/guide/multisite/site_factory_configuration/#site-skeletons).
For more information about site skeletons, see [Site skeletons]([[= developer_doc =]]/guide/multisite/site_factory_configuration/#site-skeletons).

### Content Tree

Expand All @@ -122,11 +122,11 @@

![Content Tree in the menu](img/left_menu_tree.png "Content Tree in the menu")

Unique icons for each Content Type instantly show you what type of content you are selecting. To add custom icons to your Content Tree, follow [configuration tutorial in developer documentation.](https://doc.ibexa.co/en/latest/extending/custom_icons/#customize-content-type-icons)
Unique icons for each Content Type instantly show you what type of content you are selecting. To add custom icons to your Content Tree, follow [configuration tutorial in developer documentation.]([[= developer_doc =]]/extending/custom_icons/#customize-content-type-icons)

Check warning on line 125 in docs/content_model.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_model.md#L125

[Ibexa.DontCapitalize] Don't capitalize 'Content Type' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Content Type' if inside the sentence.", "location": {"path": "docs/content_model.md", "range": {"start": {"line": 125, "column": 23}}}, "severity": "WARNING"}

Check warning on line 125 in docs/content_model.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_model.md#L125

[Ibexa.DontCapitalize] Don't capitalize 'Content Tree' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Content Tree' if inside the sentence.", "location": {"path": "docs/content_model.md", "range": {"start": {"line": 125, "column": 123}}}, "severity": "WARNING"}

Hidden content is blurred out in the tree view.

To simplify the Content Tree, big lists are shortened with a **Show more** option. You can select it to expand all lists in the tree.
The **Collapse all** option situated at the bottom of the tree closes all expanded sections.

For more information on custom configuration, go to [Content Tree](https://doc.ibexa.co/en/latest/administration/back_office/content_tree) in developer documentation.
For more information on custom configuration, go to [Content Tree]([[= developer_doc =]]/extending/content_tree/) in developer documentation.
2 changes: 1 addition & 1 deletion docs/creating_content_basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ This will open the window to create the link. In the **Link to** box, enter the
In image options you can select an image variation.
Variations can include different sizing options and other filters that are applied to images.
Available image variations must be configured at the developer level.
See [Images](https://doc.ibexa.co/en/latest/guide/images/) for a technical guide on how to do this.
See [Images]([[= developer_doc =]]/guide/images/images/) for a technical guide on how to do this.

### Tables

Expand Down
2 changes: 1 addition & 1 deletion docs/editing_images.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ so the area that contains the selected point is always visible.
!!! note

Cropping to focal point is not automatic. The site's templates must be adapted for this to happen.
See [Use focal point](https://doc.ibexa.co/en/latest/guide/content_rendering/embed_and_list_content/render_images/#use-focal-point)
See [Use focal point]([[= developer_doc =]]/guide/content_rendering/embed_and_list_content/render_images/#use-focal-point)
in developer documentation for an example of implementing such cropping.

Click the **Show point** button to see a target on the preview.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ and provides a user interface to work with the content and administer the platfo

## Quick start

[[= product_name =]] must be [installed by administrator](https://doc.ibexa.co/en/latest/getting_started/install_ez_platform/).
[[= product_name =]] must be [installed by administrator]([[= developer_doc =]]/getting_started/install_ez_platform/).
They should provide you with the address of the installation.

To access the Back Office (the editor interface), add `/admin` to this address.
Expand Down
4 changes: 2 additions & 2 deletions docs/personalization/content_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For example, one can load an exported file to the personalization service from a
This type of import is intended to upload big portions of information,
and can be used to perform a weekly update of the whole product catalog.

For detailed information about content data import, see [Content API](https://doc.ibexa.co/en/latest/guide/personalization/developer_guide/content_api) in the developer documentation.
For detailed information about content data import, see [Content API]([[= developer_doc =]]/guide/personalization/developer_guide/content_api/) in the developer documentation.

## User data import

Expand All @@ -33,7 +33,7 @@ a successful recommendation, for example, by enabling the use of [boost filters]
User attributes could be retrieved based on the external user ID.
However, it is rarely possible to combine the external user ID within the user's attribute set.

For more information about user attribute import, see [User API](https://doc.ibexa.co/en/latest/guide/personalization/developer_guide/user_api) in the developer documentation.
For more information about user attribute import, see [User API]([[= developer_doc =]]/guide/personalization/developer_guide/user_api/) in the developer documentation.

## List of import operations

Expand Down
2 changes: 1 addition & 1 deletion docs/personalization/enabling_personalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Your request is sent to Ibexa, and you will receive a confirmation email in resp

## Configuring customer credentials

When you receive the confirmation email, ask your administrator to [add the credentials to your configuration](https://doc.ibexa.co/en/latest/guide/personalization/enabling_personalization/#configuring-mandator-credentials).
When you receive the confirmation email, ask your administrator to [add the credentials to your configuration]([[= developer_doc =]]/guide/personalization/enabling_personalization/#setting-up-customer-credentials).

## Change the installation key

Expand Down
2 changes: 1 addition & 1 deletion docs/personalization/integrating_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ icon next to the site in which you want to place a personalization block.
1. Save your changes to the draft or publish the Page.

For more information about collecting events and embedding recommendation results,
see [Integrate recommendation service](https://doc.ibexa.co/en/3.3/guide/personalization/basic_integration/).
see [Integrate recommendation service]([[= developer_doc =]]/guide/personalization/basic_integration/).
2 changes: 1 addition & 1 deletion docs/personalization/personalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Recommendations become better with time and the amount of data collected.
Once the service generates the results, you can present them to the user
by embedding recommendation lists in your pages and screens.
Both event tracking and results publishing is done by the administrators, according to
the procedure [described in the developer documentation](https://doc.ibexa.co/en/3.3/guide/personalization/basic_integration/).
the procedure [described in the developer documentation]([[= developer_doc =]]/guide/personalization/basic_integration/).
4 changes: 2 additions & 2 deletions docs/publishing/editorial_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ For example, you can pass content through stages of draft, design and proofreadi
In your workflows you can have different stages and transition between them.

Contact your administrator or developer team to configure workflows.
See [developer documentation](https://doc.ibexa.co/en/latest/guide/workflow/) for information on how to do it.
See [developer documentation]([[= developer_doc =]]/guide/workflow/workflow/) for information on how to do it.

## Review queue

You can view Content items which are in different stages under review on the
**My dashboard** screen, in the Review queue table.
The table only shows Content items that your Role has permissions to edit.
If your installation is [configured to support draft locking](https://doc.ibexa.co/en/latest/guide/workflow/#draft-locking),
If your installation is [configured to support draft locking]([[= developer_doc =]]/guide/workflow/workflow/#draft-locking),
the table also informs you whether any reviewers are assigned and have claimed
their drafts for review.

Expand Down
4 changes: 2 additions & 2 deletions docs/site_organization/organizing_the_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ You can also copy the whole subtree (a Content item with all content under it in
Copying very large subtrees may take too much time and server effort. That is why the system administrator
may set a limit on how many Content items can be copied at the same time.

See [Copy subtree limit](https://doc.ibexa.co/en/latest/guide/config_back_office/#copy-subtree-limit)
See [Copy subtree limit]([[= developer_doc =]]/extending/config_back_office/#copy-subtree-limit)
in the developer documentation on how to set this up.

Copying creates a new Content item.
Expand Down Expand Up @@ -121,7 +121,7 @@ in all of its Locations.
In your site, you can manage external URL addresses and URL wildcards.
You do this in the Back Office, **Admin** tab, the **URL Management** node.

For more information about URL management, see the [Ibexa Developer Documentation.](https://doc.ibexa.co/en/latest/guide/url_management).
For more information about URL management, see the [Ibexa Developer Documentation.]([[= developer_doc =]]/guide/url_management/).

### Link manager

Expand Down
6 changes: 3 additions & 3 deletions docs/site_organization/site_factory.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
The Site Factory enables you to easily create and manage multiple sites in different languages from one place.
All the sites can be kept in the Repository of your installation.
To be able to use it, the Site Factory has to be enabled and configured by your administrator.
For more information see developer documentation on [Site Factory](https://doc.ibexa.co/en/latest/guide/multisite/site_factory).
For more information see developer documentation on [Site Factory]([[= developer_doc =]]/guide/multisite/site_factory/).

## Creating a site

Expand All @@ -33,7 +33,7 @@
The path can be only one directory deep.
Do not use paths that have more than one element, for example, `/en/articles`.

For more information about SiteAccesses, see [Multisite](https://doc.ibexa.co/en/latest/guide/multisite/multisite).
For more information about SiteAccesses, see [Multisite]([[= developer_doc =]]/guide/multisite/multisite/).

![Create a new site step two](img/site_factory_new_site_step_2.png)

Expand All @@ -42,7 +42,7 @@
!!! note

A SiteAccess that you create in Site Factory is always treated with lower
priority than a SiteAccess defined by the administrator as part of [configuration](https://doc.ibexa.co/en/latest/guide/multisite/multisite_configuration/#siteaccess-configuration).
priority than a SiteAccess defined by the administrator as part of [configuration]([[= developer_doc =]]/guide/multisite/multisite_configuration/#siteaccess-configuration).

Check warning on line 45 in docs/site_organization/site_factory.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/site_organization/site_factory.md#L45

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/site_organization/site_factory.md", "range": {"start": {"line": 45, "column": 177}}}, "severity": "WARNING"}
For example, if you create a site that uses the `fr` path in Site Factory, and the administrator
defines a French site manually in configuration files, your site is ignored by the system.

Expand Down
6 changes: 3 additions & 3 deletions docs/site_organization/working_with_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
You can reorder them at any time by dragging and dropping them in the desired location.

[[= product_name_ee =]] comes with a set of ready-to-use Page blocks,
but [developers can add their own](https://doc.ibexa.co/en/latest/guide/page/create_custom_page_block/).
but [developers can add their own]([[= developer_doc =]]/guide/page/create_custom_page_block/).

![Elements menu](img/elements_menu.png "Elements menu")

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

To present two or more identical forms on one Page, ask your developer to create several identical form blocks that you can then use. Otherwise you may encounter issues with duplicate data submission.

For more information about creating form blocks, see [Creating a newsletter form](https://doc.ibexa.co/en/3.3/tutorials/enterprise_beginner/5_create_newsletter_form/#add-a-form-block) in developer documentation.
For more information about creating form blocks, see [Creating a newsletter form]([[= developer_doc =]]/tutorials/enterprise_beginner/5_create_newsletter_form/#add-a-form-block) in developer documentation.

### Code block

Expand Down Expand Up @@ -266,7 +266,7 @@
a user has to delete these blocks from the Landing Page.

!!! caution "Add new blocks"
If a [developer creates a new block](https://doc.ibexa.co/en/latest/guide/page/create_custom_page_block/) and you want to make it available
If a [developer creates a new block]([[= developer_doc =]]/guide/page/create_custom_page_block/) and you want to make it available

Check warning on line 269 in docs/site_organization/working_with_page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/site_organization/working_with_page.md#L269

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/site_organization/working_with_page.md", "range": {"start": {"line": 269, "column": 135}}}, "severity": "WARNING"}
in the editor mode, you must select it manually in the **Select page blocks** section.

## Configure preferred edit mode
Expand Down
2 changes: 1 addition & 1 deletion docs/translating_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ After adding a language, you may have to reload the application to be able to us
However, depending on the way your website is set up, additional configuration may be necessary
for the new language to work properly, especially with SiteAccesses.
It is recommended you contact your administrator and inform them if you need to add a new language to the website
(see [the technical documentation on language versions](https://doc.ibexa.co/en/master/guide/internationalization/)).
(see [the technical documentation on language versions]([[= developer_doc =]]/guide/internationalization/)).

## SiteAccess in Page mode [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]

Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ extra:
product_name_oss: 'Ibexa OSS'
product_name_dam: 'Ibexa DAM'

developer_doc: 'https://doc.ibexa.co/en/3.3'

extra_css:
- fonts/MavenPro.css
- css/codehilite.css
Expand Down