Skip to content

DOCSP-41950: Landing page #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ toc_landing_pages = [
"/reference/class/MongoDBModelDatabaseInfo",
"/reference/class/MongoDBModelIndexInfo",
"/get-started",
"/databases-collections",
"/write",
"/indexes"
"/indexes",
"/data-formats"
]

sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: should we rename "driver-short"? Line 37

Expand Down
2 changes: 0 additions & 2 deletions source/compatibility.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ The first column lists the version of the library and extension.

.. include:: /includes/language-compatibility-table-php.rst

.. sharedinclude:: dbx/about-driver-compatibility.rst

For more information on how to read the compatibility tables, see our guide on
:ref:`MongoDB Compatibility Tables <about-driver-compatibility>`.

Expand Down
2 changes: 1 addition & 1 deletion source/connect/tls.txt
Original file line number Diff line number Diff line change
Expand Up @@ -265,4 +265,4 @@ API Documentation
To learn more about configuring TLS for the {+driver-short+},
see the following API documentation:

- :ref:`MongoDB\Client <php-mongodb-client>`
- :phpclass:`MongoDB\Client`
40 changes: 40 additions & 0 deletions source/data-formats.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.. _php-data-formats:

========================
Specialized Data Formats
========================

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: store, bson, codec

.. toctree::
:titlesonly:
:maxdepth: 1

/data-formats/custom-types
/data-formats/codecs
/data-formats/decimal128
/data-formats/modeling-bson-data


Overview
--------

You can use several types of specialized data formats in your {+driver-short+}
application. To learn how to work with these data formats, see the following
guides:

- :ref:`php-custom-types`
- :ref:`php-codecs`
- :ref:`php-decimal128`
- :ref:`php-bson`
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _php-custom-types:

=================
Custom Data-Types
=================
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _php-decimal128:

==========
Decimal128
==========
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _php-bson:

==================
Modeling BSON Data
==================
Expand Down
2 changes: 2 additions & 0 deletions source/faq.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _php-faq:

==========================
Frequently Asked Questions
==========================
Expand Down
118 changes: 77 additions & 41 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,68 +18,104 @@
/indexes
/monitoring
/security
/tutorial
/upgrade
/reference
FAQ </faq>
/data-formats
/compatibility
/whats-new
FAQ </faq>
/reference

The |php-library| provides a high-level abstraction around the lower-level
Overview
--------

Welcome to the documentation site for the official {+php-library+}.

The {+driver-short+} provides a high-level abstraction around the lower-level
:php:`mongodb extension <mongodb>`.

The ``mongodb`` extension provides a limited API to connect to the database and
execute generic commands, queries, and write operations. In contrast, the
|php-library| provides a full-featured API and models client, database, and
collection objects. Each of those classes provide various helper methods for
performing operations in context. For example, :phpclass:`MongoDB\Collection`
implements methods for executing CRUD operations and managing indexes on the
collection, among other things.
The ``mongodb`` extension provides a limited API to connect to a MongoDB
database and execute generic commands, queries, and write operations. In
contrast, the {+driver-short+} provides a full-featured API and models client,
database, and collection objects. If you are developing a PHP application with
MongoDB, consider using the {+driver-short+} instead of the extension alone.

Get Started
-----------

Learn how to install the library and extension, establish a connection to MongoDB,
and begin working with data in the :ref:`php-get-started` tutorial.

Connect to MongoDB
------------------

Learn how to create and configure a connection to a MongoDB deployment
in the :ref:`php-connect` section.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to reviewer: link broken until #147 is merged


Databases and Collections
-------------------------

Learn how to use the {+driver-short+} to work with MongoDB databases and collections
in the :ref:`php-databases-collections` section.

Read Data from MongoDB
----------------------

Learn how you can retrieve data from MongoDB in the :ref:`php-read` section.

If you are developing a PHP application with MongoDB, you should consider using
the |php-library| instead of the extension alone.
Write Data to MongoDB
---------------------

New to the PHP Library?
-----------------------
Learn how you can write data to MongoDB in the :ref:`php-write` section.

If you have some experience with MongoDB but are new to the PHP library, the
following pages should help you get started:
Transform Your Data with Aggregation
------------------------------------

- :ref:`php-download-and-install`
Learn how to use the {+driver-short+} to perform aggregation operations in the
:ref:`php-aggregation` section.

- :doc:`/tutorial/connecting`
Optimize Queries with Indexes
-----------------------------

- :doc:`/tutorial/crud`
Learn how to work with common types of indexes in the :ref:`php-indexes`
section.

- :doc:`/tutorial/commands`
Monitoring
----------

- :doc:`/tutorial/gridfs`
Learn how to monitor change events in the :ref:`php-monitoring`
section.

- :doc:`/tutorial/modeling-bson-data`
Secure Your Data
----------------

- :doc:`/reference/bson`
Learn about ways you can authenticate your application and encrypt your data in
the :ref:`php-security` section.

Code examples can be found in the ``examples`` directory in the source code.
Specialized Data Formats
------------------------

If you have previously worked with the legacy ``mongo`` extension, it will be
helpful to review the :doc:`/upgrade` for a summary of API changes between the
old driver and this library.
Learn how to work with specialized data formats and custom types in the
:ref:`php-data-formats` section.

You can view changes introduced in each version release of the
{+php-library+} in the :ref:`php-lib-whats-new` section.
Compatibility
-------------

New to MongoDB?
---------------
See compatibility tables showing the recommended {+driver-short+} version to use for
specific PHP and {+mdb-server+} versions in the :ref:`php-compatibility` section.

If you are a new MongoDB user, the following links should help you become more
familiar with MongoDB and introduce some of the concepts and terms you will
encounter in the library documentation:
What's New
----------

- :manual:`Introduction to MongoDB </introduction>`
Learn about new features and changes in each version in the :ref:`<php-lib-whats-new>`
section.

- :manual:`Databases and Collections </core/databases-and-collections>`
.. TODO:
Upgrade {+driver-short+} Versions
---------------------------------
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: add newline under heading

Learn what changes you might need to make to your application to upgrade driver versions

Check failure on line 114 in source/index.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.ConciseTerms] 'must' is preferred over 'need to'. Raw Output: {"message": "[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.", "location": {"path": "source/index.txt", "range": {"start": {"line": 114, "column": 31}}}, "severity": "ERROR"}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Learn what changes you might need to make to your application to upgrade driver versions
Learn what changes you must make to your application to upgrade driver versions

in the :ref:`php-upgrade` section.

- :manual:`Documents </core/document>` and
:manual:`BSON Types </reference/bson-types>`
FAQ
---

- :manual:`MongoDB CRUD Operations </crud>`
See answers to commonly asked questions about the {+driver-short+} in the
the :ref:`php-faq` section.
2 changes: 2 additions & 0 deletions source/tutorial.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Tutorials
=========

Expand Down
2 changes: 2 additions & 0 deletions source/tutorial/aws-lambda.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

==============================
Deploy to AWS Lambda with Bref
==============================
Expand Down
2 changes: 2 additions & 0 deletions source/tutorial/collation.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

=========
Collation
=========
Expand Down
2 changes: 2 additions & 0 deletions source/tutorial/commands.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

=========================
Execute Database Commands
=========================
Expand Down
25 changes: 0 additions & 25 deletions source/tutorial/connecting.txt

This file was deleted.

Loading
Loading