Skip to content

Commit 448072e

Browse files
committedFeb 10, 2025·
minor #6801 [Doc] Clarify that AdminDashboard only works for pretty URLs (javiereguiluz)
This PR was merged into the 4.x branch. Discussion ---------- [Doc] Clarify that AdminDashboard only works for pretty URLs Fixes #6782. Commits ------- d704291 [Doc] Clarify that AdminDashboard only works for pretty URLs
2 parents b74f56c + d704291 commit 448072e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed
 

‎doc/dashboards.rst

+11
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,11 @@ Legacy Admin URLs
175175
If you are using :ref:`pretty admin URLs <pretty-admin-urls>` in your application,
176176
you can skip this section entirely.
177177

178+
.. caution::
179+
180+
Legacy admin URLs are deprecated and will no longer work in EasyAdmin 5.0.
181+
Upgrade your application to use :ref:`pretty URLs <pretty-admin-urls>`.
182+
178183
Before the introduction of :ref:`pretty admin URLs <pretty-admin-urls>`, EasyAdmin
179184
used a single Symfony route to serve all dashboard URLs. The needed information
180185
is passed using query string parameters. If you generated the dashboard with the
@@ -230,6 +235,12 @@ or PHP attributes (if the project requires PHP 8 or newer).
230235
// ...
231236
}
232237
238+
.. caution::
239+
240+
In backends that don't use :ref:`pretty URLs <pretty-admin-urls>`, the ``Route``
241+
annotation/attribute is the only recommended way to configure the dashboard route.
242+
The ``#[AdminDashboard]`` attribute doesn't work with traditional (ugly) URLs.
243+
233244
.. note::
234245

235246
Since ``index()`` is part of the Dashboard interface, you cannot add arguments

0 commit comments

Comments
 (0)
Please sign in to comment.