Skip to content

Commit eb9eb10

Browse files
authored
DOCSP-35931: Issues and Help page (#2744)
1 parent d2d7845 commit eb9eb10

File tree

3 files changed

+64
-55
lines changed

3 files changed

+64
-55
lines changed

docs/compatibility.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ The following compatibility table specifies the versions of Laravel and
2323
.. include:: /includes/framework-compatibility-laravel.rst
2424

2525
To find compatibility information for unmaintained versions of {+odm-short+},
26-
see `Laravel Version Compatibility <https://github.com/mongodb/laravel-mongodb/blob/3.9/README.md#installation>`__
26+
see `Laravel Version Compatibility <{+mongodb-laravel-gh+}/blob/3.9/README.md#installation>`__
2727
on GitHub.

docs/index.txt

Lines changed: 7 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Laravel MongoDB
1313
:titlesonly:
1414
:maxdepth: 1
1515

16-
/install
1716
/quick-start
1817
/retrieve
1918
/eloquent-models
2019
/query-builder
2120
/user-authentication
2221
/queues
2322
/transactions
23+
/issues-and-help
2424
/compatibility
2525
/upgrade
2626

@@ -59,6 +59,12 @@ see the following content:
5959
- :ref:`laravel-queues`
6060
- :ref:`laravel-transactions`
6161

62+
Issues & Help
63+
-------------
64+
65+
Learn how to report bugs, contribute to the library, and find
66+
more resources in the :ref:`laravel-issues-and-help` section.
67+
6268
Compatibility
6369
-------------
6470

@@ -71,57 +77,4 @@ Upgrade Versions
7177
Learn what changes you might need to make to your application to upgrade
7278
versions in the :ref:`laravel-upgrading` section.
7379

74-
Reporting Issues
75-
----------------
76-
77-
We are lucky to have a vibrant PHP community that includes users of varying
78-
experience with MongoDB PHP Library and {+odm-short+}. To get support for
79-
general questions, search or post in the
80-
:community-forum:`MongoDB Community Forums <>`.
81-
82-
To learn more about MongoDB support options, see the
83-
`Technical Support <https://www.mongodb.org/about/support>`__ page.
84-
85-
86-
Bugs / Feature Requests
87-
-----------------------
88-
89-
If you've found a bug or want to see a new feature in {+odm-short+},
90-
please report it in the GitHub issues section of the
91-
`mongodb/laravel-mongodb <https://github.com/mongodb/laravel-mongodb>`__
92-
repository.
93-
94-
If you want to contribute code, see the following section for instructions on
95-
submitting pull requests.
96-
97-
To report a bug or request a new feature, perform the following steps:
98-
99-
1. Visit the `GitHub issues <https://github.com/mongodb/laravel-mongodb/issues>`__
100-
section and search for any similar issues or bugs.
101-
#. If you find a matching issue, you can reply to the thread to report that
102-
you have a similar issue or request.
103-
#. If you cannot find a matching issue, click :guilabel:`New issue` and select
104-
the appropriate issue type.
105-
#. If you selected "Bug report" or "Feature request", please provide as much
106-
information as possible about the issue. Click :guilabel:`Submit new issue`
107-
to complete your submission.
108-
109-
If you've identified a security vulnerability in any official MongoDB
110-
product, please report it according to the instructions found in the
111-
:manual:`Create a Vulnerability Report page </tutorial/create-a-vulnerability-report>`.
112-
113-
For general questions and support requests, please use one of MongoDB's
114-
:manual:`Technical Support </support/>` channels.
115-
116-
Pull Requests
117-
-------------
118-
119-
We are happy to accept contributions to help improve the {+odm-short+}.
120-
121-
We track current development in `PHPORM <https://jira.mongodb.org/projects/PHPORM/summary>`__
122-
MongoDB JIRA project.
123-
124-
To learn more about contributing to this project, see the
125-
`CONTRIBUTING.md <https://github.com/mongodb/laravel-mongodb/blob/4.1/CONTRIBUTING.md>`__
126-
guide on GitHub.
12780

docs/issues-and-help.txt

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _laravel-issues-and-help:
2+
3+
=============
4+
Issues & Help
5+
=============
6+
7+
We are lucky to have a vibrant PHP community that includes users of varying
8+
experience with MongoDB PHP Library and {+odm-short+}. To get support for
9+
general questions, search or post in the
10+
:community-forum:`MongoDB PHP Community Forums </tag/php>`.
11+
12+
To learn more about MongoDB support options, see the
13+
`Technical Support <https://www.mongodb.org/about/support>`__ page.
14+
15+
Bugs / Feature Requests
16+
-----------------------
17+
18+
If you find a bug or want to see a new feature in {+odm-short+},
19+
please report it as a GitHub issue in the `mongodb/laravel-mongodb
20+
<{+mongodb-laravel-gh+}>`__ repository.
21+
22+
If you want to contribute code, see the :ref:`laravel-pull-requests` section
23+
for instructions on submitting pull requests.
24+
25+
To report a bug or request a new feature, perform the following steps:
26+
27+
1. Review the `GitHub issues list <{+mongodb-laravel-gh+}/issues>`__
28+
in the source repository and search for any existing issues that address your concern.
29+
#. If you find a matching issue, you can reply to the thread to report that
30+
you have a similar issue or request.
31+
#. If you cannot find a matching issue, click :guilabel:`New issue` and select
32+
the appropriate issue type.
33+
#. If you select "Bug report" or "Feature request" as the issue type, please provide as
34+
much information as possible about the issue. Click :guilabel:`Submit new issue`
35+
to complete your submission.
36+
37+
If you've identified a security vulnerability in any official MongoDB
38+
product, please report it according to the instructions found in the
39+
:manual:`Create a Vulnerability Report page </tutorial/create-a-vulnerability-report>`.
40+
41+
For general questions and support requests, please use one of MongoDB's
42+
:manual:`Technical Support </support/>` channels.
43+
44+
.. _laravel-pull-requests:
45+
46+
Pull Requests
47+
-------------
48+
49+
We are happy to accept contributions to help improve {+odm-short+}.
50+
51+
We track current development in `PHPORM <https://jira.mongodb.org/projects/PHPORM/summary>`__
52+
MongoDB JIRA project.
53+
54+
To learn more about contributing to this project, see the
55+
`CONTRIBUTING.md <{+mongodb-laravel-gh+}/blob/{+package-version+}/CONTRIBUTING.md>`__
56+
guide on GitHub.

0 commit comments

Comments
 (0)