Skip to content

Commit 1251a2d

Browse files
author
Chris Cho
authored
DOCSP-35401: docs landing page (#2710)
1 parent 8a66967 commit 1251a2d

File tree

1 file changed

+88
-38
lines changed

1 file changed

+88
-38
lines changed

docs/index.txt

Lines changed: 88 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,64 +7,114 @@ Laravel MongoDB
77
:values: reference
88

99
.. meta::
10-
:keywords: php framework, odm
10+
:keywords: php framework, odm, eloquent, query builder
1111

12-
This package adds functionalities to the Eloquent model and Query builder for
13-
MongoDB, using the original Laravel API.
14-
*This library extends the original Laravel classes, so it uses exactly the
15-
same methods.*
12+
.. toctree::
13+
:titlesonly:
14+
:maxdepth: 1
15+
16+
/install
17+
/eloquent-models
18+
/query-builder
19+
/user-authentication
20+
/queues
21+
/transactions
22+
/upgrade
23+
24+
Introduction
25+
------------
26+
27+
Welcome to the documentation site for the official {+odm-long+}.
28+
This package extends methods in the PHP Laravel API to work with MongoDB as
29+
a datastore in your Laravel application. {+odm-short+} allows you to use
30+
Laravel Eloquent and Query Builder syntax to work with your MongoDB data.
31+
32+
.. note::
33+
34+
This documentation describes the ``mongodb/laravel-mongodb`` package,
35+
formerly named ``jenssegers/mongodb``. This package is now owned and
36+
maintained by MongoDB, Inc. and is compatible with Laravel 10.x and
37+
later.
38+
39+
To find versions of the package compatible with older versions of Laravel,
40+
see the `Laravel Version Compatibility <https://github.com/mongodb/laravel-mongodb/tree/3.9#laravel-version-compatibility>`__
41+
table.
42+
43+
Getting Started
44+
---------------
45+
46+
Learn how to install and configure your app to MongoDB by using the
47+
{+odm-short+} in the :ref:`laravel-install` section.
48+
49+
Fundamentals
50+
------------
1651

17-
This package was renamed to ``mongodb/laravel-mongodb`` because of a transfer
18-
of ownership to MongoDB, Inc. It is compatible with Laravel 10.x. For older
19-
versions of Laravel, please see the `old versions <https://github.com/mongodb/laravel-mongodb/tree/3.9#laravel-version-compatibility>`__.
52+
To learn how to perform the following tasks by using the {+odm-short+},
53+
see the following content:
2054

21-
- :ref:`laravel-install`
2255
- :ref:`laravel-eloquent-models`
2356
- :ref:`laravel-query-builder`
2457
- :ref:`laravel-user-authentication`
2558
- :ref:`laravel-queues`
2659
- :ref:`laravel-transactions`
27-
- :ref:`laravel-upgrading`
60+
61+
Upgrade Versions
62+
----------------
63+
64+
Learn what changes you might need to make to your application to upgrade
65+
versions in the :ref:`laravel-upgrading` section.
2866

2967
Reporting Issues
3068
----------------
3169

32-
Think you’ve found a bug in the library? Want to see a new feature? Please open a case in our issue management tool, JIRA:
70+
We are lucky to have a vibrant PHP community that includes users of varying
71+
experience with MongoDB PHP Library and {+odm-short+}. To get support for
72+
general questions, search or post in the
73+
`MongoDB Community Forums <https://www.mongodb.com/community/forums/>`__.
3374

34-
- `Create an account and login <https://jira.mongodb.org/>`__
35-
- Navigate to the `PHPORM <https://jira.mongodb.org/browse/PHPORM>`__ project.
36-
- Click Create
37-
- Please provide as much information as possible about the issue type and how to reproduce it.
75+
To learn more about MongoDB support options, see the
76+
`Technical Support <https://www.mongodb.org/about/support>`__ page.
3877

39-
Note: All reported issues in JIRA project are public.
4078

41-
For general questions and support requests, please use one of MongoDB's
42-
:manual:`Technical Support </support/>` channels.
79+
Bugs / Feature Requests
80+
-----------------------
4381

44-
Security Vulnerabilities
45-
~~~~~~~~~~~~~~~~~~~~~~~~
82+
If you've found a bug or want to see a new feature in {+odm-short+},
83+
please report it in the GitHub issues section of the
84+
`mongodb/laravel-mongodb <https://github.com/mongodb/laravel-mongodb>`__
85+
repository.
4686

47-
If you've identified a security vulnerability in a driver or any other MongoDB
48-
project, please report it according to the instructions in
49-
:manual:`Create a Vulnerability Report </tutorial/create-a-vulnerability-report>`.
87+
If you want to contribute code, see the following section for instructions on
88+
submitting pull requests.
5089

90+
To report a bug or request a new feature, perform the following steps:
5191

52-
Development
53-
-----------
92+
1. Visit the `GitHub issues <https://github.com/mongodb/laravel-mongodb/issues>`__
93+
section and search for any similar issues or bugs.
94+
#. If you find a matching issue, you can reply to the thread to report that
95+
you have a similar issue or request.
96+
#. If you cannot find a matching issue, click :guilabel:`New issue` and select
97+
the appropriate issue type.
98+
#. If you selected "Bug report" or "Feature request", please provide as much
99+
information as possible about the issue. Click :guilabel:`Submit new issue`
100+
to complete your submission.
54101

55-
Development is tracked in the `PHPORM <https://jira.mongodb.org/projects/PHPORM/summary>`__
56-
project in MongoDB's JIRA. Documentation for contributing to this project may
57-
be found in `CONTRIBUTING.md <https://github.com/mongodb/laravel-mongodb/blob/4.1/CONTRIBUTING.md>`__.
102+
If you've identified a security vulnerability in any official MongoDB
103+
product, please report it according to the instructions found in the
104+
:manual:`Create a Vulnerability Report page </tutorial/create-a-vulnerability-report>`.
58105

59-
.. toctree::
60-
:titlesonly:
61-
:maxdepth: 1
106+
For general questions and support requests, please use one of MongoDB's
107+
:manual:`Technical Support </support/>` channels.
62108

63-
/install
64-
/eloquent-models
65-
/query-builder
66-
/user-authentication
67-
/queues
68-
/transactions
69-
/upgrade
109+
Pull Requests
110+
-------------
111+
112+
We are happy to accept contributions to help improve the {+odm-short+}.
113+
114+
We track current development in `PHPORM <https://jira.mongodb.org/projects/PHPORM/summary>`__
115+
MongoDB JIRA project.
116+
117+
To learn more about contributing to this project, see the
118+
`CONTRIBUTING.md <https://github.com/mongodb/laravel-mongodb/blob/4.1/CONTRIBUTING.md>`__
119+
guide on GitHub.
70120

0 commit comments

Comments
 (0)