Skip to content

Commit d00cf49

Browse files
committed
Reorganization of the reference content
1 parent dd60a17 commit d00cf49

File tree

10 files changed

+54
-14
lines changed

10 files changed

+54
-14
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
+++
22
date = "2015-03-19T14:27:51-04:00"
33
draft = true
4-
title = "JSON support"
4+
title = "Extended JSON"
55
[menu.main]
6-
parent = "Reference"
6+
parent = "BSON"
77
weight = 50
88
pre = "<i class='fa'></i>"
99
+++
1010

11-
## JSON Support
11+
## MongoDB Extended JSON
1212

1313
The Java driver supports reading and writing JSON documents with the [JsonReader]({{< apiref "org/bson/json/JsonReader" >}}) and
1414
[JsonWriter]({{< apiref "org/bson/json/JsonWriter" >}}) classes, which can read/write both flavors of
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
date = "2015-03-19T12:53:30-04:00"
3+
draft = true
4+
title = "BSON"
5+
[menu.main]
6+
parent = "Reference"
7+
weight = 10
8+
pre = "<i class='fa'></i>"
9+
+++
10+
11+
## BSON
12+
13+
The driver comprehensively supports [BSON](http://www.bsonspec.org), the data storage and network transfer format for “documents”.
14+
15+
- [MongoDB Extended JSON]({{< relref "extended-json.md" >}})

docs/reference/content/reference/authenticating.md renamed to docs/reference/content/reference/connecting/authenticating.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
date = "2015-03-19T14:27:51-04:00"
33
title = "Authenticating"
44
[menu.main]
5-
parent = "Reference"
6-
weight = 35
5+
parent = "Connecting"
6+
weight = 20
77
pre = "<i class='fa'></i>"
88
+++
99

File renamed without changes.

docs/reference/content/reference/ssl.md renamed to docs/reference/content/reference/connecting/ssl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ date = "2015-03-19T12:53:26-04:00"
33
draft = true
44
title = "SSL"
55
[menu.main]
6-
parent = "Reference"
7-
weight = 32
6+
parent = "Connecting"
7+
weight = 10
88
pre = "<i class='fa'></i>"
99
+++
1010

docs/reference/content/reference/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ title = "Reference"
66
pre = "<i class='fa fa-book'></i>"
77
+++
88

9-
## MongoDB Java Driver Reference Documentation
9+
## Reference Page index
10+
11+
The reference documentation is not an API reference. You can review those [here](http://api.mongodb.org/java/3.0/). Instead, the
12+
reference documentation will focus on high-level documentation and use-cases.
13+
14+
- [BSON]({{< relref "reference/bson/index.md" >}})
15+
- [Connecting]({{< relref "reference/connecting/index.md" >}})
16+
- [Management]({{< relref "reference/management/index.md" >}})
1017

11-
This is the reference documentation. Not sure what to say yet at the top level.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
date = "2015-03-19T14:27:51-04:00"
3+
title = "Management"
4+
[menu.main]
5+
parent = "Reference"
6+
weight = 80
7+
pre = "<i class='fa'></i>"
8+
+++
9+
10+
## Management
11+
12+
The driver provides two mechanisms for examining its state:
13+
14+
- [Logging]({{< relref "logging.md" >}}): Comprehensive logging of all operations using [SLF4J](http://www.slf4j.org/)
15+
- [Management]({{< relref "monitoring.md" >}}): Built on [JMX](http://docs.oracle.com/javase/8/docs/technotes/guides/jmx/)

docs/reference/content/reference/logging.md renamed to docs/reference/content/reference/management/logging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
date = "2015-03-18T21:14:20-04:00"
33
title = "Logging"
44
[menu.main]
5-
parent = "Reference"
6-
weight = 90
5+
parent = "Management"
6+
weight = 10
77
pre = "<i class='fa'></i>"
88
+++
99

docs/reference/content/reference/monitoring.md renamed to docs/reference/content/reference/management/monitoring.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,18 @@
22
date = "2015-03-19T12:53:26-04:00"
33
title = "Monitoring"
44
[menu.main]
5-
parent = "Reference"
5+
parent = "Management"
66
weight = 100
77
pre = "<i class='fa'></i>"
88
+++
99

1010
# Monitoring
1111

12-
The driver currently MXBean instances of a single type:
12+
The driver uses [JMX](http://docs.oracle.com/javase/8/docs/technotes/guides/jmx/) to create
13+
[MXBeans](http://docs.oracle.com/javase/tutorial/jmx/mbeans/mxbeans.html) that allow an
14+
application or end user to monitor various aspects of the driver.
15+
16+
The driver creates MXBean instances of a single type:
1317
[ConnectionPoolStatisticsMBean](http://api.mongodb.org/java/3.0/com/mongodb/management/ConnectionPoolStatisticsMBean.html).
1418
The driver registers one `ConnectionPoolStatisticsMBean` instance per each server it connects to. For example, in the case of a replica
1519
set, the driver creates an instance per each non-hidden member of the replica set.

docs/reference/content/whats-new/upgrading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Before upgrading to 3.0.0, compile against 2.13.0 with deprecation warnings enab
1919
The minimum JVM is now Java 6: however, specific features require Java 7:
2020

2121
- SSL support requires Java 7 in order to perform host name verification, which is enabled by default. See
22-
[SSL]({{< relref "connecting.md#SSL" >}}) for details on how to disable host name verification.
22+
[SSL]({{< relref "reference/connecting/ssl.md" >}}) for details on how to disable host name verification.
2323
- The asynchronous API requires Java 7, as by default it relies on
2424
[AsynchronousSocketChannel](http://docs.oracle.com/javase/7/docs/api/java/nio/channels/AsynchronousSocketChannel.html) for
2525
its implementation. See [Async]({{< ref "async" >}}) for details on configuring the driver to use [Netty](http://netty.io/) instead.

0 commit comments

Comments
 (0)