Browse Source

doc fix + demo url fix

Oskar Stark 9 years ago
parent
commit
39a9c9bf85
2 changed files with 13 additions and 15 deletions
  1. 1 1
      Resources/doc/index.rst
  2. 12 14
      Resources/doc/reference/console.rst

+ 1 - 1
Resources/doc/index.rst

@@ -9,7 +9,7 @@ Admin Bundle
 * `SonataDoctrinePhpcrAdminBundle <https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle>`_: integrates PHPCR with the core admin bundle (early stage)
 * `SonataDoctrinePhpcrAdminBundle <https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle>`_: integrates PHPCR with the core admin bundle (early stage)
 * `SonataPropelAdminBundle <https://github.com/sonata-project/SonataPropelAdminBundle>`_: integrates Propel with the core admin bundle (early stage)
 * `SonataPropelAdminBundle <https://github.com/sonata-project/SonataPropelAdminBundle>`_: integrates Propel with the core admin bundle (early stage)
 
 
-The demo website can be found in http://demo.sonata-project.org/admin/dashboard (``admin`` as user and password).
+The demo website can be found in http://demo.sonata-project.org (``admin`` as user and password).
 
 
 Reference Guide
 Reference Guide
 ---------------
 ---------------

+ 12 - 14
Resources/doc/reference/console.rst

@@ -10,7 +10,6 @@ SonataAdminBundle provides the following console commands:
 * ``sonata:admin:setup-acl``
 * ``sonata:admin:setup-acl``
 * ``sonata:admin:generate-object-acl``
 * ``sonata:admin:generate-object-acl``
 
 
-
 cache:create-cache-class
 cache:create-cache-class
 ------------------------
 ------------------------
 
 
@@ -23,7 +22,6 @@ Usage example:
 
 
     $ php app/console cache:create-cache-class
     $ php app/console cache:create-cache-class
 
 
-
 sonata:admin:generate
 sonata:admin:generate
 ---------------------
 ---------------------
 
 
@@ -33,19 +31,22 @@ As an argument you need to specify the fully qualified model class.
 All passed arguments and options are used as default values in interactive mode.
 All passed arguments and options are used as default values in interactive mode.
 You can disable the interactive mode with ``--no-interaction`` option.
 You can disable the interactive mode with ``--no-interaction`` option.
 
 
-The command require the SensioGeneratorBundle to work. If you don't already have it, you can install it with :
+The command require the SensioGeneratorBundle_ to work. If you don't already have it, you can install it with :
 
 
 .. code-block:: bash
 .. code-block:: bash
 
 
     $ composer require --dev sensio/generator-bundle
     $ composer require --dev sensio/generator-bundle
 
 
-Options are:
- * ``bundle``: the bundle name (the default value is determined by the given model class, e.g. "AppBundle" or "YourNSFooBundle")
- * ``admin``: the admin class basename (by default this adds "Admin" to the model class name, e.g. "BarAdmin")
- * ``controller``: the controller class basename (by default this adds "AdminController" to the model class name, e.g. "BarAdminController")
- * ``manager``: the model manager type (by default this is the first registered model manager type, e.g. "orm")
- * ``services``: the services YAML file (the default value is "services.yml" or "admin.yml" if it already exist)
- * ``id``: the admin service ID (the default value is combination of the bundle name and admin class basename like "your_ns_foo.admin.bar")
+===============   ===============================================================================================================================
+Options           Description
+===============   ===============================================================================================================================
+ **bundle**       the bundle name (the default value is determined by the given model class, e.g. "AppBundle" or "YourNSFooBundle")
+ **admin**        the admin class basename (by default this adds "Admin" to the model class name, e.g. "BarAdmin")
+ **controller**   the controller class basename (by default this adds "AdminController" to the model class name, e.g. "BarAdminController")
+ **manager**      the model manager type (by default this is the first registered model manager type, e.g. "orm")
+ **services**     the services YAML file (the default value is "services.yml" or "admin.yml" if it already exist)
+ **id**           the admin service ID (the default value is combination of the bundle name and admin class basename like "your_ns_foo.admin.bar")
+===============   ===============================================================================================================================
 
 
 Usage example:
 Usage example:
 
 
@@ -53,7 +54,6 @@ Usage example:
 
 
     $ php app/console sonata:admin:generate AppBundle/Entity/Foo
     $ php app/console sonata:admin:generate AppBundle/Entity/Foo
 
 
-
 sonata:admin:list
 sonata:admin:list
 -----------------
 -----------------
 
 
@@ -76,7 +76,6 @@ Usage example:
 
 
    List command
    List command
 
 
-
 sonata:admin:explain
 sonata:admin:explain
 --------------------
 --------------------
 
 
@@ -96,7 +95,6 @@ Usage example:
 
 
    Explain command
    Explain command
 
 
-
 sonata:admin:setup-acl
 sonata:admin:setup-acl
 ----------------------
 ----------------------
 
 
@@ -112,7 +110,6 @@ Usage example:
 
 
     $ php app/console sonata:admin:setup-acl
     $ php app/console sonata:admin:setup-acl
 
 
-
 sonata:admin:generate-object-acl
 sonata:admin:generate-object-acl
 --------------------------------
 --------------------------------
 
 
@@ -120,3 +117,4 @@ The ``sonata:admin:generate-object-acl`` is an interactive command which helps
 you to generate ACL entities for the objects handled by your Admins. See the help
 you to generate ACL entities for the objects handled by your Admins. See the help
 of the command for more information.
 of the command for more information.
 
 
+.. _SensioGeneratorBundle: http://symfony.com/doc/current/bundles/SensioGeneratorBundle/index.html