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

sonata admin integration #790

Merged
merged 6 commits into from
Jan 17, 2017
Merged

sonata admin integration #790

merged 6 commits into from
Jan 17, 2017

Conversation

dbu
Copy link
Member

@dbu dbu commented Dec 19, 2016

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?

@ElectricMaxxx
Copy link
Member

I would keep it simple and not explain sonata again, means:

  • mention all possible admins and its documents and their bundle (where they are from)* explain how to enable a complete bundle by its configuration
  • explain how to enable ONE single admin with its class and its paths and form_groups
  • explain all extensions, how to enalble them, and their purpose separated by bundles (where they are from)

@dbu
Copy link
Member Author

dbu commented Dec 20, 2016

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?

@ElectricMaxxx
Copy link
Member

ElectricMaxxx commented Dec 20, 2016

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:

  • here you can have a simple example how public workflow looks like
  • here you can see|edit the tree structure of the PHPCR

@ElectricMaxxx ElectricMaxxx added this to the 2.0 milestone Dec 20, 2016
Sonata Admin Integration
~~~~~~~~~~~~~~~~~~~~~~~~

Since version 2 of the CMF, we provide a separate bundle with admin interfaces for the
Copy link
Member

@dantleech dantleech Dec 20, 2016

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 ?

Copy link
Member

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

admins => admin services ?

Copy link
Member

@ElectricMaxxx ElectricMaxxx left a 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
Copy link
Member

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?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@dbu
Copy link
Member Author

dbu commented Dec 20, 2016 via email

@wouterj
Copy link
Member

wouterj commented Dec 22, 2016

I would say:

  • Explain how to install this bundle
  • Link to Sonata docs for installation guides on their side
  • Show how to enable/disable admins and persistence layer (will submit a PR this night)
  • Show the available admins and their extensions, admin factory per admin factory.
  • Maybe other information that we find when extracting admin stuff from the bundles

@wouterj
Copy link
Member

wouterj commented Jan 3, 2017

@dbu are you working on this PR or can I take it over and continue writing?

@dbu
Copy link
Member Author

dbu commented Jan 3, 2017

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.

@wouterj
Copy link
Member

wouterj commented Jan 4, 2017

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 😃.

@wouterj wouterj force-pushed the admin-integration branch from 411ce29 to 27b6ff3 Compare January 4, 2017 11:08
@wouterj wouterj force-pushed the admin-integration branch from 27b6ff3 to e58dfb1 Compare January 4, 2017 16:32
-------------

This section documents all available admin integrations in this bundle, with
their configuration options.
Copy link
Member Author

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@dbu
Copy link
Member Author

dbu commented Jan 13, 2017

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
Copy link
Member

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.

Copy link
Member Author

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!):
Copy link
Member

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea

@dbu dbu changed the title WIP: sonata admin integration sonata admin integration Jan 16, 2017
@dbu
Copy link
Member Author

dbu commented Jan 16, 2017

squash and merge?

@dbu dbu force-pushed the admin-integration branch from e50d750 to 4784fea Compare January 16, 2017 12:45
@dbu dbu merged commit d82a76d into 2.0 Jan 17, 2017
@dbu dbu removed the wip/poc label Jan 17, 2017
@dbu dbu deleted the admin-integration branch January 17, 2017 08:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants