Skip to content

Commit 6456b89

Browse files
committed
PHPLIB-524 Restructure docs index
This revises the intro text and links to PHPLIB and MongoDB tutorials.
1 parent 9fc0820 commit 6456b89

File tree

1 file changed

+33
-27
lines changed

1 file changed

+33
-27
lines changed

docs/index.txt

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,53 @@ The |php-library| provides a high-level abstraction around the lower-level
88
`PHP driver <https://php.net/mongodb>`_, also known as the ``mongodb``
99
extension.
1010

11-
While the ``mongodb`` extension provides a limited API for executing commands,
12-
queries, and write operations, the |php-library| implements an API similar to
13-
that of the `legacy PHP driver <http://php.net/manual/en/book.mongo.php>`_. The
14-
library contains abstractions for client, database, and collection objects, and
15-
provides methods for CRUD operations and common commands such as index and
16-
collection management.
11+
The ``mongodb`` extension provides a limited API to connect to the database and
12+
execute generic commands, queries, and write operations. In contrast, the
13+
|php-library| provides a full-featured API and models client, database, and
14+
collection objects. Each of those classes provide various helper methods for
15+
performing operations in context. For example, :phpclass:`MongoDB\\Collection`
16+
implements methods for executing CRUD operations and managing indexes on the
17+
collection, among other things.
1718

1819
If you are developing a PHP application with MongoDB, you should consider using
19-
this library, or another high-level abstraction, instead of the extension alone.
20+
the |php-library| instead of the extension alone.
2021

21-
For additional information about this library and the ``mongodb`` extension, see
22-
the `Architecture Overview <http://php.net/manual/en/mongodb.overview.php>`_
23-
article in the extension documentation. `Derick Rethans
24-
<http://derickrethans.nl/>`_ has also written a series of blog posts entitled
25-
*New MongoDB Drivers for PHP and HHVM*:
22+
New to the PHP Library?
23+
-----------------------
2624

27-
- `Part One: History <https://derickrethans.nl/new-drivers.html>`_
25+
If you have some experience with MongoDB but are new to the PHP library, the
26+
following pages should help you get started:
2827

29-
- `Part Two: Architecture
30-
<https://derickrethans.nl/new-drivers-part2.html>`_
28+
- :doc:`/tutorial/install-php-library`
3129

32-
- `Part Three: Cursor Behaviour
33-
<https://derickrethans.nl/new-drivers-part3-cursor.html>`_
30+
- :doc:`/tutorial/crud`
31+
32+
- :doc:`/tutorial/commands`
33+
34+
- :doc:`/tutorial/gridfs`
35+
36+
- :doc:`/reference/bson`
37+
38+
If you have previously worked with the
39+
`legacy PHP driver <http://php.net/manual/en/book.mongo.php>`_ (i.e. ``mongo``
40+
extension), it will be helpful to review the :doc:`/upgrade` for a summary of
41+
API changes between the old driver and this library.
3442

3543
New to MongoDB?
3644
---------------
3745

38-
If you are a new MongoDB user, these links should help you become more familiar
39-
with MongoDB and introduce some of the concepts and terms you will encounter in
40-
this documentation:
46+
If you are a new MongoDB user, the following links should help you become more
47+
familiar with MongoDB and introduce some of the concepts and terms you will
48+
encounter in the library documentation:
4149

42-
- :manual:`Introduction to CRUD operations in MongoDB </core/crud>`
50+
- :manual:`Introduction to MongoDB </introduction>`
4351

44-
- :manual:`What is a MongoDB document? </core/document>`
52+
- :manual:`Databases and Collections </core/databases-and-collections>`
4553

46-
- :manual:`Dot notation for accessing document properties
47-
</core/document/#dot-notation>`
54+
- :manual:`Documents </core/document>` and
55+
:manual:`BSON Types </reference/bson-types>`
4856

49-
- :manual:`ObjectId: MongoDB's document identifier </reference/object-id/>`
57+
- :manual:`MongoDB CRUD Operations </crud>`
5058

5159
.. class:: hidden
5260

@@ -57,5 +65,3 @@ this documentation:
5765
/tutorial
5866
/upgrade
5967
/reference
60-
61-
.. /getting-started

0 commit comments

Comments
 (0)