Skip to content

Commit e83b6bc

Browse files
authored
update infra files (#3)
1 parent f4d8d8b commit e83b6bc

File tree

3 files changed

+181
-6
lines changed

3 files changed

+181
-6
lines changed

.github/pull_request_template.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Pull Request Info
2+
3+
[PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md)
4+
5+
JIRA - <https://jira.mongodb.org/browse/DOCSP-NNNNN>
6+
Staging - <https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/>
7+
8+
## Self-Review Checklist
9+
10+
- [ ] Is this free of any warnings or errors in the RST?
11+
- [ ] Did you run a spell-check?
12+
- [ ] Did you run a grammar-check?
13+
- [ ] Are all the links working?
14+
- [ ] Are the [facets and meta keywords](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) accurate?

snooty.toml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,16 @@ intersphinx = [
77
"https://www.mongodb.com/docs/atlas/objects.inv",
88
]
99

10+
toc_landing_pages = [
11+
"/installation",
12+
"/contributing"
13+
]
14+
1015
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
16+
17+
[constants]
18+
driver = "cpp"
19+
driver-long = "MongoDB C++ Driver"
20+
driver-short = "C++ driver"
21+
version = "3.10"
22+
api = "https://mongocxx.org/api/current"

source/index.txt

Lines changed: 155 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,159 @@
1-
==================
2-
C++ Driver
3-
==================
1+
===================
2+
MongoDB C++ Driver
3+
===================
44

5-
.. default-domain:: mongodb
5+
.. facet::
6+
:name: genre
7+
:values: reference
68

7-
Your words here. Don't forget to add a toctree!
9+
.. toctree::
10+
:titlesonly:
11+
:maxdepth: 2
812

9-
Have a lovely day!
13+
/installation
14+
/tutorial
15+
/polyfill-selection
16+
/reporting-bugs
17+
/thread-safety
18+
/working-with-bson
19+
/testing
20+
/contributing
21+
View the Source <https://github.com/mongodb/mongo-cxx-driver>
1022

23+
Welcome to the MongoDB C++ driver. On this site, you'll find documentation
24+
to help you get the most from MongoDB and C++. If you're just starting
25+
out, take a look at these pages first:
26+
27+
- :ref:`Installing mongocxx <cpp-installation>`
28+
- :ref:`Quick-start tutorial <cpp-tutorial>`
29+
30+
Driver Status by Family and Version
31+
-----------------------------------
32+
33+
Stability indicates whether this driver is recommended for production use.
34+
Currently, no drivers guarantee API or ABI stability.
35+
36+
.. list-table::
37+
:header-rows: 1
38+
:stub-columns: 1
39+
:widths: 25 15 25 35
40+
41+
* - Family/version
42+
- Stability
43+
- Development
44+
- Purpose
45+
46+
* - (repo master branch)
47+
- Unstable
48+
- Active development
49+
- New feature development
50+
51+
* - mongocxx 3.10.x
52+
- Stable
53+
- Bug fixes only
54+
- Current stable C++ driver release
55+
56+
* - mongocxx 3.9.x
57+
- Stable
58+
- None
59+
- Previous stable C++ driver release
60+
61+
* - mongocxx 3.8.x
62+
- Stable
63+
- None
64+
- Previous stable C++ driver release
65+
66+
* - mongocxx 3.7.x
67+
- Stable
68+
- None
69+
- Previous stable C++ driver release
70+
71+
* - mongocxx 3.6.x
72+
- Stable
73+
- None
74+
- Previous stable C++ driver release
75+
76+
* - mongocxx 3.5.x
77+
- Stable
78+
- None
79+
- Previous stable C++ driver release
80+
81+
* - mongocxx 3.4.x
82+
- Stable
83+
- None
84+
- Previous stable C++ driver release
85+
86+
* - mongocxx 3.3.x
87+
- Stable
88+
- None
89+
- Previous stable C++ driver release
90+
91+
* - mongocxx 3.2.x
92+
- Stable
93+
- None
94+
- Previous stable C++ driver release
95+
96+
* - mongocxx 3.1.x
97+
- Stable
98+
- None
99+
- Previous stable C++ driver release
100+
101+
* - mongocxx 3.0.x
102+
- Stable
103+
- None
104+
- Previous stable C++ driver release |
105+
106+
Current Driver
107+
--------------
108+
109+
The mongocxx is a ground-up rewrite of a C++ driver for MongoDB based on
110+
`libmongoc <https://mongoc.org/>`__. It requires a C++11 compiler. It is
111+
known to build on x86 and x86-64 architectures for Linux, macOS,
112+
Windows, and FreeBSD.
113+
114+
The mongocxx driver library includes a matching bson package, bsoncxx, that
115+
implements the `BSON specification <http://www.bsonspec.org>`__. This
116+
library can be used standalone for object serialization and deserialization
117+
even when one is not using MongoDB at all.
118+
119+
Releases of the mongocxx driver have version numbers like v3.x.y.
120+
121+
.. note::
122+
123+
There were no v2.x.y C++ drivers to avoid confusion with the deprecated legacy-0.0-26compat-2.x.y drivers.
124+
125+
Compatibility
126+
-------------
127+
128+
MongoDB Compatibility
129+
~~~~~~~~~~~~~~~~~~~~~
130+
131+
The following compatibility table specifies the recommended version or versions
132+
of the MongoDB C++ driver for use with a specific version of MongoDB.
133+
134+
The first column lists the driver version.
135+
136+
.. sharedinclude:: dbx/lifecycle-schedule-callout.rst
137+
138+
.. include:: /includes/mongodb-compatibility-table-cxx.rst
139+
140+
The driver does not support older versions of MongoDB.
141+
142+
Language Compatibility
143+
~~~~~~~~~~~~~~~~~~~~~~
144+
145+
The following compatibility table specifies the recommended version or versions
146+
of the MongoDB C++ driver for use with a specific version of C++.
147+
148+
The first column lists the driver version.
149+
150+
.. include:: /includes/language-compatibility-table-cxx.rst
151+
152+
For more information on how to read the compatibility tables, see our guide on `MongoDB Compatibility Tables <https://www.mongodb.com/docs/drivers/about-compatibility/>`__.
153+
154+
.. include:: /includes/help-links-cxx.rst
155+
156+
License
157+
-------
158+
159+
MongoDB C++ drivers are available under the terms of the Apache License, version 2.0.

0 commit comments

Comments
 (0)