New documentation

[bobvandevijver]

This is a work-in-progress and aims to create a full documentation of this bundle.

Checklist:

• Document actions builder #21: actions builder
• Document excel builder #18: excel builder : do not forget to add a note about the required list builder
• Document list scopes #16: list scopes
• Document generator translated content feature #15: generator translated content
• Document options class feature #13: options class (see Symfony 2.8 & 3.0 compatibility #224)
• Document new/edit builder features #12: new/edit builder
• Document show builder features #11: show builder
• Document list builder features #10: list builder
• Document list filters feature #8: list filters
• [RFC] Breadcrumbs proposal  #158: Breadcrumbs (for cookbook)
• Use credentials back instead of groups #221: Credentials documentation
• How to / Filtering scope w. "more complex" query #232: Filter documentation
• Symfony 2.8 & 3.0 compatibility #224: Reflect changes for Symfony 2.8 & 3.0 compatibility.
• complete Getting started section
• complete How does this work? section
• complete Configuration section
• complete Customization section
• complete Cookbook section
• create "Showcase" page with screenshots of demo project on AdminLTE v2 theme
• remove update-readme branch

List of things I won't do:

• Document embed builder feature #14: embed builder
• Document nested list builder #17: nested list
• Document column groups feature #9: column groups
• remember to fix Fix doc #120

The documentation for now is placed in a new directory, which will replace the old documentation directory after merge.

Note that #128 was the previous PR for the documentation, this is a reboot which already contains the needed work from that.

Any help is appreciated, just let me know what you are working on!

[ioleo]

@bobvandevijver what are you missing in #221 to document?

[bobvandevijver]

Well, we changed behavior of the credentials part, so there should at least be an upgrade note about it. Furthermore, the changes for JMS are not yet incorporated in this doc. Finally I would like to see a complete example of how the credentials work and what is possible with them.

[ioleo]

@sescandell could you fill in the gaps?

[sescandell]

Hi,

I don't get it. Is https://github.com/symfony2admingenerator/GeneratorBundle/blob/master/Resources/doc/security/credentials.md not enough (I mean, as a first step)?

[bobvandevijver]

@sescandell I missed that you updated the doc in the PR, I'm sorry!

[sescandell]

👍

[bobvandevijver]

@sescandell/@loostro: Can one of you check the documentation of the Options class? As I do not use it currently I'm not sure if it's correct, but I think it should be okay 👍

[ioleo]

@bobvandevijver I'd just like to add that Form specific options take precedence over Options class.

Eg. if the system tries to render edit form with category field:

• it will first check if EditType class has getCategoryOptions method. If it exists, it will be used.
• then it will check if Options class has getCategoryOptions method. If it exists, it will be used.

Note that if both classes have getCategoryOptions method, then the latter (Options) will get (as an argument) fieldOptions already modified by previous (EditType) method.

See implementation here

[bobvandevijver]

Okay, I made quite some progress for tonight. I will try to create the new/edit/list/show builder documentation this week.

In the meantime, can your guys check the doc so far? ( @sescandell @loostro @tobias-93 ) I do not plan on making the embed/nested list documentation: I do not use it so I have no idea how to document it. I also do not know what column groups are.

I've moved those checkboxes to the bottom of the list, I hope you guys can check them. Otherwise, I would propose that as soon as I finish my list, this PR is merged such that the docs can be used easily by everyone. The embedded/nested/column group will than be added later.

[bobvandevijver]

This PR is now ready to merge! @sescandell & @loostro, please provide me with some feedback, otherwise I'll merge it next week :)

[ioleo]

CS fix:

public function getVersion()
{

[bobvandevijver]

Personally I do not use that style (because of the extra line), but I will fix it.

[ioleo]

It's part of PSR-2 which is used by symfony2 core

[bobvandevijver]

I know, but I like to be different :p. Anyway, it's fixed 👍

[ioleo]

@bobvandevijver great job 👍 !

[sescandell]

Awesome work @bobvandevijver 👍

[bobvandevijver]

Merged 🎉