Skip to content

Commit 20670f6

Browse files
authored
DOCSP-34699 - Serialization reorganization (#144)
1 parent a30cd25 commit 20670f6

File tree

10 files changed

+60
-40
lines changed

10 files changed

+60
-40
lines changed

config/redirects

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,7 @@ raw: ${prefix}/stable -> ${base}/current/
77

88
[*-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/
99
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/change/ -> ${base}/${version}/fundamentals/crud/write-operations/modify/
10+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/guid-serialization/ -> ${base}/${version}/fundamentals/serialization/guid-serialization/
11+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/poco/ -> ${base}/${version}/fundamentals/serialization/poco/
12+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/polymorphism/ -> ${base}/${version}/fundamentals/serialization/polymorphic-objects/
13+
[*-master]: ${prefix}/${version}/fundamentals/class-mapping/ -> ${base}/${version}/fundamentals/serialization/class-mapping/

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ toc_landing_pages = [
55
"/fundamentals/crud",
66
"/usage-examples",
77
"/fundamentals",
8+
"/fundamentals/serialization",
89
]
910

1011
intersphinx = [

source/fundamentals.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,24 @@ Fundamentals
1515
/fundamentals/crud
1616
/fundamentals/builders
1717
/fundamentals/atlas-search
18-
/fundamentals/data-formats
1918
/fundamentals/stable-api
2019
/fundamentals/authentication
2120
/fundamentals/enterprise-authentication
2221
/fundamentals/linq
23-
/fundamentals/class-mapping
22+
/fundamentals/bson
23+
/fundamentals/serialization
2424
/fundamentals/logging
2525
/fundamentals/encrypt-fields
2626

2727
- :ref:`Connecting to MongoDB <csharp-connection>`
2828
- :ref:`csharp-crud`
2929
- :ref:`csharp-builders`
3030
- :ref:`csharp-atlas-search`
31-
- :ref:`csharp-data-formats`
3231
- :ref:`csharp-stable-api`
3332
- :ref:`csharp-authentication-mechanisms`
3433
- :ref:`csharp-enterprise-authentication-mechanisms`
3534
- :ref:`csharp-linq`
36-
- :ref:`csharp-class-mapping`
35+
- :ref:`csharp-bson`
36+
- :ref:`csharp-serialization`
3737
- :ref:`csharp-logging`
3838
- :ref:`Encrypt Fields <csharp-fle>`

source/fundamentals/data-formats/bson.txt renamed to source/fundamentals/bson.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _csharp-bson:
22

3-
==============
4-
Work with BSON
5-
==============
3+
===============
4+
BSON Operations
5+
===============
66

77
.. default-domain:: mongodb
88

@@ -53,7 +53,7 @@ The following code sample shows how to create a ``BsonDocument`` object to repre
5353
example BSON document. Each key-value pair in the ``BsonDocument`` object is a
5454
``BsonElement`` object.
5555

56-
.. literalinclude:: ../../includes/fundamentals/code-examples/Bson.cs
56+
.. literalinclude:: ../includes/fundamentals/code-examples/Bson.cs
5757
:start-after: start-create
5858
:end-before: newRestaurant.Add(new BsonElement("restaurant_id", "12345"));
5959
:language: csharp
@@ -71,7 +71,7 @@ BSON document. The following code sample makes three changes to the previous
7171
#. Removes the ``"cuisine"`` field
7272
#. Sets the value of the ``"name"`` field to ``"Mongo's Pizza Palace"``
7373

74-
.. literalinclude:: ../../includes/fundamentals/code-examples/Bson.cs
74+
.. literalinclude:: ../includes/fundamentals/code-examples/Bson.cs
7575
:start-after: start-create
7676
:end-before: end-change
7777
:language: csharp

source/fundamentals/data-formats.txt

Lines changed: 0 additions & 22 deletions
This file was deleted.

source/fundamentals/data-formats/serialization.txt renamed to source/fundamentals/serialization.txt

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,26 @@
44
Serialization
55
=============
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: class, map, poco, polymorphism, guid, deserialize
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
1017
:depth: 2
1118
:class: singlecol
19+
20+
.. toctree::
21+
:caption: Serialization
22+
23+
/fundamentals/serialization/class-mapping
24+
/fundamentals/serialization/poco
25+
/fundamentals/serialization/polymorphic-objects
26+
/fundamentals/serialization/guid-serialization
1227

1328
Overview
1429
--------
@@ -121,11 +136,19 @@ IBsonArraySerializer
121136
Implementing the `IBsonArraySerializer
122137
<{+api-root+}/T_MongoDB_Bson_Serialization_IBsonArraySerializer.htm>`__
123138
interface enables the driver to access serialization information for individual
124-
items in an array.
139+
items in an array.
125140

126141
Additional Information
127142
----------------------
128143

144+
To learn more about using the {+driver-short+} to serialize {+language+} objects,
145+
see the following pages:
146+
147+
- :ref:`csharp-class-mapping`
148+
- :ref:`csharp-poco`
149+
- :ref:`csharp-polymorphism`
150+
- :ref:`csharp-guids`
151+
129152
To learn more about any of the methods or types discussed in this
130153
guide, see the following API documentation:
131154

source/fundamentals/class-mapping.txt renamed to source/fundamentals/serialization/class-mapping.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,17 @@
44
Class Mapping
55
=============
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: .NET, object, attribute, code example, register, configure
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
10-
:depth: 2
17+
:depth: 2
1118
:class: singlecol
1219

1320
Overview

source/fundamentals/data-formats/guid-serialization.txt renamed to source/fundamentals/serialization/guid-serialization.txt

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
.. _csharp-guids:
22

3-
==================
4-
GUID Serialization
5-
==================
3+
=====
4+
GUIDs
5+
=====
6+
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: .NET, attribute, property, code example, class, map, bson
613

714
.. contents:: On this page
815
:local:

source/fundamentals/data-formats/poco.txt renamed to source/fundamentals/serialization/poco.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _csharp-poco:
22

3-
===============
4-
Work with POCOs
5-
===============
3+
=====
4+
POCOs
5+
=====
66

77
.. contents:: On this page
88
:local:

source/fundamentals/data-formats/polymorphism.txt renamed to source/fundamentals/serialization/polymorphic-objects.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Polymorphic Objects
1515
:values: reference
1616

1717
.. meta::
18-
:keywords: inheritance, child, parent, hierarchy, derived, base, serialize, deserialize, root
18+
:keywords: .NET, object, attribute, inheritance, child, parent, hierarchy, derived, base, serialize, deserialize, root
1919

2020
Overview
2121
--------

0 commit comments

Comments
 (0)