Skip to content

Commit c2bae29

Browse files
author
Chris Cho
authored
Merge pull request #164 from ajhuh-mdb/reference-page-compatibility
Add Compatibility Section to Reference Page Prototype
2 parents bfe5528 + 60daa64 commit c2bae29

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

source/style-guide/information-types/prototypes/reference.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,46 @@ contents, often called a short description. The short description
2727
explains a little about how the reference material is used, and may link
2828
to a concept or task page.
2929

30+
Compatibility
31+
-------------
32+
33+
Optional.
34+
35+
A list of MongoDB editions that support the referenced method, operator,
36+
or database command:
37+
38+
- `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_: The fully managed service
39+
for MongoDB deployments in the cloud
40+
41+
.. note::
42+
43+
If Atlas supports the command or functionality, specify a level of
44+
compatibility such as one of the following:
45+
46+
- Available in all clusters
47+
- Available only in certain clusters
48+
- Available in no clusters
49+
50+
To see an example, see `aggregate Compatibility <https://www.mongodb.com/docs/v7.3/reference/command/aggregate/#compatibility>`__.
51+
52+
- `MongoDB Enterprise <http://www.mongodb.com/products/mongodb-enterprise-advanced>`_:
53+
The subscription-based, self-managed version of MongoDB
54+
55+
- `MongoDB Community <https://www.mongodb.com/try/download/community>`_: The
56+
source-available, free-to-use, and self-managed version of MongoDB
57+
58+
.. tip::
59+
60+
On the MongoDB Server documentation, you can use the following includes for
61+
the list of supported MongoDB editions:
62+
63+
- ``.. include:: /includes/fact-environments-atlas-only.rst``
64+
- ``.. include:: /includes/fact-environments-onprem-only.rst``
65+
66+
On the MongoDB Drivers documentation, you can use
67+
``.. sharedinclude:: dbx/platform-support/atlas-connect-compatible-deployment.rst``.
68+
69+
3070
Syntax
3171
------
3272

0 commit comments

Comments
 (0)