8000 minor #9961 Removed the full config dumps from config reference artic… · symfony/symfony-docs@942d9c7 · GitHub
[go: up one dir, main page]
Skip to content

Commit 942d9c7

Browse files
javiereguiluzjaviereguiluz
committed
minor #9961 Removed the full config dumps from config reference articles (javiereguiluz)
This PR was squashed before being merged into the 2.8 branch (closes #9961). Discussion ---------- Removed the full config dumps from config reference articles This was discussed in the internal Slack chat used by doc maintainers. We think this config dump is not really useful for readers and it complicates maintenance. I also changed some page titles to make them more human and SEO friendly. Commits ------- a2ecdc7 Removed the full config dumps from config reference articles
2 parents ecef059 + a2ecdc7 commit 942d9c7

File tree

9 files changed

+124
-1047
lines changed

9 files changed

+124
-1047
lines changed

‎reference/configuration/assetic.rst

Lines changed: 8 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,17 @@
11
.. index::
22
pair: Assetic; Configuration reference
33

4-
AsseticBundle Configuration ("assetic")
5-
=======================================
4+
Assetic Configuration Reference (AsseticBundle)
5+
===============================================
66

77
.. include:: /assetic/_standard_edition_warning.rst.inc
88

9-
Full Default Configuration
10-
--------------------------
9+
You can get the full Asstic configuration reference as follows:
1110

12-
.. configuration-block::
11+
.. code-block:: terminal
1312
14-
.. code-block:: yaml
13+
# displays the default config values defined by Symfony
14+
$ php bin/console config:dump-reference assetic
1515
16-
# app/config/config.yml
17-
assetic:
18-
debug: '%kernel.debug%'
19-
use_controller:
20-
enabled: '%kernel.debug%'
21-
profiler: false
22-
read_from: '%assetic.read_from%'
23-
write_to: '%kernel.root_dir%/../web'
24-
java: /usr/bin/java
25-
node: /usr/bin/node
26-
ruby: /usr/bin/ruby
27-
sass: /usr/bin/sass
28-
# An key-value pair of any number of named elements
29-
variables:
30-
some_name: []
31-
bundles:
32-
33-
# Defaults (all currently registered bundles):
34-
- FrameworkBundle
35-
- SecurityBundle
36-
- TwigBundle
37-
- MonologBundle
38-
- SwiftmailerBundle
39-
- DoctrineBundle
40-
- AsseticBundle
41-
- ...
42-
assets:
43-
# An array of named assets (e.g. some_asset, some_other_asset)
44-
some_asset:
45-
inputs: []
46-
filters: []
47-
options:
48-
# A key-value array of options and values
49-
some_option_name: []
50-
filters:
51-
52-
# An array of named filters (e.g. some_filter, some_other_filter)
53-
some_filter: []
54-
workers:
55-
# see https://github.com/symfony/AsseticBundle/pull/119
56-
# Cache can also be busted via the framework.assets.version
57-
# setting - see the "framework" configuration section
58-
cache_busting:
59-
enabled: false
60-
twig:
61-
functions:
62-
# An array of named functions (e.g. some_function, some_other_function)
63-
some_function: []
64-
65-
.. code-block:: xml
66-
67-
<!-- app/config/config.xml -->
68-
<?xml version="1.0" encoding="UTF-8"?>
69-
<container xmlns="http://symfony.com/schema/dic/services"
70-
xmlns:assetic="http://symfony.com/schema/dic/assetic"
71-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
72-
xsi:schemaLocation="http://symfony.com/schema/dic/services
73-
http://symfony.com/schema/dic/services/services-1.0.xsd
74-
http://symfony.com/schema/dic/assetic
75-
http://symfony.com/schema/dic/assetic/assetic-1.0.xsd">
76-
77-
<assetic:config
78-
debug="%kernel.debug%"
79-
use-controller="%kernel.debug%"
80-
read-from="%assetic.read_from%"
81-
write-to="%kernel.root_dir%/../web"
82-
java="/usr/bin/java"
83-
node="/usr/bin/node"
84-
sass="/usr/bin/sass">
85-
86-
<!-- Defaults (all currently registered bundles) -->
87-
<assetic:bundle>FrameworkBundle</assetic:bundle>
88-
<assetic:bundle>SecurityBundle</assetic:bundle>
89-
<assetic:bundle>TwigBundle</assetic:bundle>
90-
<assetic:bundle>MonologBundle</assetic:bundle>
91-
<assetic:bundle>SwiftmailerBundle</assetic:bundle>
92-
<assetic:bundle>DoctrineBundle</assetic:bundle>
93-
<assetic:bundle>AsseticBundle</assetic:bundle>
94-
<assetic:bundle>...</assetic:bundle>
95-
96-
<assetic:asset>
97-
<!-- prototype -->
98-
<assetic:name>
99-
<assetic:input />
100-
101-
<assetic:filter />
102-
103-
<assetic:option>
104-
<!-- prototype -->
105-
<assetic:name />
106-
</assetic:option>
107-
</assetic:name>
108-
</assetic:asset>
109-
110-
<assetic:filter>
111-
<!-- prototype -->
112-
<assetic:name />
113-
</assetic:filter>
114-
115-
<assetic:twig>
116-
<assetic:functions>
117-
<!-- prototype -->
118-
<assetic:name />
119-
</assetic:functions>
120-
</assetic:twig>
121-
</assetic:config>
122-
</container>
16+
# displays the actual config values used by your application
17+
$ php bin/console debug:config assetic

‎reference/configuration/debug.rst

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
11
.. index::
22
single: Configuration reference; Framework
33

4-
DebugBundle Configuration ("debug")
5-
===================================
4+
Debug Configuration Reference (DebugBundle)
5+
===========================================
66

7-
The DebugBundle allows greater integration of the
8-
:doc:`VarDumper component </components/var_dumper>` in the
9-
Symfony full-stack framework and can be configured under the ``debug`` key
10-
in your application configuration. When using XML, you must use the
11-
``http://symfony.com/schema/dic/debug`` namespace.
7+
The DebugBundle integrates the :doc:`VarDumper component </components/var_dumper>`
8+
in Symfony applications. All these options are configured under the ``debug``
9+
key in your application configuration.
1210

13-
.. tip::
11+
.. code-block:: terminal
1412
15-
The XSD schema is available at
16-
``http://symfony.com/schema/dic/debug/debug-1.0.xsd``.
13+
# displays the default config values defined by Symfony
14+
$ php app/console config:dump-reference debug
15+
16+
# displays the actual config values used by your application
17+
$ php app/console debug:config debug
18+
19+
.. note::
20+
21+
When using XML, you must use the ``http://symfony.com/schema/dic/debug``
22+
namespace and the related XSD schema is available at:
23+
``http://symfony.com/schema/dic/debug/debug-1.0.xsd``
1724

1825
Configuration
1926
-------------

0 commit comments

Comments
 (0)
0