Skip to content

Commit ac247e9

Browse files
rozzarozza
committed
Docs reorg and added Async connection page
JAVA-1728 JAVA-1732
1 parent 56cdb16 commit ac247e9

Some content is hidden

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

45 files changed

+930
-159
lines changed

‎docs/reference/config.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ title = "MongoDB Java Driver"
44
theme = "mongodb"
55
canonifyurls = false
66

7+
[blackfriday]
8+
plainIdAnchors = true
9+
710
# Example custom menu Item (Useful for linking to API docs)
811
# [[menu.main]]
912
# name = "Issues & Help"

‎docs/reference/content/reference/bson/codecs.md renamed to ‎docs/reference/content/bson/codecs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ date = "2015-03-19T14:27:51-04:00"
33
title = "Codec and CodecRegistry"
44
[menu.main]
55
parent = "BSON"
6-
weight = 10
6+
weight = 40
77
pre = "<i class='fa'></i>"
88
+++
99

‎docs/reference/content/reference/bson/documents.md renamed to ‎docs/reference/content/bson/documents.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ date = "2015-03-19T14:27:51-04:00"
33
title = "Documents"
44
[menu.main]
55
parent = "BSON"
6-
weight = 1
6+
weight = 20
77
pre = "<i class='fa'></i>"
88
+++
99

@@ -93,4 +93,4 @@ collection.find(new BasicDBObject("x", 1));
9393

9494

9595

96-
96+

‎docs/reference/content/reference/bson/extended-json.md renamed to ‎docs/reference/content/bson/extended-json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ date = "2015-03-19T14:27:51-04:00"
33
title = "Extended JSON"
44
[menu.main]
55
parent = "BSON"
6-
weight = 20
6+
weight = 50
77
pre = "<i class='fa'></i>"
88
+++
99

‎docs/reference/content/reference/bson/index.md renamed to ‎docs/reference/content/bson/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
date = "2015-03-19T12:53:30-04:00"
33
title = "BSON"
44
[menu.main]
5-
parent = "Reference"
6-
weight = 10
7-
pre = "<i class='fa'></i>"
5+
identifier = "BSON"
6+
weight = 40
7+
pre = "<i class='fa fa-th'></i>"
88
+++
99

1010
## BSON
1111

12-
The driver comprehensively supports [BSON](http://www.bsonspec.org), the data storage and network transfer format that MongoDB uses for
12+
The BSON library comprehensively supports [BSON](http://www.bsonspec.org), the data storage and network transfer format that MongoDB uses for
1313
“documents". BSON, short for Binary [JSON](http://json.org/), is a binary-encoded serialization of JSON-like documents.
1414

1515
- [Documents]({{< relref "documents.md" >}}): Documentation of the driver's support for BSON document representations

‎docs/reference/content/bson/installation-guide.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
+++
2+
date = "2015-03-17T15:36:56Z"
3+
title = "Installation Guide"
4+
[menu.main]
5+
parent = "BSON"
6+
weight = 50
7+
pre = "<i class='fa'></i>"
8+
+++
9+
10+
# Installation
11+
12+
The BSON library is a required dependency of all the MongoDB Java drivers and if using a dependency management system, it will be
13+
automatically installed alongside the driver, however, it can be used as a standalone library.
14+
The recommended way to get started using one of the drivers in your project is with a dependency management system.
15+
16+
{{< distroPicker >}}
17+
18+
19+
## BSON
20+
21+
This library comprehensively supports [BSON](http://www.bsonspec.org),
22+
the data storage and network transfer format that MongoDB uses for "documents".
23+
BSON is short for Binary [JSON](http://json.org/), is a binary-encoded serialization of JSON-like documents.
24+
25+
{{< install artifactId="bson" version="3.0.0-rc1" >}}

‎docs/reference/content/reference/bson/readers-and-writers.md renamed to ‎docs/reference/content/bson/readers-and-writers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ date = "2015-03-19T14:27:51-04:00"
33
title = "Readers and Writers"
44
[menu.main]
55
parent = "BSON"
6-
weight = 5
6+
weight = 30
77
pre = "<i class='fa'></i>"
88
+++
99

‎docs/reference/content/driver-async/getting-started/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
+++
2+
date = "2015-03-17T15:36:56Z"
3+
title = "Getting Started"
4+
[menu.main]
5+
parent = "MongoDB Async Driver"
6+
identifier = "Async Getting Started"
7+
weight = 30
8+
pre = "<i class='fa fa-road'></i>"
9+
+++
10+
11+
## Getting Started
12+
13+
To help you get started quickly on the new driver, follow:
14+
15+
* [Installation]({{< ref "driver-async/getting-started/installation-guide.md" >}})
16+
* [Quick Tour]({{< ref "driver-async/getting-started/quick-tour.md" >}})
17+
* [Admin Quick Tour]({{< ref "driver-async/getting-started/quick-tour-admin.md" >}})

‎docs/reference/content/driver-async/getting-started/installation-guide.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
+++
2+
date = "2015-03-17T15:36:56Z"
3+
title = "Installation Guide"
4+
[menu.main]
5+
parent = "Async Getting Started"
6+
identifier = "Async Installation Guide"
7+
weight = 1
8+
pre = "<i class='fa'></i>"
9+
+++
10+
11+
# Installation
12+
13+
The recommended way to get started using one of the drivers in your project is with a dependency management system.
14+
15+
{{< distroPicker >}}
16+
17+
## MongoDB Async Driver
18+
The new asynchronous API that can leverage either Netty or Java 7's AsynchronousSocketChannel for fast and non-blocking IO.
19+
20+
{{< install artifactId="mongodb-driver-async" version="3.0.0" >}}

‎docs/reference/content/getting-started/async-quick-tour-admin.md renamed to ‎docs/reference/content/driver-async/getting-started/quick-tour-admin.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
+++
22
date = "2015-03-17T15:36:56Z"
3-
title = "Async Admin Quick Tour"
3+
title = "Admin Quick Tour"
44
[menu.main]
5-
parent = "Getting Started"
5+
parent = "Async Getting Started"
6+
identifier = "Async Admin Quick Tour"
67
weight = 50
78
pre = "<i class='fa'></i>"
89
+++
910

1011
# MongoDB Driver Admin Quick Tour
1112

1213
This is the second part of the MongoDB driver quick tour. In the
13-
[quick tour]({{< relref "getting-started/async-quick-tour.md" >}}) we looked at how to
14+
[quick tour]({{< relref "driver-async/getting-started/quick-tour.md" >}}) we looked at how to
1415
use the Async Java driver to execute basic CRUD operations. In this section we'll look at some of the
1516
administrative features available in the driver.
1617

@@ -19,7 +20,7 @@ that can be found with the [driver
1920
source]({{< srcref "driver-async/src/examples/tour/QuickTourAdmin.java">}}).
2021

2122
{{% note %}}
22-
See the [installation guide]({{< relref "getting-started/installation-guide.md" >}})
23+
See the [installation guide]({{< relref "driver-async/getting-started/installation-guide.md" >}})
2324
for instructions on how to install the MongoDB Driver.
2425
{{% /note %}}
2526

0 commit comments

Comments
 (0)