Skip to content

Commit 4f47ed0

Browse files
weaverryanweaverryan
committed
minor #1277 [Docs] Add caution alert when bundle require StimulusBundle (ker0x)
This PR was merged into the 2.x branch. Discussion ---------- [Docs] Add caution alert when bundle require StimulusBundle | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Issues | To complement #1276 | License | MIT This PR add a `caution` alert at the beginning of `Installation` section for all bundle requiring StimulusBundle Commits ------- 743d44a [Docs] Add caution alert when bundle require StimulusBundle
2 parents 8801ac1 + 743d44a commit 4f47ed0

File tree

15 files changed

+62
-30
lines changed

15 files changed

+62
-30
lines changed

‎src/Autocomplete/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ into an Ajax-powered autocomplete smart UI control (leveraging `Tom Select`_):
1212
Installation
1313
------------
1414

15-
Before you start, make sure you have `StimulusBundle configured in your app`_.
15+
.. caution::
16+
17+
Before you start, make sure you have `StimulusBundle configured in your app`_.
1618

17-
Then install the bundle using Composer and Symfony Flex:
19+
Install the bundle using Composer and Symfony Flex:
1820

1921
.. code-block:: terminal
2022

‎src/Chartjs/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ It is part of `the Symfony UX initiative`_.
88
Installation
99
------------
1010

11-
Before you start, make sure you have `StimulusBundle configured in your app`_.
11+
.. caution::
1212

13-
Then install the bundle using Composer and Symfony Flex:
13+
Before you start, make sure you have `StimulusBundle configured in your app`_.
14+
15+
Install the bundle using Composer and Symfony Flex:
1416

1517
.. code-block:: terminal
1618

‎src/Cropperjs/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ Symfony UX Cropper.js is a Symfony bundle integrating the
88
Installation
99
------------
1010

11-
Before you start, make sure you have `StimulusBundle configured in your app`_.
11+
.. caution::
1212

13-
Then, install this bundle using Composer and Symfony Flex:
13+
Before you start, make sure you have `StimulusBundle configured in your app`_.
14+
15+
Install the bundle using Composer and Symfony Flex:
1416

1517
.. code-block:: terminal
1618

‎src/Dropzone/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ having to browse their computer for a file.
1010
Installation
1111
------------
1212

13-
Before you start, make sure you have `StimulusBundle configured in your app`_.
13+
.. caution::
1414

15-
Then, install this bundle using Composer and Symfony Flex:
15+
Before you start, make sure you have `StimulusBundle configured in your app`_.
16+
17+
Install the bundle using Composer and Symfony Flex:
1618

1719
.. code-block:: terminal
1820

‎src/LazyImage/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ It provides two key features:
1212
Installation
1313
------------
1414

15-
Before you start, make sure you have `StimulusBundle configured in your app`_.
15+
.. caution::
1616

17-
Then install this bundle using Composer and Symfony Flex:
17+
Before you start, make sure you have `StimulusBundle configured in your app`_.
18+
19+
Install the bundle using Composer and Symfony Flex:
1820

1921
.. code-block:: terminal
2022

‎src/LiveComponent/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,11 @@ Want some demos? Check out https://ux.symfony.com/live-component#demo
7272
Installation
7373
------------
7474

75-
Before you start, make sure you have `StimulusBundle configured in your app`_.
75+
.. caution::
76+
77+
Before you start, make sure you have `StimulusBundle configured in your app`_.
7678

77-
Now install the library with:
79+
Install the bundle using Composer and Symfony Flex:
7880

7981
.. code-block:: terminal
8082

‎src/Notify/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ in Symfony applications using `Mercure`_. It is part of `the Symfony UX initiati
77
Installation
88
------------
99

10-
Before you start, make sure you have `StimulusBundle configured in your app`_.
10+
.. caution::
1111

12-
Then, install this bundle using Composer and Symfony Flex:
12+
Before you start, make sure you have `StimulusBundle configured in your app`_.
13+
14+
Install the bundle using Composer and Symfony Flex:
1315

1416
.. code-block:: terminal
1517

‎src/React/doc/index.rst‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,11 @@ Installation
1818
This package works best with WebpackEncore. To use it with AssetMapper, see
1919
:ref:`Using with AssetMapper <using-with-asset-mapper>`.
2020

21-
Before you start, make sure you have `StimulusBundle configured in your app`_.
22-
Then install the bundle using Composer and Symfony Flex:
21+
.. caution::
22+
23+
Before you start, make sure you have `StimulusBundle configured in your app`_.
24+
25+
Install the bundle using Composer and Symfony Flex:
2326

2427
.. code-block:: terminal
2528

‎src/Svelte/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@ Installation
1818
This package works best with WebpackEncore. To use it with AssetMapper, see
1919
:ref:`Using with AssetMapper <using-with-asset-mapper>`.
2020

21-
Before you start, make sure you have `StimulusBundle configured in your app`_.
21+
.. caution::
2222

23-
Then install the bundle using Composer and Symfony Flex:
23+
Before you start, make sure you have `StimulusBundle configured in your app`_.
24+
25+
Install the bundle using Composer and Symfony Flex:
2426

2527
.. code-block:: terminal
2628

‎src/Swup/doc/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ bringing the complexity of a React/Vue/Angular application.
1212
Installation
1313
------------
1414

15-
Before you start, make sure you have `StimulusBundle configured in your app`_.
15+
.. caution::
1616

17-
Then install the bundle using Composer and Symfony Flex:
17+
Before you start, make sure you have `StimulusBundle configured in your app`_.
18+
19+
Install the bundle using Composer and Symfony Flex:
1820

1921
.. code-block:: terminal
2022

0 commit comments

Comments
 (0)