Skip to content

Commit 2b9027d

Browse files
committed
Merge branch 'master' of ssh://github.com/laboro/dev into feature/BAP-21264_es8
2 parents 4d3a874 + b94ce72 commit 2b9027d

File tree

144 files changed

+1814
-978
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+1814
-978
lines changed

api/authentication/index.rst

+8
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,11 @@ Out-of-the-box, OroPlatform provides the following authentication mechanism:
1919

2020
Please note that WSSE authentication is deprecated and will be removed in one of the future LTS releases.
2121
Use :ref:`OAuth authentication<web-services-api--authentication--oauth>` instead.
22+
23+
24+
.. admonition:: Business Tip
25+
26+
Looking to make a digital commerce investment? Evaluate the |best B2B eCommerce platforms| on our comparison page.
27+
28+
.. include:: /include/include-links-seo.rst
29+
:start-after: begin

api/authentication/oauth-client-credentials.rst

+9
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,12 @@ An example of an API request:
7272
Authorization: Bearer your access token
7373
7474
.. note:: Access tokens for back-office and storefront API are not interchangeable. If you attempt to request data for the storefront API with a token generated for the back-office application, access will be denied.
75+
76+
77+
.. admonition:: Business Tip
78+
79+
|What is B2B eCommerce| and how does it differ from B2C? Read our guide to find out.
80+
81+
82+
.. include:: /include/include-links-seo.rst
83+
:start-after: begin

api/authentication/oauth.rst

+8
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,13 @@ Generate Tokens
4747
to the storefront API resources is enabled automatically.
4848

4949

50+
.. admonition:: Business Tip
51+
52+
Want to take advantage of the new digital commerce trend? Check out everything you need to know about a |B2B wholesale marketplace|.
53+
54+
5055
.. include:: /include/include-links-dev.rst
5156
:start-after: begin
57+
58+
.. include:: /include/include-links-seo.rst
59+
:start-after: begin

api/enabling-api-feature.rst

+8
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,13 @@ on the :ref:`global <admin-configuration-application>` and :ref:`organization <a
1414
on the :ref:`global <admin-configuration-application>`, :ref:`organization <admin-configuration-application-org>`, and :ref:`website <admin-configuration-application-website>` levels.
1515

1616

17+
.. admonition:: Business Tip
18+
19+
Explore our guide on eCommerce to find out |B2B ecommerce meaning|, benefits, and examples.
20+
21+
1722
.. include:: /include/include-images.rst
1823
:start-after: begin
24+
25+
.. include:: /include/include-links-seo.rst
26+
:start-after: begin

api/http-methods.rst

+10
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,11 @@ Below is a table summarizing HTTP methods by its idempotency and safety:
6363
+-------------+------------+------+
6464

6565

66+
.. admonition:: Business Tip
67+
68+
Researching |B2B eCommerce platforms|? Explore our platform comparison guide to help you make an informed decision.
69+
70+
6671
.. _web-services-api--http-methods--get:
6772

6873
GET
@@ -130,8 +135,13 @@ On successful deletion, the HTTP response status code 204 (No Content) returns w
130135
If you DELETE a resource, it is removed. Repeatedly calling DELETE on that resource will often return a 404 (NOT FOUND) status code since it was already removed and, therefore, is no longer findable.
131136

132137

138+
139+
133140
.. include:: /include/include-links-dev.rst
134141
:start-after: begin
135142

136143
.. include:: /include/include-images.rst
137144
:start-after: begin
145+
146+
.. include:: /include/include-links-seo.rst
147+
:start-after: begin

api/index.rst

+12
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,21 @@ Find more information about Web API in the following topics:
5353

5454
The documentation for the server-side developers can be found in :ref:`API Developer Guide <web-api>`.
5555

56+
57+
.. admonition:: Business Tip
58+
59+
Looking for the |open source B2B eCommerce platform| that can meet your business needs? Make sure to check our comprehensive platform comparison page.
60+
61+
62+
63+
64+
5665
.. include:: /include/include-links-dev.rst
5766
:start-after: begin
5867

68+
.. include:: /include/include-links-seo.rst
69+
:start-after: begin
70+
5971
.. toctree::
6072
:hidden:
6173

backend/api/batch-api.rst

+9
Original file line numberDiff line numberDiff line change
@@ -129,5 +129,14 @@ The following example shows how to reconfigure this adapter to use a local files
129129
You can find more examples in |KnpGaufretteBundle documentation|.
130130

131131

132+
133+
.. admonition:: Business Tip
134+
135+
Explore our guide to learn how |digital transformation in manufacturing industry| improves operations, customer experiences, and sales.
136+
137+
132138
.. include:: /include/include-links-dev.rst
139+
:start-after: begin
140+
141+
.. include:: /include/include-links-seo.rst
133142
:start-after: begin

backend/api/how-to.rst

+9
Original file line numberDiff line numberDiff line change
@@ -1299,5 +1299,14 @@ a new ``Acme\Bundle\DemoBundle\Entity\SomeEntity`` entity:
12991299
- { name: oro.api.processor, action: customize_form_data, event: post_submit, class: Acme\Bundle\DemoBundle\Entity\SomeEntity }
13001300
13011301
1302+
.. admonition:: Business Tip
1303+
1304+
Do you want to get started with |digitalization in manufacturing|? Explore our guide for essential tips, best practices, and success stories.
1305+
1306+
1307+
.. include:: /include/include-links-seo.rst
1308+
:start-after: begin
1309+
1310+
13021311
.. include:: /include/include-links-dev.rst
13031312
:start-after: begin

backend/architecture/bundle-less-structure.rst

+25-22
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,23 @@
66
.. _dev-backend-architecture-bundle-less-structure:
77

88
Bundle-less Structure
9-
======================
9+
=====================
1010

11-
You can organize an OroPlatform based application code within :ref:`Symfony bundles <how-to-create-new-bundle>` or plain directories. Bundle-less directory structure support was added in OroPlatform v5.1 to follow the Symfony best practices and lower the entry level for new developers.
11+
You can organize an OroPlatform-based application code within :ref:`Symfony bundles <how-to-create-new-bundle>` or plain directories. Bundle-less directory structure support was added to OroPlatform v5.1 to follow the Symfony best practices and lower the entry level for new developers.
1212
This guide overviews the bundle-less structure and explains how to migrate the application code from the bundles-based to bundle-less structure.
1313

14-
.. note:: The use of **bundle-less structure** is optional. However, for individual customization and expansion of Oro functionality or in other cases when creation a new bundle is impractical, a bundle-less structure can be used.
14+
.. note:: The use of **bundle-less structure** is optional. However, you can use a bundle-less structure for individual customization and expansion of Oro functionality or when creating a new bundle is impractical.
1515

16-
The *bundle-less structure* includes the following (configuration and directory structure changes) application structure changes.
16+
The *bundle-less structure* includes the application structure changes outlined below (configuration and directory).
1717

18-
Application-level structure Changes
18+
Application-level Structure Changes
1919
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2020

2121
.. code-block:: none
2222
23-
2423
oro-application/
2524
├── assets/
26-
| |── your-assets-dir # Here we can store our (scss, js, image, fonts) resources.
25+
| |── your-assets-dir # Here we can store the (scss, js, image, fonts) resources.
2726
| └── ...
2827
├── config/
2928
│ ├── batch_jobs # Import and Export Configuration.
@@ -131,7 +130,7 @@ Application-level structure Changes
131130
Moving Existing Bundle to Bundle-less Structure
132131
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133132

134-
In order to port an existing bundle to a bundle-less structure, you must update the directory structure to the one shown above. There is no automatic tool for this update, so you must move your code following these guidelines:
133+
To port an existing bundle to a bundle-less structure, you must update the directory structure to the one shown above. There is no automatic tool for this update, so you must move your code following these guidelines:
135134

136135
Migrations
137136
""""""""""
@@ -263,7 +262,7 @@ Workflows
263262
264263
{BundleDir}/Resources/config/oro/workflows.yml -> config/oro/workflows/workflows.yml
265264
266-
.. important:: All application-level workflows can be stored in separate directories, but must be registered in the /config/oro/workflows.yml file (via an import directive).
265+
.. important:: All application-level workflows can be stored in separate directories but must be registered in the /config/oro/workflows.yml file (via an import directive).
267266

268267

269268
Processes
@@ -376,7 +375,7 @@ System Configurations
376375
Extension and Configuration Moving
377376
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
378377

379-
1. Create Extension and Configuration classes in ``/src/Configuration``
378+
1. Create Extension and Configuration classes in ``/src/Configuration``.
380379

381380
.. code-block:: php
382381
@@ -400,7 +399,7 @@ Extension and Configuration Moving
400399
}
401400
}
402401
403-
2. Register the extension in ``AppKernel::build``
402+
2. Register the extension in ``AppKernel::build``.
404403

405404
.. code-block:: php
406405
@@ -415,19 +414,23 @@ Extension and Configuration Moving
415414
Themes & Layouts
416415
~~~~~~~~~~~~~~~~
417416

418-
1. Assets for themes should be moved to ``/src/assets/{your_theme_dir}/``
417+
1. Assets for themes should be moved to ``/src/assets/{your_theme_dir}/``.
419418
2. Admin theme configuration:
420-
- ``/config/oro/assets.yml``
421-
- ``/config/oro/jsmodules.yml``
422-
3. Storefront Themes and layouts should be placed in ``/templates/layouts/{your_theme_dir}/``
423-
- Themes configuration: ``/templates/layouts/{your_theme_dir}/theme.yml``
424-
- Layout assets configuration: ``/templates/layouts/{your_theme_dir}/config/assets.yml``
425-
- Layout theme configuration: ``/templates/layouts/{your_theme_dir}/config/config.yml``
419+
420+
- ``/config/oro/assets.yml``
421+
- ``/config/oro/jsmodules.yml``
422+
423+
3. Storefront Themes and layouts should be placed in ``/templates/layouts/{your_theme_dir}/``.
424+
425+
- Themes configuration: ``/templates/layouts/{your_theme_dir}/theme.yml``
426+
- Layout assets configuration: ``/templates/layouts/{your_theme_dir}/config/assets.yml``
427+
- Layout theme configuration: ``/templates/layouts/{your_theme_dir}/config/config.yml``
426428

427429
Tests
428430
~~~~~
429431

430-
1. Unit tests should be placed in ``/src/Test/Unit/``
431-
2. Functional tests should be placed in ``/src/Test/Functional/``
432-
3. Behat tests should be placed in ``/src/Test/Behat/``
433-
- configuration for Behat services: ``/config/oro/behat_services.yml``
432+
1. Unit tests should be placed in ``/src/Test/Unit/``.
433+
2. Functional tests should be placed in ``/src/Test/Functional/``.
434+
3. Behat tests should be placed in ``/src/Test/Behat/``.
435+
436+
- Configuration for Behat services: ``/config/oro/behat_services.yml``

backend/architecture/custom-application.rst

+21-29
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,32 @@
77
Custom Oro Application
88
======================
99

10-
No two businesses are alike. This motto is part of Oro products philosophy and this is why flexibility is one of
11-
the key principles that drive architecture in Oro. Depending on what you are planning to build, you can
10+
No two businesses are alike. This motto is part of Oro's product philosophy, which is why flexibility is one of
11+
the fundamental principles driving architecture. Depending on what you are planning to build, you can
1212
create your custom application with minimum functions starting either with |OroPlatform|, or |OroCRM|, or
1313
|OroCommerce| application as a baseline. No matter what is your starting point, there is no difference
1414
in the customization process.
1515

1616
Application Repository and Installation
1717
---------------------------------------
1818

19-
Before you start working on a new project, it is important to have version control system in place.
19+
Before you start working on a new project, it is essential to have a version control system in place.
2020
The easiest way to start is to |fork application repository| of |OroPlatform|, |OroCRM| or |OroCommerce| on GitHub.
2121

2222
Once code repository is ready, please follow :ref:`installation <installation>` instructions.
2323

2424
.. note::
2525

26-
Newly created application repository should be used instead of the |https://github.com/orocrm/crm-application.git|
26+
A newly created application repository should be used instead of the |https://github.com/orocrm/crm-application.git|
2727

28-
When your application is up and running, you can use development mode to work on customizations. In order to warm up the
29-
application cache in development mode please run:
28+
You can use development mode to work on customizations when your application is up and running. To warm up the
29+
application cache in development mode, please run:
3030

3131
.. code-block:: none
3232
3333
php bin/console cache:clear --env=dev
3434
35-
To access application in development mode, add `index_dev.php` to the base URL
35+
To access the application in development mode, add `index_dev.php` to the base URL
3636
(example: ``http://orocrm.example.com/index_dev.php``).
3737

3838
.. _application-custom-code:
@@ -41,46 +41,38 @@ Application Custom Code
4141
-----------------------
4242

4343
Oro application structure is based on |Symfony Standard Edition| and we highly recommend to follow
44-
|Symfony Best Practices| for any custom application that you build on top of OroPlatform, OroCRM, or OroCommerce.
44+
|Symfony Best Practices| for any custom application you build on top of OroPlatform, OroCRM, or OroCommerce.
4545

4646
In the root folder of your application, there is an `src` folder. Use it as a working directory
47-
for your custom project and put your custom code there. Like in Symfony applications, all custom code in Oro application
47+
for your custom project and put your custom code there. Like in Symfony applications, all custom code in the Oro application
4848
is organized in bundles - modules that group application functionality (see |Symfony Bundle System| for best practice
4949
of module structure and design).
5050

5151
.. note::
52-
Please note that Oro application has several :ref:`differences <book_differences>` compared to
52+
Please note that the Oro application has several :ref:`differences <book_differences>` compared to
5353
Symfony Standard Edition.
5454

55-
Typically, to create a custom application you may follow the common steps:
55+
Typically, to create a custom application you may follow the typical steps:
5656

57-
#) :ref:`Create a bundle <how-to-create-new-bundle>`
58-
#) Introduce :ref:`new entity <dev-entities>` types that represent your business data structure and add
59-
related features
60-
#) :ref:`Customize <architecture--customization--customize>` existing functionality
61-
(:ref:`menu <doc-create-and-customize-app-menu>`, :ref:`workflow <dev-doc--workflows>`,
62-
:ref:`extend entities <book-entities-extended-entities>` etc.)
57+
#) :ref:`Create a bundle <how-to-create-new-bundle>`.
58+
#) Introduce :ref:`new entity <dev-entities>` types that represent your business data structure and add related features.
59+
#) :ref:`Customize <architecture--customization--customize>` existing functionality (:ref:`menu <doc-create-and-customize-app-menu>`, :ref:`workflow <dev-doc--workflows>`, :ref:`extend entities <book-entities-extended-entities>`, etc.).
6360

6461
Application Deployment
6562
----------------------
6663

67-
Oro applications are open source and may be deployed to the on-premise environments. Deployment method could be
68-
different depending on organization requirements and infrastructure. You can design your custom deployment process,
69-
noting the following recommendations:
64+
Oro applications are open source and can be deployed to on-premise environments. Deployment methods can vary depending on organization requirements and infrastructure. You can design your custom deployment process but make sure you follow the recommendations below:
7065

71-
#) Take into account recommendations in |Symfony Application Deployment| documentation
72-
#) Lock all dependencies with |composer.lock| before taking the code to production
73-
#) Warm up the application cache in production mode
74-
#) Disable access to `index_dev.php`
75-
#) Configure crontab and run web socket server
66+
#) Follow the advice outlined in the |Symfony Application Deployment| documentation.
67+
#) Lock all dependencies with |composer.lock| before taking the code to production.
68+
#) Warm up the application cache in production mode.
69+
#) Disable access to `index_dev.php`.
70+
#) Configure crontab and run web socket server.
7671

7772
Oro applications are scalable.
7873

7974
.. note::
80-
As an alternative to the on-premise deployment, when you created your application following recommendations
81-
:ref:`above <application-custom-code>`, you can put your application into |OroCloud|. Please contact us to
82-
get more information.
83-
75+
As an alternative to the on-premise deployment, when you create your application following recommendations :ref:`above <application-custom-code>`, you can deploy your application to |OroCloud|. Please get in touch with us for more information.
8476

8577
Related Articles
8678
----------------

0 commit comments

Comments
 (0)