Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Commit aeab7bd

Browse files
dbudbu
authored
Merge pull request #793 from symfony-cmf/add-unmaintained-notice
add unmaintained notice to the bundles that are no longer maintained
2 parents 87a9a15 + 7a4b906 commit aeab7bd

25 files changed

+97
-33
lines changed

‎bundles/_partials/unmaintained.rst.inc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. note::
2+
3+
To focus our efforts onto a manageable number of packages, this package is
4+
currently *not* maintained. Security fixes and submitted bug fixes will
5+
still be released, but no new features should be expected. This bundle
6+
might have outdated documentation, there is no support from the CMF team
7+
and you should not expect bugs to be fixed.
8+
9+
If you want to help co-maintaining this package, tell us in a GitHub issue
10+
or in #symfony_cmf of the `Symfony devs slack`_.
11+
12+
.. _`Symfony devs slack`: https://slackinvite.me/to/symfony-devs

‎bundles/create/configuration.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Configuration Reference
22
=======================
33

4+
.. include:: ../_partials/unmaintained.rst.inc
5+
46
The CreateBundle can be configured under the ``cmf_create`` key in your
57
application configuration. When using XML you should use the
68
``http://cmf.symfony.com/schema/dic/create`` namespace.

‎bundles/create/developing-hallo.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Developing the Hallo Wysiwyg Editor
44
You can use the CreateBundle as a development testbed for the hallo.js
55
editor.
66

7+
.. include:: ../_partials/unmaintained.rst.inc
8+
79
A compiled and minimized version of `hallo.js`_ is bundled with create.js. To
810
develop the actual code, you will need to checkout the full
911
`hallo.js repository`_ first. You can do this by running the following command

‎bundles/create/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
CreateBundle
22
============
33

4+
.. include:: ../_partials/unmaintained.rst.inc
5+
46
.. toctree::
57
:maxdepth: 2
68

‎bundles/create/introduction.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ CreateBundle
99
applications. It integrates create.js and the CreatePHP library into
1010
Symfony2.
1111

12+
.. include:: ../_partials/unmaintained.rst.inc
13+
1214
The JavaScript library `create.js`_ provides a comprehensive web editing
1315
interface for Content Management Systems. It is designed to provide a modern,
1416
fully browser-based HTML5 environment for managing content. Create.js can be

‎bundles/create/other-editors.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Other Editors
55
your own template to load a different editor or customize one of the
66
existing editors is configured.
77

8+
.. include:: ../_partials/unmaintained.rst.inc
9+
810
.. _bundle-create-hallo:
911

1012
Using Hallo.js Editor

‎bundles/map.rst.inc

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,6 @@ library or they introduce a complete new concept.
2323
* :doc:`core/forms`
2424
* :doc:`core/configuration`
2525

26-
* :doc:`create/index`
27-
28-
* :doc:`create/introduction`
29-
* :doc:`create/other-editors`
30-
* :doc:`create/developing-hallo`
31-
* :doc:`create/configuration`
32-
33-
* :doc:`media/index`
34-
35-
* :doc:`media/introduction`
36-
* :doc:`media/form_types`
37-
* :doc:`media/adapters/index`
38-
* :doc:`media/configuration`
39-
4026
* :doc:`menu/index`
4127

4228
* :doc:`menu/introduction`
@@ -61,11 +47,6 @@ library or they introduce a complete new concept.
6147
* :doc:`routing_auto/conflict_resolvers`
6248
* :doc:`routing_auto/defunct_route_handlers`
6349

64-
* :doc:`search/index`
65-
66-
* :doc:`search/introduction`
67-
* :doc:`search/configuration`
68-
6950
* :doc:`seo/index`
7051

7152
* :doc:`seo/introduction`
@@ -103,15 +84,6 @@ bundle based on the key bundles.
10384
* :doc:`content/configuration`
10485
* :doc:`content/exposing_content_via_rest`
10586

106-
* :doc:`simple_cms/index`
107-
108-
* :doc:`simple_cms/introduction`
109-
* :doc:`simple_cms/multilang`
110-
* :doc:`simple_cms/rendering`
111-
* :doc:`simple_cms/menus`
112-
* :doc:`simple_cms/extending_page_class`
113-
* :doc:`simple_cms/configuration`
114-
11587
Contributed Bundles
11688
~~~~~~~~~~~~~~~~~~~
11789

@@ -128,4 +100,38 @@ help with integrating PHPCR concepts into the Symfony Framework.
128100
* :doc:`phpcr_odm/multiple_sessions`
129101
* :doc:`phpcr_odm/configuration`
130102

103+
Unmaintained Bundles
104+
~~~~~~~~~~~~~~~~~~~~
105+
106+
The following bundles were created for the CMF, but to focus our efforts on the
107+
core components, they are currently unmaintained.
108+
109+
* :doc:`create/index`
110+
111+
* :doc:`create/introduction`
112+
* :doc:`create/other-editors`
113+
* :doc:`create/developing-hallo`
114+
* :doc:`create/configuration`
115+
116+
* :doc:`media/index`
117+
118+
* :doc:`media/introduction`
119+
* :doc:`media/form_types`
120+
* :doc:`media/adapters/index`
121+
* :doc:`media/configuration`
122+
123+
* :doc:`search/index`
124+
125+
* :doc:`search/introduction`
126+
* :doc:`search/configuration`
127+
128+
* :doc:`simple_cms/index`
129+
130+
* :doc:`simple_cms/introduction`
131+
* :doc:`simple_cms/multilang`
132+
* :doc:`simple_cms/rendering`
133+
* :doc:`simple_cms/menus`
134+
* :doc:`simple_cms/extending_page_class`
135+
* :doc:`simple_cms/configuration`
136+
131137
.. _SonataDoctrinePHPCRAdminBundle: https://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/index.html

‎bundles/media/adapters/elfinder.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
elFinder
22
========
33

4+
.. include:: ../../_partials/unmaintained.rst.inc
5+
46
The media browser `elFinder`_ is integrated with Symfony using the
57
`FMElfinderBundle`_. The MediaBundle provides an adapter to use it with objects
68
implementing the MediaBundle interfaces.

‎bundles/media/adapters/gaufrette.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Gaufrette
22
=========
33

4+
.. include:: ../../_partials/unmaintained.rst.inc
5+
46
Gaufrette is a PHP5 library that provides a filesystem abstraction layer. The
57
MediaBundle provides an adapter to use it with objects implementing the
68
MediaBundle interfaces.

‎bundles/media/adapters/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Adapters
22
========
33

4+
.. include:: ../../_partials/unmaintained.rst.inc
5+
46
.. toctree::
57
:maxdepth: 2
68

‎bundles/media/adapters/liip_imagine.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
LiipImagine
22
===========
33

4+
.. include:: ../../_partials/unmaintained.rst.inc
5+
46
For LiipImagine, a data loader is included:
57
``Symfony\Cmf\Bundle\MediaBundle\Adapter\LiipImagine\CmfMediaDoctrineLoader``.
68
It will work for all image object implementing

‎bundles/media/configuration.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Configuration Reference
22
=======================
33

4+
.. include:: ../_partials/unmaintained.rst.inc
5+
46
The MediaBundle can be configured under the ``cmf_media`` key in your
57
application configuration. When using XML, you can use the
68
``http://cmf.symfony.com/schema/dic/media`` namespace.

‎bundles/media/form_types.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
Form Types
55
----------
66

7-
The MediaBundle provides a couple of useful form types along with form data
8-
transformers.
7+
The MediaBundle provides a couple of useful form types along with form data
8+
transformers.
9+
10+
.. include:: ../_partials/unmaintained.rst.inc
911

1012
.. caution::
1113

@@ -134,7 +136,7 @@ Then you can add images to document forms as follows::
134136
The document that should contain the ``Image`` document has to implement a
135137
setter method. To profit from the automatic guesser of the form layer, the
136138
name in the form element and this method name have to match. See
137-
`ImagineBlock::setImage`_ for an example implementation.
139+
`ImagineBlock::setImage <ImagineBlock_setImage>`_ for an example implementation.
138140

139141
To delete an image, you need to delete the document containing the image.
140142
(There is a proposal to improve the user experience for that in a
@@ -149,7 +151,7 @@ To delete an image, you need to delete the document containing the image.
149151
command or manually remove the imagine cache afterwards.
150152

151153
cmf_media_file
152-
~~~~~~~~~~~~~~~
154+
~~~~~~~~~~~~~~
153155

154156
.. versionadded: 1.3
155157
The ``cmf_media_file`` form type was introduced in MediaBundle 1.3.
@@ -161,5 +163,5 @@ file, if any.
161163

162164
.. _`LiipImagineBundle`: https://github.com/liip/LiipImagineBundle
163165
.. _`trying to make this automatic`: https://groups.google.com/forum/?fromgroups=#!topic/symfony2/CrooBoaAlO4
164-
.. _`ImagineBlock::setImage`: https://github.com/symfony-cmf/block-bundle/blob/master/Doctrine/Phpcr/ImagineBlock.php#L121
166+
.. _`ImagineBlock_setImage`: https://github.com/symfony-cmf/block-bundle/blob/master/Doctrine/Phpcr/ImagineBlock.php#L121
165167
.. _`MediaBundle issue`: https://github.com/symfony-cmf/media-bundle/issues/9

‎bundles/media/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
MediaBundle
22
===========
33

4+
.. include:: ../_partials/unmaintained.rst.inc
5+
46
.. toctree::
57
:maxdepth: 2
68

‎bundles/media/introduction.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ MediaBundle
99
a generic base of common interfaces and models that allow the user to build
1010
media management solutions for a CMS.
1111

12+
.. include:: ../_partials/unmaintained.rst.inc
13+
1214
Media can be images, binary documents (like pdf files), embedded movies,
1315
uploaded movies, MP3s, etc. The implementation of this bundle is **very**
1416
minimalistic and is focused on images and download files. If you need more

‎bundles/search/configuration.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Configuration Reference
22
=======================
33

4+
.. include:: ../_partials/unmaintained.rst.inc
5+
46
The SearchBundle can be configured under the ``cmf_search`` key in your
57
application configuration. When using XML, you can use the
68
``http://cmf.symfony.com/schema/dic/search`` namespace.

‎bundles/search/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
SearchBundle
22
============
33

4+
.. include:: ../_partials/unmaintained.rst.inc
5+
46
.. toctree::
57
:maxdepth: 2
68

‎bundles/search/introduction.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ SearchBundle
77
The SearchBundle provides integration with `LiipSearchBundle`_ to provide a
88
site wide search.
99

10+
.. include:: ../_partials/unmaintained.rst.inc
11+
1012
Installation
1113
------------
1214

‎bundles/simple_cms/configuration.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Configuration Reference
22
=======================
33

4+
.. include:: ../_partials/unmaintained.rst.inc
5+
46
The SimpleCmsBundle can be configured under the ``cmf_simple_cms`` key in your
57
application configuration. When using XML, you can use the
68
``http://cmf.symfony.com/schema/dic/simplecms`` namespace.

‎bundles/simple_cms/extending_page_class.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Extending the Page class
55
------------------------
66

7+
.. include:: ../_partials/unmaintained.rst.inc
8+
79
The default Page document (``Symfony\Cmf\Bundle\SimpleCmsBundle\Doctrine\Phpcr\Page``)
810
is relatively simple, shipping with a handful of the most common properties
911
for building a typical page: title, body, tags, publish dates etc.

‎bundles/simple_cms/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
SimpleCmsBundle
22
===============
33

4+
.. include:: ../_partials/unmaintained.rst.inc
5+
46
.. toctree::
57
:maxdepth: 2
68

‎bundles/simple_cms/introduction.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ SimpleCmsBundle
88
The SimpleCmsBundle provides a simplistic CMS on top of the CMF components
99
and bundles.
1010

11+
.. include:: ../_partials/unmaintained.rst.inc
12+
1113
While the core CMF components focus on flexibility, the simple CMS trades away
1214
some of that flexibility in favor of simplicity.
1315

‎bundles/simple_cms/menus.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Menus
55
-----
66

7+
.. include:: ../_partials/unmaintained.rst.inc
8+
79
You can use `Knp Menu Bundle`_ to render a menu of your SimpleCms pages. The default Page document
810
(``Symfony\Cmf\Bundle\SimpleCmsBundle\Doctrine\Phpcr\Page``) implements the ``Knp\Menu\NodeInterface``
911
which allows for rendering them as a menu.

‎bundles/simple_cms/multilang.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Multi-Language Support
55
----------------------
66

7+
.. include:: ../_partials/unmaintained.rst.inc
8+
79
Setting the option ``add_locale_pattern`` to ``true`` in a
810
``Symfony\Cmf\Bundle\SimpleCmsBundle\Doctrine\Phpcr\Page`` document will
911
result in prefixing the associated route with ``/{_locale}``. Using the native

‎bundles/simple_cms/rendering.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Rendering
55
---------
66

7+
.. include:: ../_partials/unmaintained.rst.inc
8+
79
You can configure a mapping of document class to template and/or controller
810
by configuring the :ref:`RoutingBundle <reference-config-routing-dynamic>`.
911
When you need specific settings for a single page, you can call

0 commit comments

Comments
 (0)