Skip to content

Commit

Permalink
minor #1277 [Docs] Add caution alert when bundle require StimulusBund…
Browse files Browse the repository at this point in the history
…le (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
  • Loading branch information
weaverryan committed Dec 12, 2023
2 parents 8801ac1 + 743d44a commit 4f47ed0
Show file tree
Hide file tree
Showing 15 changed files with 62 additions and 30 deletions.
6 changes: 4 additions & 2 deletions src/Autocomplete/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ into an Ajax-powered autocomplete smart UI control (leveraging `Tom Select`_):
Installation
------------

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

Before you start, make sure you have `StimulusBundle configured in your app`_.

Then install the bundle using Composer and Symfony Flex:
Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Chartjs/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ It is part of `the Symfony UX initiative`_.
Installation
------------

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

Then install the bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Cropperjs/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ Symfony UX Cropper.js is a Symfony bundle integrating the
Installation
------------

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

Then, install this bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Dropzone/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ having to browse their computer for a file.
Installation
------------

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

Then, install this bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/LazyImage/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ It provides two key features:
Installation
------------

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

Then install this bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/LiveComponent/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,11 @@ Want some demos? Check out https://ux.symfony.com/live-component#demo
Installation
------------

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

Before you start, make sure you have `StimulusBundle configured in your app`_.

Now install the library with:
Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Notify/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ in Symfony applications using `Mercure`_. It is part of `the Symfony UX initiati
Installation
------------

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

Then, install this bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
7 changes: 5 additions & 2 deletions src/React/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@ Installation
This package works best with WebpackEncore. To use it with AssetMapper, see
:ref:`Using with AssetMapper <using-with-asset-mapper>`.

Before you start, make sure you have `StimulusBundle configured in your app`_.
Then install the bundle using Composer and Symfony Flex:
.. caution::

Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Svelte/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ Installation
This package works best with WebpackEncore. To use it with AssetMapper, see
:ref:`Using with AssetMapper <using-with-asset-mapper>`.

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

Then install the bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Swup/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ bringing the complexity of a React/Vue/Angular application.
Installation
------------

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

Then install the bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/TogglePassword/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ It allows visitors to switch the type of password field to text and vice versa.
Installation
------------

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

Then, install this bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Translator/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@ Installation
This package works best with WebpackEncore. To use it with AssetMapper, see
:ref:`Using with AssetMapper <using-with-asset-mapper>`.

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

Install this bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Turbo/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ Or watch the `Turbo Screencast on SymfonyCasts`_.
Installation
------------

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

Install this bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
6 changes: 4 additions & 2 deletions src/Typed/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ Just enter the strings you want to see typed, and it goes live without complexit
Installation
------------

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

Then install the bundle using Composer and Symfony Flex:
Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down
7 changes: 5 additions & 2 deletions src/Vue/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@ Installation
This package works best with WebpackEncore. To use it with AssetMapper, see
:ref:`Using with AssetMapper <using-with-asset-mapper>`.

Before you start, make sure you have `StimulusBundle configured in your app`_.
Then install the bundle using Composer and Symfony Flex:
.. caution::

Before you start, make sure you have `StimulusBundle configured in your app`_.

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal
Expand Down

0 comments on commit 4f47ed0

Please sign in to comment.