feature #13581 add doc for reset-password maker (jrushlow, weaverryan)

weaverryan · weaverryan · commit 7820b7c7fc46 · 2020-05-29T10:53:12.000-04:00
This PR was merged into the 4.4 branch. Discussion ---------- add doc for reset-password maker - Creates a guide to setup reset password functionality - Security doc links to the new guide Added to the 4.4 branch as the bundle supports Symfony 4.4+ Commits ------- 9b484fc fixing link e065dff proofreading reset password e964751 refactor caution msg 6e39c5c fix typo 0303275 remove generated code c8a9d46 fix title da7b2b3 link reset password doc in security a4c8b08 draft reset password doc
diff --git a/security.rst b/security.rst
@@ -1015,6 +1015,7 @@ Authentication (Identifying/Logging in the User)
     :maxdepth: 1
 
     security/form_login_setup
+    security/reset_password
     security/json_login_setup
     security/guard_authentication
     security/password_migration
diff --git a/security/reset_password.rst b/security/reset_password.rst
@@ -0,0 +1,28 @@
+How to Add a Reset Password Feature
+===================================
+
+Using `MakerBundle`_ & `SymfonyCastsResetPasswordBundle`_ you can create a
+secure out of the box solution to handle forgotten passwords.
+
+First, make sure you have a security ``User`` class. Follow
+the :doc:`Security Guide </security>` if you don't have one already.
+
+Generating the Reset Password Code
+----------------------------------
+
+.. code-block:: terminal
+
+    $ php composer require symfonycasts/reset-password-bundle
+        .....
+    $ php bin/console make:reset-password
+
+The `make:reset-password` command will ask you a few questions about your app and
+generate all the files you need! After, you'll see a success message and a list
+of any other steps you need to do.
+
+You can customize the reset password bundle's behavior by updating the ``reset_password.yaml``
+file. For more information on the configuration, check out the
+`SymfonyCastsResetPasswordBundle`_  guide.
+
+.. _`MakerBundle`: https://symfony.com/doc/current/bundles/SymfonyMakerBundle/index.html
+.. _`SymfonyCastsResetPasswordBundle`: https://github.com/symfonycasts/reset-password-bundle
