Merge pull request #3 from ccho-mongodb/DOCSP-35148-redirects-facets-backslashes

DOCSP-35148: fix redirects, facets, backslashes

Author: Chris Cho

README.md

@@ -1,18 +1,23 @@
-# docs-laravel
+=============================
+Laravel MongoDB Documentation
+=============================
 
-[Your words here].
+This repository contains documentation for the Laravel MongoDBODM.
 
-## Report Issues
+File JIRA Tickets
+-----------------
 
-To file issues or requests regarding the documentation, go to the
-`Documentation Jira Project <https://jira.mongodb.org/browse/DOCS>`_.
+Please file issue reports or requests at the `Documentation Jira Project
+<https://jira.mongodb.org/browse/DOCS>`_.
 
-## License
+Licenses
+--------
 
 All documentation is available under the terms of a `Creative Commons
 License <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_.
 
-If you have any questions, please contact `docs@mongodb.com
-<mailto:docs@mongodb.com>`_.
+The MongoDB Documentation Project is governed by the terms of the
+`MongoDB Contributor Agreement
+<https://www.mongodb.com/legal/contributor-agreement>`_.
 
--- The MongoDB Documentation Team
+-- The MongoDB Documentations Team

config/redirects

@@ -2,5 +2,7 @@ define: prefix docs/drivers/php/laravel-mongodb
 define: base https://www.mongodb.com/${prefix}
 define: versions v4.1 master
 
-# raw: <source file> -> ${base}/<destination>
+symlink: current -> master
 
+raw: ${prefix}/ -> ${base}/current/
+raw: ${prefix}/stable -> ${base}/current/

source/eloquent-models.txt

@@ -17,7 +17,7 @@ define models for corresponding collections.
 Extending the base model
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-To get started, create a new model class in your ``app\Models\`` directory.
+To get started, create a new model class in your ``app\Models\\`` directory.
 
 .. code-block:: php
 
@@ -31,7 +31,7 @@ To get started, create a new model class in your ``app\Models\`` directory.
    }
 
 Just like a regular model, the MongoDB model class will know which collection
-to use based on the model name. For ``Book``\ , the collection ``books`` will
+to use based on the model name. For ``Book``, the collection ``books`` will
 be used.
 
 To change the collection, pass the ``$collection`` property:
@@ -346,7 +346,7 @@ You can access the embedded models through the dynamic property:
        //
    }
 
-The inverse relation is auto\ *magically* available. You can omit the reverse
+The inverse relation is auto *magically* available. You can omit the reverse
 relation definition.
 
 .. code-block:: php
@@ -485,7 +485,7 @@ based on the type of the related model.
 If you want this functionality to work both ways, your SQL-models will need 
 to use the ``MongoDB\Laravel\Eloquent\HybridRelations`` trait.
 
-**This functionality only works for ``hasOne``\ , ``hasMany`` and ``belongsTo``.**
+**This functionality only works for ``hasOne``, ``hasMany`` and ``belongsTo``.**
 
 The SQL model must use the ``HybridRelations`` trait:
 

source/query-builder.txt

@@ -5,7 +5,6 @@ Query Builder
 =============
 
 .. facet::
-
    :name: genre
    :values: tutorial
 
@@ -158,7 +157,7 @@ Distinct requires a field for which to return the distinct values.
    // Equivalent to:
    $users = User::distinct('name')->get();
 
-Distinct can be combined with **where**\ :
+Distinct can be combined with **where**:
 
 .. code-block:: php
 
@@ -185,7 +184,7 @@ Distinct can be combined with **where**\ :
    $price = Product::avg('price');
    $total = Product::sum('price');
 
-Aggregations can be combined with **where**\ :
+Aggregations can be combined with **where**:
 
 .. code-block:: php
 
@@ -511,7 +510,7 @@ Add items to an array.
        'message' => 'Hi John',
    ]);
 
-If you **DON'T** want duplicate items, set the third parameter to ``true``\ :
+If you **DON'T** want duplicate items, set the third parameter to ``true``:
 
 .. code-block:: php
 

source/upgrade.txt

@@ -22,7 +22,7 @@ Upgrading from version 3 to 4
 - Change dependency name in your composer.json to ``"mongodb/laravel-mongodb": "^4.0"``
   and run ``composer update``
 
-- Change namespace from ``Jenssegers\Mongodb\`` to ``MongoDB\Laravel\``
+- Change namespace from ``Jenssegers\Mongodb\\`` to ``MongoDB\Laravel\\``
   in your models and config
 
 - Remove support for non-Laravel projects