Skip to content

Commit 5f9ae2e

Browse files
committed
issues and help, edits
1 parent f3833c2 commit 5f9ae2e

19 files changed

+102
-21
lines changed

source/crud.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ CRUD Operations
2525
Insert Documents </crud/insert>
2626
Query Documents </crud/query>
2727
Update Documents </crud/update>
28-
Delete Documents </crud/replace>
28+
Replace Documents </crud/replace>
2929
Delete Documents </crud/delete>
3030
Bulk Write Operations </crud/bulk-write>
3131
Transactions </crud/transaction>

source/crud/bulk-write.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ specify the write operations:
6868
.. tip::
6969

7070
For more information about delete, insert, replace, and update
71-
operations, see the :ref:`Write operation guides <php-write>`.
71+
operations, see the :ref:`CRUD <php-crud-operations>` section.
7272

7373
When you call the ``bulkWrite()`` method, the library automatically runs the
7474
write operations in the order they're specified in the array. To learn how to

source/crud/insert.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,6 @@ insert operation bypasses document-level validation:
158158
Additional Information
159159
----------------------
160160

161-
To view runnable code examples of inserting documents with the {+php-library+}, see
162-
:ref:`php-write`.
163-
164161
API Documentation
165162
~~~~~~~~~~~~~~~~~
166163

source/crud/query/retrieve.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,6 @@ Additional Information
240240

241241
To learn more about query filters, see the :ref:`php-specify-query` guide.
242242

243-
To view code examples of retrieving documents with the {+php-library+},
244-
see :ref:`php-read`.
245-
246243
API Documentation
247244
~~~~~~~~~~~~~~~~~
248245

source/get-started.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,5 +344,5 @@ and retrieves a document that matches a query.
344344

345345
Learn more about the {+php-library+} from the following resources:
346346

347-
- Learn how to perform read operations in the :ref:`<php-read>` section.
348-
- Learn how to perform write operations in the :ref:`<php-write>` section.
347+
- Learn how to configure your MongoDB connection in the :ref:`<php-connect>` section.
348+
- Learn how to perform read and write operations in the :ref:`<php-crud-operations>` section.

source/includes/extracts-bucket-option.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ref: bucket-option-codec
22
content: |
3-
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
3+
The :ref:`php-codecs` to use for encoding or decoding documents.
44
This option is mutually exclusive with the ``typeMap`` option.
55
66
Defaults to the bucket's codec. Inheritance for a default ``codec`` option

source/includes/extracts-collection-option.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ref: collection-option-codec
22
content: |
3-
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
3+
The :ref:`php-codecs` to use for encoding or decoding documents.
44
This option is mutually exclusive with the ``typeMap`` option.
55
66
Defaults to the collection's codec. Inheritance for a default ``codec`` option

source/includes/extracts-common-option.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ref: common-option-codec
22
content: |
3-
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
3+
The :ref:`php-codecs` to use for encoding or decoding documents.
44
This option is mutually exclusive with the ``typeMap`` option.
55
---
66
ref: common-option-collation

source/index.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ MongoDB PHP Library
2828
Reference </references>
2929
FAQ </faq>
3030
API Documentation </reference>
31+
Issues & Help </issues-and-help>
3132

3233
Overview
3334
--------
@@ -118,3 +119,9 @@ FAQ
118119

119120
See answers to commonly asked questions about the {+library-short+} in the
120121
the :ref:`php-faq` section.
122+
123+
Issues & Help
124+
-------------
125+
126+
Learn how to report bugs, contribute to the library, and find help in the
127+
:ref:`Issues & Help <php-issues-and-help>` section.

source/issues-and-help.txt

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
.. _php-issues-and-help:
2+
3+
=============
4+
Issues & Help
5+
=============
6+
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: php, troubleshooting, feedback
13+
:description: Find support for the {+library-short+, report bugs or feature requests, and learn how to contribute.
14+
15+
.. contents:: On this page
16+
:local:
17+
:backlinks: none
18+
:depth: 1
19+
:class: singlecol
20+
21+
We are lucky to have a vibrant MongoDB PHP community that includes users
22+
with varying levels of experience using the {+library-short+}. The
23+
quickest way to get support for general questions is through the
24+
:community-forum:`MongoDB Community Forums </tag/php>`.
25+
26+
Bugs / Feature Requests
27+
-----------------------
28+
29+
If you have feedback about the {+library-short+}, visit the `MongoDB
30+
Feedback Engine <https://feedback.mongodb.com/>`__ and select
31+
:guilabel:`Drivers` from the list of products on the right side of
32+
your screen. You can propose improvements, report issues, and provide
33+
other types of feedback by using this site.
34+
35+
You can also open a case in Jira, our issue management tool, to identify
36+
bugs or propose improvements. The following steps describe how to create
37+
a Jira issue:
38+
39+
1. Visit the `MongoDB Jira issue tracker <https://jira.mongodb.org/>`__ and click the
40+
`signup link. <https://account.mongodb.com/account/register>`__
41+
Create an account, and then log in to Jira.
42+
#. Navigate to the `PHPLIB Jira project. <https://jira.mongodb.org/browse/PHPLIB>`__
43+
#. Click :guilabel:`Create` to create a ticket. Please provide as much
44+
information as possible about the issue or request in the ticket.
45+
46+
.. note::
47+
48+
Bug reports in the PHP Jira project are publicly viewable.
49+
50+
If you've identified a security vulnerability in any official MongoDB
51+
product, please report it according to the instructions found in the
52+
:manual:`Create a Vulnerability Report page. </tutorial/create-a-vulnerability-report>`
53+
54+
Pull Requests
55+
-------------
56+
57+
We are happy to accept contributions to help improve the {+library-short+}. We guide
58+
user contributions to ensure they meet the standards of the codebase. Ensure
59+
that any pull requests include documentation, tests, and pass the
60+
static analysis checks.
61+
62+
To contribute to the library, check out the source and work on a branch:
63+
64+
.. code-block:: bash
65+
66+
git clone https://github.com/mongodb/mongo-php-library.git
67+
cd mongo-php-library
68+
composer update
69+
git checkout -b myNewFeature
70+
71+
Then, run the library's test suite by using the following command:
72+
73+
.. code-block:: bash
74+
75+
composer run test
76+
77+
To learn more about the requirements for pull requests, see
78+
:github:`Contributing to the PHP Library for MongoDB
79+
</mongodb/mongo-php-library/blob/{+source-gh-branch+}/CONTRIBUTING.md>`
80+
on GitHub.

source/reference/method/MongoDBClient-getCollection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Parameters
4747

4848
* - codec
4949
- MongoDB\\Codec\\DocumentCodec
50-
- The default :doc:`codec </data-formats/codecs>` to use for collection
50+
- The default :ref:`php-codecs` to use for collection
5151
operations.
5252

5353
.. versionadded:: 1.17

source/reference/method/MongoDBClient-selectCollection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Parameters
5050

5151
* - codec
5252
- MongoDB\\Codec\\DocumentCodec
53-
- The default :doc:`codec </data-formats/codecs>` to use for collection
53+
- The default :ref:`php-codecs` to use for collection
5454
operations.
5555

5656
.. versionadded:: 1.17

source/reference/method/MongoDBCollection-bulkWrite.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,6 @@ See Also
148148
--------
149149

150150
- :ref:`php-bulk-write`
151-
- :ref:`php-write`
152151
- :phpmethod:`MongoDB\Collection::deleteMany()`
153152
- :phpmethod:`MongoDB\Collection::deleteOne()`
154153
- :phpmethod:`MongoDB\Collection::insertMany()`

source/reference/method/MongoDBCollection__construct.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Definition
6060

6161
* - codec
6262
- MongoDB\\Codec\\DocumentCodec
63-
- The default :doc:`codec </data-formats/codecs>` to use for collection
63+
- The default :ref:`php-codecs` to use for collection
6464
operations.
6565

6666
.. versionadded:: 1.17

source/reference/method/MongoDBDatabase-getCollection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Parameters
4343

4444
* - codec
4545
- MongoDB\\Codec\\DocumentCodec
46-
- The default :doc:`codec </data-formats/codecs>` to use for collection
46+
- The default :ref:`php-codecs` to use for collection
4747
operations.
4848

4949
.. versionadded:: 1.17

source/reference/method/MongoDBDatabase-selectCollection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Parameters
4343

4444
* - codec
4545
- MongoDB\\Codec\\DocumentCodec
46-
- The default :doc:`codec </data-formats/codecs>` to use for collection
46+
- The default :ref:`php-codecs` to use for collection
4747
operations.
4848

4949
.. versionadded:: 1.17

source/reference/method/MongoDBDatabase-selectGridFSBucket.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Parameters
4848

4949
* - codec
5050
- MongoDB\\Codec\\DocumentCodec
51-
- The default :doc:`codec </data-formats/codecs>` to use for bucket methods
51+
- The default :ref:`php-codecs` to use for bucket methods
5252
that return a file document (e.g. :phpmethod:`MongoDB\GridFS\Bucket::find()`).
5353

5454
.. versionadded:: 1.17

source/reference/method/MongoDBGridFSBucket__construct.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Parameters
5656

5757
* - codec
5858
- MongoDB\\Codec\\DocumentCodec
59-
- The default :doc:`codec </data-formats/codecs>` to use for bucket methods
59+
- The default :ref:`php-codecs` to use for bucket methods
6060
that return a file document (e.g. :phpmethod:`MongoDB\GridFS\Bucket::find()`).
6161

6262
.. versionadded:: 1.17

source/security.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Secure Your Data
2424

2525
Authentication </security/authentication>
2626
Encryption </security/in-use-encryption>
27+
TLS </security/tls>
2728

2829
Overview
2930
--------

0 commit comments

Comments
 (0)