-
Notifications
You must be signed in to change notification settings - Fork 156
Conversation
I would keep it simple and not explain sonata again, means:
|
i wonder how much of https://github.com/symfony-cmf/symfony-cmf-docs/blob/master/tutorial/sonata-admin.rst we should move here or if we leave that in the tutorial? |
sonata has enough own documentation, the phpcr-backend part too. With that bundle we also alligned a lot, so one single admin example can be enough from my POV. Our main purpose is not to explain how sonata is working. We should focus on the stuff, where we present the features of the CMF mean:
|
Sonata Admin Integration | ||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Since version 2 of the CMF, we provide a separate bundle with admin interfaces for the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
admin interfaces
=> admin integrations/services
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe implementations
|
||
The SonataAdminIntegrationBundle provides admin services for the Sonata | ||
Admin tool. Additionally, it provides admin extensions to improve your | ||
custom admins. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
admins
=> admin services
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will you also do #786 here?
Sonata Admin Integration | ||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Since version 2 of the CMF, we provide a separate bundle with admin interfaces for the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe implementations
Installation | ||
------------ | ||
|
||
should we move tutorial sonata-admin.rst here and get rid of the tutorial? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Will you also do #786 here?
depends on what we mean by "all sonata docs". i think we should move
bundle docs per bundle, as we clean up the bundle documentation in
general. that will be more manageable than one huge move.
|
I would say:
|
@dbu are you working on this PR or can I take it over and continue writing? |
i hope to find some time this friday or saturday to move this forward. until then, if you can continue with the foundations, please do. maybe we can also add some todo's here and then merge this to work in smaller junks. |
Bootstrapped the documentation the way I think we should document this. I think we can merge it as is and fill in the other bundle integrations per bundle in seperate PRs. As always, open for every comment you can think of 😃. |
411ce29
to
27b6ff3
Compare
27b6ff3
to
e58dfb1
Compare
------------- | ||
|
||
This section documents all available admin integrations in this bundle, with | ||
their configuration options. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we split the documentation for each bundle integration into its own page? i think otherwise the doc gets very long and unweildy otherwise. i'd rather group configuration and other usage instruction for a specific bundle into one page, than configuration => each bundle, tips => each bundle.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
i fixed the errors. would love to decide on splitting configuration (and other doc) into a page per bundle and do that in here, then we can merge this and fill in things in parallel |
return $bundles; | ||
} | ||
|
||
Sonata requires the ``sonata_block`` bundle to be configured in your main |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is precisly the stuff I would not want to see in here: This is about installing the sonata admin bundle, not our integration bundle.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed (and did not place back into the tutorial) and replaced with a link to the sonata doc
|
||
return $collection; | ||
|
||
and publish your assets (remove ``--symlink`` if you use Windows!): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removing --symlink
is not needed:
- If you run as admin in windows, symlinks are supported
- If it isn't supported, the option will simply be ignored by Symfony
------------- | ||
|
||
This section documents all available admin integrations in this bundle, with | ||
their configuration options. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea
squash and merge? |
e50d750
to
4784fea
Compare
fix #785
i want to merge this asap so that we can move the individual bundle admin docs and clean up stuff. i wonder how much we want to explain about setting up sonata in general. should we leave that in the tutorial or move here?