Selaa lähdekoodia

Merge pull request #74 from Taluu/pr-fix-docs

Update documentation
Thomas 13 vuotta sitten
vanhempi
commit
d73287189d

+ 8 - 6
Resources/doc/reference/installation.rst

@@ -38,7 +38,7 @@ files:
     $loader->registerNamespaces(array(
         // ...
         'Sonata'        => __DIR__.'/../vendor/bundles',
-        'Application'   => __DIR__,
+        'Application'   => __DIR__.'/../src',
         // ...
     ));
 
@@ -106,8 +106,8 @@ Now, add the new `Application` Bundle into the kernel
 Acl Configuration
 -----------------
 
-When using ACL, the UserBundle can prevent ``normal`` user to change settings of ``super-admin`` users, to enable this
-add to the configuration:
+When using ACL, the UserBundle can prevent ``normal`` user to change settings 
+of ``super-admin`` users, to enable this add to the configuration:
 
 .. code-block:: yaml
 
@@ -159,7 +159,8 @@ Add the related security routing information
         resource: '@SonataUserBundle/Resources/config/routing/admin_security.xml'
         prefix: /admin
 
-You also need to define a ``sonata_user_impersonating`` route, used as a redirection after an user impersonating.
+You also need to define a ``sonata_user_impersonating`` route, used as a 
+redirection after an user impersonating.
 
 Then add a new custom firewall handlers for the admin
 
@@ -240,5 +241,6 @@ The last part is to define 3 new access control rules :
 Using the roles
 ---------------
 
-Each admin has its own roles, use the user form to assign them to other users. The available roles to assign to others
-are limited to the roles available to the user editing the form.
+Each admin has its own roles, use the user form to assign them to other users. 
+The available roles to assign to others are limited to the roles available to 
+the user editing the form.

+ 7 - 4
Resources/doc/reference/introduction.rst

@@ -1,14 +1,17 @@
 Introduction
 ============
 
-Integrate the FOS/UserBundle in the Sonata Admin Project
+Integrates the FOS/UserBundle in the Sonata Admin Project
 
  - AdminBundle: add user and group management
  - EasyExtends: allows to generate Application level model
 
 The roles to be assigned to users is split in 2 parts:
 
- - editable: the roles the current user is allowed to assign to other users (permission or role ``MASTER``)
- - readonly: the roles assigned to the current user, however the current user is only allowed to see them
+ - **editable :** the roles the current user is allowed to assign to other users 
+    (permission or role ``MASTER``)
+ - **readonly :** the roles assigned to the current user, however the current 
+    user is only allowed to see them
 
-When using ACL, the UserBundle prevents ``normal`` user to change settings of ``super-admin`` users.
+When using ACL, the UserBundle prevents ``normal`` user to change settings of 
+``super-admin`` users.

+ 10 - 5
Resources/doc/reference/two_step_validation.rst

@@ -1,17 +1,21 @@
 Two Step Validation (with Google Authenticator)
 ===============================================
 
-The SonataUserBundle provides an optional layer of security by including a support for a Two Step Validation process.
+The SonataUserBundle provides an optional layer of security by including a 
+support for a Two Step Validation process.
 
-When the option is enabled, the login process is done with the following workflow :
+When the option is enabled, the login process is done with the following 
+workflow :
 
 * the user enters the login and password
 * if the user get the correct credentials, then
 * a code validation form is diplayed
-* at this point the user must enter a time based code provided by the Google Authenticator application
+* at this point the user must enter a time based code provided by the Google 
+  Authenticator application
 * the code is valid only once per minute
 
-So if your login and password are compromised then the hacker must also hold your phone!
+So if your login and password are compromised then the hacker must also hold 
+your phone!
 
 
 Installation
@@ -43,4 +47,5 @@ Edit the configuration file
             enabled: true
             server:  yourserver.com
 
-Now if the ``User::twoStepVerificationCode`` property is not null, then a second form will be displayed.
+Now if the ``User::twoStepVerificationCode`` property is not null, then a second
+form will be displayed.