8000 Merge pull request #837 from symfony-cmf/cleanups · torreytsui/symfony-cmf-docs@ae8a7fb · GitHub
[go: up one dir, main page]
Skip to content

Commit ae8a7fb

Browse files
wouterjwouterj
authored
Merge pull request symfony-cmf#837 from symfony-cmf/cleanups
update links, fix wording from Symfony2 to Symfony
2 parents 8e4cbdf + f8febdb commit ae8a7fb

36 files changed

+110
-137
lines changed

‎CONTRIBUTING.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,13 @@
11
Contributing
22
------------
33

4-
Symfony2 CMF is an open source, community-driven project. We follow the same
5-
guidelines as core Symfony2. If you'd like to contribute, please read the
4+
Symfony CMF is an open source, community-driven project. We follow the same
5+
guidelines as core Symfony. If you'd like to contribute, please read the
66
[Contributing Documentation][1] part of the documentation. If you're submitting a pull
7-
request, please make yourself comfortable with [the format][2], follow the
8-
guidelines in the [Creating a Pull Request][3] section and use the [Pull Request
9-
Format][4].
10-
11-
> :warning: **NOTE**
12-
> If you are documenting new features you should base your PR on the
13-
> **dev branch**, *not* the master branch.
7+
request, please make yourself comfortable with [the documentation format][2].
8+
The [Symfony documentation guide][3] can be helpful for you - just replace the
9+
repository names in the examples.
1410

1511
[1]: https://symfony.com/doc/current/contributing/documentation/index.html
1612
[2]: https://symfony.com/doc/current/contributing/documentation/format.html
17-
[3]: https://symfony.com/doc/current/contributing/documentation/overview.html#creating-a-pull-request
18-
[4]: https://symfony.com/doc/current/contributing/documentation/overview.html#pull-request-format
13+
[3]: https://symfony.com/doc/current/contributing/documentation/overview.html

‎bundles/block/cache.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ When using the Esi, Ssi or Js cache adapters, the settings passed here are remem
257257
.. code-block:: jinja
258258
259259
{{ sonata_block_render({ 'name': 'rssBlock' }, {
260-
'title': 'Symfony2 CMF news',
260+
'title': 'Symfony CMF news',
261261
'url': 'http://cmf.symfony.com/news.rss',
262262
'maxItems': 2
263263
}) }}
@@ -267,7 +267,7 @@ When using the Esi, Ssi or Js cache adapters, the settings passed here are remem
267267
<?php echo $view['blocks']->render(array(
268268
'name' => 'rssBlock',
269269
), array(
270-
'title' => 'Symfony2 CMF news',
270+
'title' => 'Symfony CMF news',
271271
'url' => 'http://cmf.symfony.com/news.rss',
272272
'maxItems' => 2,
273273
)) ?>

‎bundles/block/create_your_own_blocks.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,14 +236,14 @@ Example of how settings can be overwritten through a template helper:
236236
.. code-block:: jinja
237237
238238
{{ sonata_block_render({'name': 'rssBlock'}, {
239-
'title': 'Symfony2 CMF news',
239+
'title': 'Symfony CMF news',
240240
'url': 'http://cmf.symfony.com/news.rss'
241241
}) }}
242242
243243
.. code-block:: html+php
244244

245245
<?php $view['blocks']->render(array('name' => 'rssBlock'), array(
246-
'title' => 'Symfony2 CMF news',
246+
'title' => 'Symfony CMF news',
247247
'url' => 'http://cmf.symfony.com/news.rss',
248248
)) ?>
249249

‎bundles/block/types.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Create a document::
123123
$myRssBlock = new RssBlock();
124124
$myRssBlock->setParentDocument($parentPage);
125125
$myRssBlock->setName('rssBlock');
126-
$myRssBlock->setSetting('title', 'Symfony2 CMF news');
126+
$myRssBlock->setSetting('title', 'Symfony CMF news');
127127
$myRssBlock->setSetting('url', 'http://cmf.symfony.com/news.rss');
128128
$myRssBlock->setSetting('maxItems', 3);
129129

‎bundles/content/exposing_content_via_rest.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ for details.
146146

147147
.. _`FOSRestBundle`: https://github.com/FriendsOfSymfony/FOSRestBundle
148148
.. _`JMSSerializerBundle`: https://github.com/schmittjoh/JMSSerializerBundle
149-
.. _`FOSRestBundle view layer`: https://symfony.com/doc/master/bundles/FOSRestBundle/2-the-view-layer.html
149+
.. _`FOSRestBundle view layer`: https://symfony.com/doc/current/bundles/FOSRestBundle/2-the-view-layer.html
150150
.. _Composer: https://getcomposer.org/
151151
.. _`documentation of the JMS serializer`: http://jmsyst.com/libs/#serializer
152152
.. _`default response format changed between 1.0 and 1.1 of the ContentBundle`: https://github.com/symfony-cmf/content-bundle/pull/91

‎bundles/core/publish_workflow.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Publish Workflow
55
----------------
66

77
The publish workflow system allows to control what content is available on the
8-
site. This is similar to the `Symfony2 Security component`_. But contrary to the
8+
site. This is similar to the `Symfony Security component`_. But contrary to the
99
security context, the publish check can be executed even when no firewall is in
10-
place and the security context thus has no token (see `Symfony2 Authorization`_).
10+
place and the security context thus has no token (see `Symfony Authorization`_).
11< F42D code>11

1212
The publish workflow is also tied into the security workflow: The CoreBundle
1313
registers a security voter that forwards security checks to the publish
@@ -371,6 +371,6 @@ There is a :doc:`Sonata admin extension <../sonata_phpcr_admin_integration/core>
371371
available to edit workflow information on any document implementing the
372372
interface.
373373

374-
.. _`Symfony2 security component`: http://symfony.com/doc/current/components/security.html
375-
.. _`Symfony2 Authorization`: http://symfony.com/doc/current/components/security/authorization.html
374+
.. _`Symfony security component`: http://symfony.com/doc/current/components/security.html
375+
.. _`Symfony Authorization`: http://symfony.com/doc/current/components/security/authorization.html
376376
.. _`ACL checks`: http://symfony.com/doc/current/security/acl.html

‎bundles/create/introduction.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ CreateBundle
77

88
The CreateBundle provides modern front-end in-place editing for web
99
applications. It integrates create.js and the CreatePHP library into
10-
Symfony2.
10+
Symfony.
1111

1212
.. include:: ../_partials/unmaintained.rst.inc
1313

@@ -307,7 +307,7 @@ JavaScript loader check if the current user is granted the configured
307307
.. tip::
308308

309309
In order to have security in place, you need to configure a
310-
"Symfony2 firewall". Read more in the `Symfony2 security chapter`_.
310+
"Symfony firewall". Read more in the `Symfony security chapter`_.
311311
If you do not do that, create.js will not be loaded and editing
312312
will be disabled.
313313

@@ -363,8 +363,7 @@ after those to be able to customize as needed) with:
363363
Make sure Assetic is rewriting the paths in your CSS files properly or you
364364
might not see icon images.
365365

366-
In your page bottom area, load the JavaScript files. If you are using Symfony 2.2 or
367-
higher, the method reads:
366+
In your page bottom area, load the JavaScript files:
368367

369368
.. configuration-block::
370369

@@ -666,4 +665,4 @@ Read On
666665
.. _`symfony-cmf/create-bundle`: https://packagist.org/packages/symfony-cmf/create-bundle
667666
.. _`RDF`: https://en.wikipedia.org/wiki/Resource_Description_Framework
668667
.. _`RDFa`: https://en.wikipedia.org/wiki/RDFa
669-
.. _`Symfony2 security chapter`: https://symfony.com/doc/current/book/security.html
668+
.. _`Symfony security chapter`: https://symfony.com/doc/current/security.html

‎bundles/menu/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,5 +180,5 @@ Read On
180180
.. _`KnpMenu`: https://github.com/knplabs/KnpMenu
181181
.. _`KnpMenuBundle`: https://github.com/knplabs/KnpMenuBundle
182182
.. _`with composer`: https://getcomposer.org
183-
.. _`rendering menus`: https://symfony.com/doc/master/bundles/KnpMenuBundle/index.html#rendering-menus
183+
.. _`rendering menus`: https://symfony.com/doc/current/bundles/KnpMenuBundle/index.html#rendering-menus
184184
.. _`symfony-cmf/menu-bundle`: https://packagist.org/packages/symfony-cmf/menu-bundle

‎bundles/menu/menu_documents.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,4 @@ The standard menu node implements ``PublishTimePeriodInterface`` and
123123
The ``MenuContentVoter`` decides that a menu node is not published if the
124124
content it is pointing to is not published.
125125

126-
.. _`Creating Menus: The Basics`: https://github.com/KnpLabs/KnpMenu/blob/1.1.x/doc/01-Basic-Menus.markdown
126+
.. _`Creating Menus: The Basics`: https://github.com/KnpLabs/KnpMenu/blob/master/doc/01-Basic-Menus.markdown

‎bundles/menu/menu_provider.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ are not located under the menu basepath.
3333
You can also write your completely custom provider and register it with the
3434
KnpMenu as explained in the `KnpMenuBundle custom provider documentation`_.
3535

36-
.. _`KnpMenuBundle custom provider documentation`: https://symfony.com/doc/master/bundles/KnpMenuBundle/custom_provider.html
36+
.. _`KnpMenuBundle custom provider documentation`: https://symfony.com/doc/current/bundles/KnpMenuBundle/custom_provider.html

0 commit comments

Comments
 (0)
0