Merge pull request #164 from loic425/docs/move-behat-guide-to-cookbook

[docs] move behat guide into cookbook
Monofony · Mar 20, 2019 · 027f0cd · 027f0cd
2 parents c0457ee + 0cb295d
commit 027f0cd
Show file tree

Hide file tree

Showing 18 changed files with 62 additions and 30 deletions.
diff --git a/docs/behat/map.rst.inc b/docs/behat/map.rst.inc
diff --git a/docs/behat/basic-usage.rst → docs/cookbook/bdd/behat/basic-usage.rst b/docs/behat/basic-usage.rst → docs/cookbook/bdd/behat/basic-usage.rst
diff --git a/docs/behat/how-to-add-new-context.rst → ...book/bdd/behat/how-to-add-new-context.rst b/docs/behat/how-to-add-new-context.rst → ...book/bdd/behat/how-to-add-new-context.rst
diff --git a/docs/behat/how-to-add-new-page.rst → ...ookbook/bdd/behat/how-to-add-new-page.rst b/docs/behat/how-to-add-new-page.rst → ...ookbook/bdd/behat/how-to-add-new-page.rst
diff --git a/docs/cookbook/bdd/behat/how-to-change-behat-application-base-url.rst b/docs/cookbook/bdd/behat/how-to-change-behat-application-base-url.rst
@@ -0,0 +1,16 @@
+How to change Behat application base url
+----------------------------------------
+
+By default Behat uses ``http://localhost:8080/`` as your application base url. If your one is different,
+you need to create ``behat.yml`` files that will overwrite it with your custom url:
+
+.. code-block:: yaml
+
+    # behat.yml
+
+    imports: ["behat.yml.dist"]
+
+    default:
+        extensions:
+            Behat\MinkExtension:
+                base_url: http://my.custom.url
diff --git a/docs/behat/how-to-define-new-suite.rst → ...ook/bdd/behat/how-to-define-new-suite.rst b/docs/behat/how-to-define-new-suite.rst → ...ook/bdd/behat/how-to-define-new-suite.rst
diff --git a/docs/behat/how-to-use-transformers.rst → ...ook/bdd/behat/how-to-use-transformers.rst b/docs/behat/how-to-use-transformers.rst → ...ook/bdd/behat/how-to-use-transformers.rst
diff --git a/docs/behat/index.rst → docs/cookbook/bdd/behat/index.rst b/docs/behat/index.rst → docs/cookbook/bdd/behat/index.rst
@@ -1,5 +1,5 @@
-The BDD Guide
-=============
+How to use Behat to design your features
+----------------------------------------
 
 .. note::
 
@@ -25,7 +25,15 @@ We use `FriendsOfBehat/SymfonyExtension`_ to integrate Behat with Symfony.
     how-to-add-new-page
     how-to-define-new-suite
     how-to-use-transformers
+    how-to-change-behat-application-base-url
 
-.. include:: /behat/map.rst.inc
+.. include:: /cookbook/bdd/behat/map.rst.inc
+
+Learn more
+----------
+
+.. note::
+
+    To learn more, read the `Behat documentation <http://behat.org/en/latest/guides.html>`_.
 
 .. _FriendsOfBehat/SymfonyExtension: https://github.com/FriendsOfBehat/SymfonyExtension
diff --git a/docs/cookbook/bdd/behat/map.rst.inc b/docs/cookbook/bdd/behat/map.rst.inc
@@ -0,0 +1,6 @@
+* :doc:`/cookbook/bdd/behat/basic-usage`
+* :doc:`/cookbook/bdd/behat/how-to-add-new-context`
+* :doc:`/cookbook/bdd/behat/how-to-add-new-page`
+* :doc:`/cookbook/bdd/behat/how-to-define-new-suite`
+* :doc:`/cookbook/bdd/behat/how-to-use-transformers`
+* :doc:`/cookbook/bdd/behat/how-to-change-behat-application-base-url`
diff --git a/docs/cookbook/bdd/map.rst.inc b/docs/cookbook/bdd/map.rst.inc
@@ -1,4 +1,2 @@
-* :doc:`/cookbook/bdd/how-to-configure-phpspec-with-code-coverage`
-* :doc:`/cookbook/bdd/how-to-disable-phpspec-code-coverage`
-* :doc:`/cookbook/bdd/how-to-design-entities-with-phpspec`
-* :doc:`/cookbook/bdd/how-to-design-services-with-phpspec`
+* :doc:`/cookbook/bdd/phpspec/index`
+* :doc:`/cookbook/bdd/behat/index`
diff --git a/...-configure-phpspec-with-code-coverage.rst → ...-configure-phpspec-with-code-coverage.rst b/...-configure-phpspec-with-code-coverage.rst → ...-configure-phpspec-with-code-coverage.rst
@@ -9,7 +9,7 @@ Thus you have two options:
 
 .. note::
 
-    But if you don't need that feature, :doc:`disable code coverage </cookbook/bdd/how-to-disable-phpspec-code-coverage>`.
+    But if you don't need that feature, :doc:`disable code coverage </cookbook/bdd/phpspec/how-to-disable-phpspec-code-coverage>`.
 
 
 Install phpdbg

diff --git a/...d/how-to-design-entities-with-phpspec.rst → ...c/how-to-design-entities-with-phpspec.rst b/...d/how-to-design-entities-with-phpspec.rst → ...c/how-to-design-entities-with-phpspec.rst
@@ -7,7 +7,7 @@ Title is a simple string and author implements CustomerInterface.
 .. warning::
 
     By default, phpspec on Monofony is configured with code coverage.
-    :doc:`Learn how to configure phpspec with code coverage </cookbook/bdd/how-to-configure-phpspec-with-code-coverage>` or :doc:`disable code coverage </cookbook/bdd/how-to-disable-phpspec-code-coverage>`.
+    :doc:`Learn how to configure phpspec with code coverage </cookbook/bdd/phpspec/how-to-configure-phpspec-with-code-coverage>` or :doc:`disable code coverage </cookbook/bdd/phpspec/how-to-disable-phpspec-code-coverage>`.
 
 Generate phpspec for your entity
 --------------------------------

diff --git a/...d/how-to-design-services-with-phpspec.rst → ...c/how-to-design-services-with-phpspec.rst b/...d/how-to-design-services-with-phpspec.rst → ...c/how-to-design-services-with-phpspec.rst
diff --git a/.../how-to-disable-phpspec-code-coverage.rst → .../how-to-disable-phpspec-code-coverage.rst b/.../how-to-disable-phpspec-code-coverage.rst → .../how-to-disable-phpspec-code-coverage.rst
diff --git a/docs/cookbook/bdd/phpspec/index.rst b/docs/cookbook/bdd/phpspec/index.rst
@@ -0,0 +1,19 @@
+How to use Phpspec to design your code
+--------------------------------------
+
+.. toctree::
+    :hidden:
+
+    how-to-configure-phpspec-with-code-coverage
+    how-to-disable-phpspec-code-coverage
+    how-to-design-entities-with-phpspec
+    how-to-design-services-with-phpspec
+
+.. include:: /cookbook/bdd/phpspec/map.rst.inc
+
+Learn more
+----------
+
+.. note::
+
+    To learn more, read the `Phpspec documentation <http://www.phpspec.net/en/stable/manual/introduction.html>`_.
diff --git a/docs/cookbook/bdd/phpspec/map.rst.inc b/docs/cookbook/bdd/phpspec/map.rst.inc
@@ -0,0 +1,4 @@
+* :doc:`/cookbook/bdd/phpspec/how-to-configure-phpspec-with-code-coverage`
+* :doc:`/cookbook/bdd/phpspec/how-to-disable-phpspec-code-coverage`
+* :doc:`/cookbook/bdd/phpspec/how-to-design-entities-with-phpspec`
+* :doc:`/cookbook/bdd/phpspec/how-to-design-services-with-phpspec`
diff --git a/docs/cookbook/index.rst b/docs/cookbook/index.rst
@@ -33,10 +33,8 @@ BDD
 .. toctree::
     :hidden:
 
-    bdd/how-to-configure-phpspec-with-code-coverage
-    bdd/how-to-disable-phpspec-code-coverage
-    bdd/how-to-design-entities-with-phpspec
-    bdd/how-to-design-services-with-phpspec
+    bdd/phpspec/index
+    bdd/behat/index
 
 .. include:: /cookbook/bdd/map.rst.inc
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -36,18 +36,6 @@ The Cookbook
 
     cookbook/index
 
-The Behat Guide
----------------
-
-In :doc:`the Behat Guide </behat/index>` you will learn how to write clean and reusable features, contexts and pages.
-
-.. toctree::
-    :hidden:
-
-    behat/index
-
-.. include:: /behat/map.rst.inc
-
 Deployment
 ----------