Description component / bundle

21 views
Skip to first unread message

Daniel Leech

unread,
Aug 27, 2016, 9:26:01 AM8/27/16
to symfony-...@googlegroups.com
Hi,

I am sure that not many of you are aware of the Resource stacks
"Description" functionality.

It provides a way for third party units to add "descriptors" to a Puli /
CMF Resource - descriptors may be edition links, creation links (for
children), the title which should be used, thumbnails, summary
descriptions, etc.

This allows all resources to be represented and handled in a genric
fashion (f.e. in a browser).

I have just realised however that it would be equally beneficial to
describe standard objects - i.e. ODM Documents, ORM Entities ..
whatever without depending on having access to the resource which
represents them.

So I propose to make yet another CMF component dedicated to object
description.

https://github.com/symfony-cmf/resource/issues/36

This seems good to me as it already feels awkward in the Resource
component.

Sounds good?

Cheers,

Dan

gmx Privat

unread,
Aug 28, 2016, 6:08:13 PM8/28/16
to symfony-...@googlegroups.com
Hi dan,

I don't know if there coralation to your descriptors. But for for adding resource state change descriptions i would like to see something like defined in the ALPS standard.

Daniel Leech

unread,
Aug 28, 2016, 8:27:43 PM8/28/16
to symfony-...@googlegroups.com
You could use the information in an API, but it is not coupled with APIs
(or resources), something like:

$description = $descriptionFactory->describe($someObject);

$description->getDescriptor(EditLinkDescriptor::class); // path/to/edit/123
$description->getDescriptor(TitleDescriptor::class); // "My Article"
$description->getDescriptor(ClassFqnDescriptor::class); // AppBundle\Enitiy\Foobar
$description->getDescriptor(ImageSrcDescriptor::class); ///thumbnails/foobar.jpg
$description->getDescriptor(ChildCreateLinks::class); // some iterator...

On Sun, Aug 28, 2016 at 08:08:11PM +0200, gmx Privat wrote:
> Hi dan,
>
> I don't know if there coralation to your descriptors. But for for adding resource state change descriptions i would like to see something like defined in the ALPS standard.
>
> --
> You received this message because you are subscribed to the Google Groups "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to symfony-cmf-de...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

Daniel Leech

unread,
Sep 3, 2016, 3:33:01 PM9/3/16
to symfony-...@googlegroups.com
I am going to do this tomorrow unless there is no reply to this thread.

Wouter de Jong

unread,
Sep 3, 2016, 3:42:36 PM9/3/16
to Daniel Leech
I'm sorry for my slow response :) (and david is on summercamp)

We need to be very carefull with creating new packages. We've recently
abandoned some very usefull packages (e.g. the MediaBundle), because
we don't have the man-power to maintain them.

By introducing even more packages, we both give a wrong message (why
deprecating MediaBundle and introducing Description?) and we get more
maintainance work.

Please note that we've added quite some components in the past months
which are all created and maintained by you (RoutingAuto, ContentType,
Resource). Please be aware of the time it takes to maintain all these packages
and their bundles.

Imo, our number one goal is to provide easy to use bundles for the Symfony
framework. I don't think we should create components that may be used by
other CMSes (I don't think it'll happen often, as CMSes are often quite coupled
to their own packages).

I propose:

If we know this package will be used standalone and have good use-cases,
we can think about splitting it.
Otherwise, let's keep it in the Resource component and create a Description
component when we find an actual use-case.

2016-09-03 17:32 GMT+02:00 Daniel Leech <dan...@dantleech.com>:
I am going to do this tomorrow unless there is no reply to this thread.

On Sun, Aug 28, 2016 at 09:25:34PM +0100, Daniel Leech wrote:
> You could use the information in an API, but it is not coupled with APIs
> (or resources), something like:
>
>     $description = $descriptionFactory->describe($someObject);
>
>     $description->getDescriptor(EditLinkDescriptor::class); // path/to/edit/123
>     $description->getDescriptor(TitleDescriptor::class); // "My Article"
>     $description->getDescriptor(ClassFqnDescriptor::class); // AppBundle\Enitiy\Foobar
>     $description->getDescriptor(ImageSrcDescriptor::class); ///thumbnails/foobar.jpg
>     $description->getDescriptor(ChildCreateLinks::class); // some iterator...
>
> On Sun, Aug 28, 2016 at 08:08:11PM +0200, gmx Privat wrote:
> > Hi dan,
> >
> > I don't know if there coralation to your descriptors. But for for adding resource state change descriptions i would like to see something like defined in the ALPS standard.
> >
> > --
> > You received this message because you are subscribed to the Google Groups "symfony-cmf-devs" group.
> > To unsubscribe from this group and stop receiving emails from it, send an email to symfony-cmf-devs+unsubscribe@googlegroups.com.

> > For more options, visit https://groups.google.com/d/optout.
>
> --
> You received this message because you are subscribed to the Google Groups "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to symfony-cmf-devs+unsubscribe@googlegroups.com.

> For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "symfony-cmf-devs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to symfony-cmf-devs+unsubscribe@googlegroups.com.

Daniel Leech

unread,
Sep 3, 2016, 4:12:14 PM9/3/16
to symfony-...@googlegroups.com
On Sat, Sep 03, 2016 at 05:42:34PM +0200, Wouter de Jong wrote:
> I'm sorry for my slow response :) (and david is on summercamp)
> We need to be very carefull with creating new packages. We've recently
> abandoned some very usefull packages (e.g. the MediaBundle), because
> we don't have the man-power to maintain them.

I don't think the MediaBundle was that useful tbh.

> By introducing even more packages, we both give a wrong message (why
> deprecating MediaBundle and introducing Description?) and we get more
> maintainance work.
> Please note that we've added quite some components in the past months
> which are all created and maintained by you (RoutingAuto, ContentType,
> Resource). Please be aware of the time it takes to maintain all these
> packages
> and their bundles.

I want to create decoupled CMS components, I want to build a viable CMS
using these decoupled components. I thought this was the goal of the
Symfony CMF.

> Imo, our number one goal is to provide easy to use bundles for the Symfony
> framework. I don't think we should create components that may be used by
> other CMSes (I don't think it'll happen often, as CMSes are often quite
> coupled
> to their own packages).
> I propose:
> If we know this package will be used standalone and have good use-cases,
> we can think about splitting it.
> Otherwise, let's keep it in the Resource component and create a
> Description

I need this component outside of the Resource stack and there is no
reason that it should be coupled to Resources. It is very CMS-centric.

> component when we find an actual use-case.

To be honest I wonder if I shouldn't create another organization. Which
provides decoupled CMS components which integrate with Symfony.

The fact is I have put aside alot of time over the coming months to
develop all these things and I am not sure we have a common agenda here.

I would love to discuss this in an IRC meeting or over Skype or
whatever, and if people like what I am doing then great. Otherwise I can
move both ContentType and Description to another organization with no
hard feelings.

Cheers,

Dan
> send an email to [2]symfony-cmf-de...@googlegroups.com.
> > > For more options, visit [3]https://groups.google.com/d/optout.
> >
> > --
> > You received this message because you are subscribed to the Google
> Groups "symfony-cmf-devs" group.
> > To unsubscribe from this group and stop receiving emails from it, send
> an email to [4]symfony-cmf-de...@googlegroups.com.
> > For more options, visit [5]https://groups.google.com/d/optout.
>
> --
> You received this message because you are subscribed to the Google
> Groups "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to [6]symfony-cmf-de...@googlegroups.com.
> For more options, visit [7]https://groups.google.com/d/optout.
>
> --
> You received this message because you are subscribed to the Google Groups
> "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [8]symfony-cmf-de...@googlegroups.com.
> For more options, visit [9]https://groups.google.com/d/optout.
>
> References
>
> Visible links
> 1. mailto:dan...@dantleech.com
> 2. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 3. https://groups.google.com/d/optout
> 4. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 5. https://groups.google.com/d/optout
> 6. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 7. https://groups.google.com/d/optout
> 8. mailto:symfony-cmf-de...@googlegroups.com
> 9. https://groups.google.com/d/optout

Wouter de Jong

unread,
Sep 3, 2016, 6:13:46 PM9/3/16
to Daniel Leech
Yeah, I think you want to create a CMS, whereas imo, the CMF is mostly about
providing bundles to make your site more easily editable.

If we plan to provide a framework for CMSes, I'm happy to throw my idea of CMF
away (tbh, I would love to create a CMS).

I like your proposal to organize a CMF meeting about this on IRC soon (this might
also repower us, as the CMF project activity is close to zero).

Shall we create a doodle for the meeting?

>      send an email to [2]symfony-cmf-devs+unsub...@googlegroups.com.

>      > > For more options, visit [3]https://groups.google.com/d/optout.
>      >
>      > --
>      > You received this message because you are subscribed to the Google
>      Groups "symfony-cmf-devs" group.
>      > To unsubscribe from this group and stop receiving emails from it, send

>      > For more options, visit [5]https://groups.google.com/d/optout.
>
>      --
>      You received this message because you are subscribed to the Google
>      Groups "symfony-cmf-devs" group.
>      To unsubscribe from this group and stop receiving emails from it, send

>      For more options, visit [7]https://groups.google.com/d/optout.
>
>    --
>    You received this message because you are subscribed to the Google Groups
>    "symfony-cmf-devs" group.
>    To unsubscribe from this group and stop receiving emails from it, send an

--
You received this message because you are subscribed to the Google Groups "symfony-cmf-devs" group.

gmx Privat

unread,
Sep 3, 2016, 7:17:40 PM9/3/16
to symfony-...@googlegroups.com

Am 03.09.2016 um 20:13 schrieb Wouter de Jong <jong.de...@gmail.com>:

Yeah, I think you want to create a CMS, whereas imo, the CMF is mostly about
providing bundles to make your site more easily editable.

If we plan to provide a framework for CMSes, I'm happy to throw my idea of CMF

What is the difference? Building components to make parts of a symfony project editable, can end in a set of features of a CMS. It is all about man power to build that. So WouterJ is right, currently we only have the Power to maintain a smal set of components. So we have to make that Part really really good. And we have to present (Talks, Articles, Documentation) that really good. That is the only way to get more contributors in my opinion.  Then we can move on. 
I have so many ideas in my head (lots of frontend stuff,...API) but my time ...

away (tbh, I would love to create a CMS).

I like your proposal to organize a CMF meeting about this on IRC soon (this might
also repower us, as the CMF project activity is close to zero).

Good point. 


Shall we create a doodle for the meeting?

Yes.


To unsubscribe from this group and stop receiving emails from it, send an email to symfony-cmf-de...@googlegroups.com.

Daniel Leech

unread,
Sep 3, 2016, 10:58:14 PM9/3/16
to symfony-...@googlegroups.com
Done: http://doodle.com/poll/abq6rxm65emiqkmc

On Sat, Sep 03, 2016 at 08:13:44PM +0200, Wouter de Jong wrote:
> Yeah, I think you want to create a CMS, whereas imo, the CMF is mostly
> about
> providing bundles to make your site more easily editable.
> If we plan to provide a framework for CMSes, I'm happy to throw my idea of
> CMF
> away (tbh, I would love to create a CMS).
> I like your proposal to organize a CMF meeting about this on IRC soon
> (this might
> also repower us, as the CMF project activity is close to zero).
> Shall we create a doodle for the meeting?
> <[1][2]dan...@dantleech.com>:
> [2][3]symfony-cmf-de...@googlegroups.com.
> >      > > For more options, visit
> [3][4]https://groups.google.com/d/optout.
> >      >
> >      > --
> >      > You received this message because you are subscribed to the
> Google
> >      Groups "symfony-cmf-devs" group.
> >      > To unsubscribe from this group and stop receiving emails from
> it, send
> >      an email to [4][5]symfony-cmf-de...@googlegroups.com.
> >      > For more options, visit
> [5][6]https://groups.google.com/d/optout.
> >
> >      --
> >      You received this message because you are subscribed to the
> Google
> >      Groups "symfony-cmf-devs" group.
> >      To unsubscribe from this group and stop receiving emails from it,
> send
> >      an email to [6][7]symfony-cmf-de...@googlegroups.com.
> >      For more options, visit [7][8]https://groups.google.com/d/optout.
> >
> >    --
> >    You received this message because you are subscribed to the Google
> Groups
> >    "symfony-cmf-devs" group.
> >    To unsubscribe from this group and stop receiving emails from it,
> send an
> >    email to [8][9]symfony-cmf-de...@googlegroups.com.
> >    For more options, visit [9][10]https://groups.google.com/d/optout.
> >
> > References
> >
> >    Visible links
> >    1. mailto:[11]dan...@dantleech.com
> >    2. mailto:[12]symfony-cmf-devs%2Bunsu...@googlegroups.com
> >    3. [13]https://groups.google.com/d/optout
> >    4. mailto:[14]symfony-cmf-devs%2Bunsu...@googlegroups.com
> >    5. [15]https://groups.google.com/d/optout
> >    6. mailto:[16]symfony-cmf-devs%2Bunsu...@googlegroups.com
> >    7. [17]https://groups.google.com/d/optout
> >    8. mailto:[18]symfony-cmf-de...@googlegroups.com
> >    9. [19]https://groups.google.com/d/optout
> --
> You received this message because you are subscribed to the Google
> Groups "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to [20]symfony-cmf-de...@googlegroups.com.
> For more options, visit [21]https://groups.google.com/d/optout.
>
> --
> You received this message because you are subscribed to the Google Groups
> "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [22]symfony-cmf-de...@googlegroups.com.
> For more options, visit [23]https://groups.google.com/d/optout.
>
> References
>
> Visible links
> 1. mailto:dan...@dantleech.com
> 2. mailto:dan...@dantleech.com
> 3. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 4. https://groups.google.com/d/optout
> 5. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 6. https://groups.google.com/d/optout
> 7. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 8. https://groups.google.com/d/optout
> 9. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 10. https://groups.google.com/d/optout
> 11. mailto:dan...@dantleech.com
> 12. mailto:symfony-cmf-devs%252Buns...@googlegroups.com
> 13. https://groups.google.com/d/optout
> 14. mailto:symfony-cmf-devs%252Buns...@googlegroups.com
> 15. https://groups.google.com/d/optout
> 16. mailto:symfony-cmf-devs%252Buns...@googlegroups.com
> 17. https://groups.google.com/d/optout
> 18. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 19. https://groups.google.com/d/optout
> 20. mailto:symfony-cmf-devs%2Bunsu...@googlegroups.com
> 21. https://groups.google.com/d/optout
> 22. mailto:symfony-cmf-de...@googlegroups.com
> 23. https://groups.google.com/d/optout

Daniel Leech

unread,
Sep 3, 2016, 11:00:24 PM9/3/16
to symfony-...@googlegroups.com
Here you go: http://doodle.com/poll/abq6rxm65emiqkmc

On Sat, Sep 03, 2016 at 08:13:44PM +0200, Wouter de Jong wrote:
> Yeah, I think you want to create a CMS, whereas imo, the CMF is mostly
> about
> providing bundles to make your site more easily editable.
> If we plan to provide a framework for CMSes, I'm happy to throw my idea of
> CMF
> away (tbh, I would love to create a CMS).
> I like your proposal to organize a CMF meeting about this on IRC soon
> (this might
> also repower us, as the CMF project activity is close to zero).
> Shall we create a doodle for the meeting?
> <[1][2]dan...@dantleech.com>:
> [2][3]symfony-cmf-de...@googlegroups.com.
> >      > > For more options, visit
> [3][4]https://groups.google.com/d/optout.
> >      >
> >      > --
> >      > You received this message because you are subscribed to the
> Google
> >      Groups "symfony-cmf-devs" group.
> >      > To unsubscribe from this group and stop receiving emails from
> it, send
> >      an email to [4][5]symfony-cmf-de...@googlegroups.com.
> >      > For more options, visit
> [5][6]https://groups.google.com/d/optout.
> >
> >      --
> >      You received this message because you are subscribed to the
> Google
> >      Groups "symfony-cmf-devs" group.
> >      To unsubscribe from this group and stop receiving emails from it,
> send
> >      an email to [6][7]symfony-cmf-de...@googlegroups.com.
> >      For more options, visit [7][8]https://groups.google.com/d/optout.
> >
> >    --
> >    You received this message because you are subscribed to the Google
> Groups
> >    "symfony-cmf-devs" group.
> >    To unsubscribe from this group and stop receiving emails from it,
> send an
> >    email to [8][9]symfony-cmf-de...@googlegroups.com.
> >    For more options, visit [9][10]https://groups.google.com/d/optout.
> >
> > References
> >
> >    Visible links
> >    9. [19]https://groups.google.com/d/optout
> --
> You received this message because you are subscribed to the Google
> Groups "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to [20]symfony-cmf-de...@googlegroups.com.
> For more options, visit [21]https://groups.google.com/d/optout.
>
> --
> You received this message because you are subscribed to the Google Groups
> "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [22]symfony-cmf-de...@googlegroups.com.
> For more options, visit [23]https://groups.google.com/d/optout.
>
> References
>
> Visible links
> 1. mailto:dan...@dantleech.com

GMX - Maximilian Berghoff

unread,
Sep 4, 2016, 9:39:10 AM9/4/16
to symfony-...@googlegroups.com
Dan, can you add some more information into the description. So we can
share it a little on twitter and so on?
I would really wish to do that on a kind of a hangout, cause on a chat
you can't really follow discussions, you can't do some kind of a
moderation (or i didn't see that).

Max

Daniel Leech

unread,
Sep 4, 2016, 4:53:25 PM9/4/16
to symfony-...@googlegroups.com
Tbh, I am not sure what we are discussing yet otherwise I would have
done. I will update it in the coming days and put it on Twitter.
> To unsubscribe from this group and stop receiving emails from it, send an email to symfony-cmf-de...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

David Buchmann

unread,
Sep 12, 2016, 8:28:22 AM9/12/16
to symfony-...@googlegroups.com
> Yeah, I think you want to create a CMS, whereas imo, the CMF is mostly about
> providing bundles to make your site more easily editable.

in my understanding, the aim of the cmf was always twofold and included
providing building blocks to create custom (or other) cms.

> I like your proposal to organize a CMF meeting about this on IRC soon
> (this might
> also repower us, as the CMF project activity is close to zero).

as you probably noticed, i have become less active, both in the
mailinglist and in the repositories. but i still care about the cmf. i'd
be happy to join such a meeting and see that we can (re)align ourselves.
i filled out the doodle, but most of the dates actually are already
past... i am usually more flexible during the day than in evenings.

imo we can also try to continue the discussion here by emails.

cheers,david

ps: regarding media bundle, i think both dan and wouter are right in
some way. media management is an important functionality for a cms, so
it would be relevant. but the bundle we had never became very relevant
because it was complicated and not 100% ready to use and documentation
is lacking too.

Daniel Leech

unread,
Sep 13, 2016, 6:28:56 AM9/13/16
to symfony-...@googlegroups.com
On Mon, Sep 12, 2016 at 10:28:19AM +0200, David Buchmann wrote:
> > Yeah, I think you want to create a CMS, whereas imo, the CMF is mostly about
> > providing bundles to make your site more easily editable.
>
> in my understanding, the aim of the cmf was always twofold and included
> providing building blocks to create custom (or other) cms.
>
> > I like your proposal to organize a CMF meeting about this on IRC soon
> > (this might
> > also repower us, as the CMF project activity is close to zero).
>
> as you probably noticed, i have become less active, both in the
> mailinglist and in the repositories. but i still care about the cmf. i'd
> be happy to join such a meeting and see that we can (re)align ourselves.
> i filled out the doodle, but most of the dates actually are already
> past... i am usually more flexible during the day than in evenings.
>
> imo we can also try to continue the discussion here by emails.

I think discussing here is fine for the moment. I have been working on some
things privately and I will, in the coming week, post what I have done
which will may provide a good basis for discussion.

>
> cheers,david
>
> ps: regarding media bundle, i think both dan and wouter are right in
> some way. media management is an important functionality for a cms, so
> it would be relevant. but the bundle we had never became very relevant
> because it was complicated and not 100% ready to use and documentation
> is lacking too.


>
> --
> You received this message because you are subscribed to the Google Groups "symfony-cmf-devs" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to symfony-cmf-de...@googlegroups.com.
Reply all
Reply to author
Forward
0 new messages