Skip to content

Commit ac551f0

Browse files
committed
DOCS-4980 integrate Java examples
1 parent c338cfe commit ac551f0

File tree

61 files changed

+1599
-246
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1599
-246
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ primer/source/includes/hash.rst
5050
primer/source/.static
5151
primer/source/*.rst
5252
primer/source/core/*.rst
53+
primer/source/includes/example*.txt
5354
primer/source/includes/driver-table.rst
5455
primer/source/includes/fact-installation-bind-ip-default-in-config.rst
5556
primer/source/includes/fact-installation-directories.rst
@@ -74,6 +75,7 @@ primer/source/images/*.png
7475
primer/source/images/*.rst
7576
primer/source/images/*.svg
7677
primer/source/includes/*.cpp
78+
primer/source/includes/*.java
7779
*.mo
7880
.stub
7981
primer/source/includes/table-linux-kernel-version-production.yaml

primer/config/build_conf.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ project:
1717
branched: false
1818
- name: cpp
1919
branched: false
20+
- name: java
21+
branched: false
2022
version:
2123
release: '2.6.1'
2224
branch: '2.6'
@@ -30,10 +32,9 @@ system:
3032
- 'intersphinx-local.yaml'
3133
- migrations:
3234
- 'primer-migrations-complex.yaml'
33-
- 'primer-migrations-images.yaml'
3435
- 'primer-migrations-simple.yaml'
3536
- 'primer-migrations-cpp-examples.yaml'
36-
- images: '/source/images/metadata.yaml'
37+
- 'primer-migrations-java-examples.yaml'
3738
assets:
3839
- branch: master
3940
path: build/docs-tools
@@ -44,6 +45,9 @@ assets:
4445
- branch: master
4546
path: build/cpp-examples
4647
repository: https://github.com/mongodb/mongo-cxx-driver.git
48+
- branch: master
49+
path: build/java-examples
50+
repository: https://github.com/mongodb/mongo-java-driver
4751
paths:
4852
output: 'build'
4953
source: 'source'

primer/config/primer-migrations-complex.yaml

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ transform:
1212
source: tutorial/install-mongodb-on-red-hat.txt
1313
target: tutorial/install-mongodb-on-red-hat.txt
1414
transform:
15-
regex: ":doc:`default ports </reference/default-mongodb-port>`."
16-
replace: ":manual:`default ports </reference/default-mongodb-port>`."
15+
- regex: ":doc:`default ports </reference/default-mongodb-port>`."
16+
replace: ":manual:`default ports </reference/default-mongodb-port>`."
1717
---
1818
source: tutorial/install-mongodb-on-windows.txt
1919
target: tutorial/install-mongodb-on-windows.rst
@@ -30,11 +30,6 @@ transform:
3030
regex: ":doc:`(.*) <(/reference/configuration-options)>`"
3131
replace: ":manual:`\\1 <\\2>`"
3232
---
33-
source: includes/steps-run-mongodb-on-windows.yaml
34-
transform:
35-
regex: ":doc:"
36-
replace: ":manual:"
37-
---
3833
source: includes/steps-get-mongodb-for-windows.yaml
3934
transform:
4035
regex: ":doc:"
@@ -51,11 +46,23 @@ transform:
5146
replace: ":manual:"
5247
---
5348
source: includes/steps-run-mongodb-on-linux.yaml
49+
truncate:
50+
end-before: "# End-for-getting-started-guide"
51+
---
52+
source: includes/steps-run-mongodb-on-a-linux-distribution.yaml
53+
truncate:
54+
end-before: "# End-for-getting-started-guide"
55+
---
56+
source: includes/steps-run-mongodb-on-debian.yaml
57+
truncate:
58+
end-before: "# End-for-getting-started-guide"
59+
---
60+
source: includes/steps-run-mongodb-on-windows.yaml
5461
transform:
55-
- regex: ":doc:`/tutorial/getting-started`"
56-
replace: ":doc:`/client`"
57-
- regex: ":doc:`/administration/production-notes`"
58-
replace: ":manual:`Production Notes </administration/production-notes>`"
62+
- regex: ":doc:"
63+
replace: ":manual:"
64+
truncate:
65+
end-before: "# End-for-getting-started-guide"
5966
---
6067
source: includes/list-mongodb-org-packages.rst
6168
transform:

primer/config/primer-migrations-cpp-examples.yaml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,18 @@ truncate:
55
---
66
source: build/cpp-examples/examples/mongocxx/aggregate.cpp
77
target: includes/example-cpp-group-documents-by-a-field-and-calculate-count.cpp
8+
transform:
9+
regex: "^ "
10+
replace: ""
811
truncate:
912
start-after: "// @begin: cpp-group-documents-by-a-field-and-calculate-count"
1013
end-before: "// @end: cpp-group-documents-by-a-field-and-calculate-count"
1114
---
1215
source: build/cpp-examples/examples/mongocxx/aggregate.cpp
1316
target: includes/example-cpp-filter-and-group-documents.cpp
17+
transform:
18+
regex: "^ "
19+
replace: ""
1420
truncate:
1521
start-after: "// @begin: cpp-filter-and-group-documents"
1622
end-before: "// @end: cpp-filter-and-group-documents"
@@ -22,6 +28,9 @@ truncate:
2228
---
2329
source: build/cpp-examples/examples/mongocxx/create.cpp
2430
target: includes/example-cpp-insert-a-document.cpp
31+
transform:
32+
regex: "^ "
33+
replace: ""
2534
truncate:
2635
start-after: "// @begin: cpp-insert-a-document"
2736
end-before: "// @end: cpp-insert-a-document"
@@ -33,12 +42,18 @@ truncate:
3342
---
3443
source: build/cpp-examples/examples/mongocxx/index.cpp
3544
target: includes/example-cpp-single-field-index.cpp
45+
transform:
46+
regex: "^ "
47+
replace: ""
3648
truncate:
3749
start-after: "// @begin: cpp-single-field-index"
3850
end-before: "// @end: cpp-single-field-index"
3951
---
4052
source: build/cpp-examples/examples/mongocxx/index.cpp
4153
target: includes/example-cpp-create-compound-index.cpp
54+
transform:
55+
regex: "^ "
56+
replace: ""
4257
truncate:
4358
start-after: "// @begin: cpp-create-compound-index"
4459
end-before: "// @end: cpp-create-compound-index"
@@ -50,54 +65,81 @@ truncate:
5065
---
5166
source: build/cpp-examples/examples/mongocxx/query.cpp
5267
target: includes/example-cpp-query-all.cpp
68+
transform:
69+
regex: "^ "
70+
replace: ""
5371
truncate:
5472
start-after: "// @begin: cpp-query-all"
5573
end-before: "// @end: cpp-query-all"
5674
---
5775
source: build/cpp-examples/examples/mongocxx/query.cpp
5876
target: includes/example-cpp-query-top-level-field.cpp
77+
transform:
78+
regex: "^ "
79+
replace: ""
5980
truncate:
6081
start-after: "// @begin: cpp-query-top-level-field"
6182
end-before: "// @end: cpp-query-top-level-field"
6283
---
6384
source: build/cpp-examples/examples/mongocxx/query.cpp
6485
target: includes/example-cpp-query-embedded-document.cpp
86+
transform:
87+
regex: "^ "
88+
replace: ""
6589
truncate:
6690
start-after: "// @begin: cpp-query-embedded-document"
6791
end-before: "// @end: cpp-query-embedded-document"
6892
---
6993
source: build/cpp-examples/examples/mongocxx/query.cpp
7094
target: includes/example-cpp-query-field-in-array.cpp
95+
transform:
96+
regex: "^ "
97+
replace: ""
7198
truncate:
7299
start-after: "// @begin: cpp-query-field-in-array"
73100
end-before: "// @end: cpp-query-field-in-array"
74101
---
75102
source: build/cpp-examples/examples/mongocxx/query.cpp
76103
target: includes/example-cpp-query-greater-than.cpp
104+
transform:
105+
regex: "^ "
106+
replace: ""
77107
truncate:
78108
start-after: "// @begin: cpp-query-greater-than"
79109
end-before: "// @end: cpp-query-greater-than"
80110
---
81111
source: build/cpp-examples/examples/mongocxx/query.cpp
82112
target: includes/example-cpp-query-less-than.cpp
113+
transform:
114+
regex: "^ "
115+
replace: ""
83116
truncate:
84117
start-after: "// @begin: cpp-query-less-than"
85118
end-before: "// @end: cpp-query-less-than"
86119
---
87120
source: build/cpp-examples/examples/mongocxx/query.cpp
88121
target: includes/example-cpp-query-logical-and.cpp
122+
transform:
123+
regex: "^ "
124+
replace: ""
89125
truncate:
90126
start-after: "// @begin: cpp-query-logical-and"
91127
end-before: "// @end: cpp-query-logical-and"
92128
---
93129
source: build/cpp-examples/examples/mongocxx/query.cpp
94130
target: includes/example-cpp-query-logical-or.cpp
131+
transform:
132+
regex: "^ "
133+
replace: ""
95134
truncate:
96135
start-after: "// @begin: cpp-query-logical-or"
97136
end-before: "// @end: cpp-query-logical-or"
98137
---
99138
source: build/cpp-examples/examples/mongocxx/query.cpp
100139
target: includes/example-cpp-query-sort.cpp
140+
transform:
141+
regex: "^ "
142+
replace: ""
101143
truncate:
102144
start-after: "// @begin: cpp-query-sort"
103145
end-before: "// @end: cpp-query-sort"
@@ -109,24 +151,36 @@ truncate:
109151
---
110152
source: build/cpp-examples/examples/mongocxx/remove.cpp
111153
target: includes/example-cpp-remove-matching-documents.cpp
154+
transform:
155+
regex: "^ "
156+
replace: ""
112157
truncate:
113158
start-after: "// @begin: cpp-remove-matching-documents"
114159
end-before: "// @end: cpp-remove-matching-documents"
115160
---
116161
source: build/cpp-examples/examples/mongocxx/remove.cpp
117162
target: includes/example-cpp-remove-justone.cpp
163+
transform:
164+
regex: "^ "
165+
replace: ""
118166
truncate:
119167
start-after: "// @begin: cpp-remove-justone"
120168
end-before: "// @end: cpp-remove-justone"
121169
---
122170
source: build/cpp-examples/examples/mongocxx/remove.cpp
123171
target: includes/example-cpp-remove-all-documents.cpp
172+
transform:
173+
regex: "^ "
174+
replace: ""
124175
truncate:
125176
start-after: "// @begin: cpp-remove-all-documents"
126177
end-before: "// @end: cpp-remove-all-documents"
127178
---
128179
source: build/cpp-examples/examples/mongocxx/remove.cpp
129180
target: includes/example-cpp-drop-collection.cpp
181+
transform:
182+
regex: "^ "
183+
replace: ""
130184
truncate:
131185
start-after: "// @begin: cpp-drop-collection"
132186
end-before: "// @end: cpp-drop-collection"
@@ -138,24 +192,36 @@ truncate:
138192
---
139193
source: build/cpp-examples/examples/mongocxx/update.cpp
140194
target: includes/example-cpp-update-top-level-fields.cpp
195+
transform:
196+
regex: "^ "
197+
replace: ""
141198
truncate:
142199
start-after: "// @begin: cpp-update-top-level-fields"
143200
end-before: "// @end: cpp-update-top-level-fields"
144201
---
145202
source: build/cpp-examples/examples/mongocxx/update.cpp
146203
target: includes/example-cpp-update-embedded-field.cpp
204+
transform:
205+
regex: "^ "
206+
replace: ""
147207
truncate:
148208
start-after: "// @begin: cpp-update-embedded-field"
149209
end-before: "// @end: cpp-update-embedded-field"
150210
---
151211
source: build/cpp-examples/examples/mongocxx/update.cpp
152212
target: includes/example-cpp-update-multiple-documents.cpp
213+
transform:
214+
regex: "^ "
215+
replace: ""
153216
truncate:
154217
start-after: "// @begin: cpp-update-multiple-documents"
155218
end-before: "// @end: cpp-update-multiple-documents"
156219
---
157220
source: build/cpp-examples/examples/mongocxx/update.cpp
158221
target: includes/example-cpp-replace-document.cpp
222+
transform:
223+
regex: "^ "
224+
replace: ""
159225
truncate:
160226
start-after: "// @begin: cpp-replace-document"
161227
end-before: "// @end: cpp-replace-document"

0 commit comments

Comments
 (0)