From fb116971d2fc6c170b252891b8fc79c6bcec8cd5 Mon Sep 17 00:00:00 2001 From: Michael Morisi Date: Mon, 2 Jun 2025 11:33:35 -0400 Subject: [PATCH 1/5] DOCSP-50338: Reorganize Data Formats pages --- source/document-formats.txt | 24 +++++++++++++++++++ .../bson.txt | 0 .../extended-json.txt | 0 source/index.txt | 18 ++++++++++++++ .../custom-types => }/serialization.txt | 10 +++++++- .../class-mapping.txt | 0 .../custom-types.txt | 0 .../{data-formats => serialization}/guids.txt | 0 .../custom-types => serialization}/poco.txt | 0 .../polymorphic-objects.txt | 0 source/{data-formats => }/time-series.txt | 0 11 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 source/document-formats.txt rename source/{data-formats => document-formats}/bson.txt (100%) rename source/{data-formats => document-formats}/extended-json.txt (100%) rename source/{data-formats/custom-types => }/serialization.txt (96%) rename source/{data-formats/custom-types => serialization}/class-mapping.txt (100%) rename source/{data-formats => serialization}/custom-types.txt (100%) rename source/{data-formats => serialization}/guids.txt (100%) rename source/{data-formats/custom-types => serialization}/poco.txt (100%) rename source/{data-formats/custom-types => serialization}/polymorphic-objects.txt (100%) rename source/{data-formats => }/time-series.txt (100%) diff --git a/source/document-formats.txt b/source/document-formats.txt new file mode 100644 index 00000000..c7ade3ef --- /dev/null +++ b/source/document-formats.txt @@ -0,0 +1,24 @@ +.. _csharp-document-formats: + +================ +Document Formats +================ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: bson, json, object, notation, read, write + +.. toctree:: + :caption: Document Formats + + BSON + Extended JSON diff --git a/source/data-formats/bson.txt b/source/document-formats/bson.txt similarity index 100% rename from source/data-formats/bson.txt rename to source/document-formats/bson.txt diff --git a/source/data-formats/extended-json.txt b/source/document-formats/extended-json.txt similarity index 100% rename from source/data-formats/extended-json.txt rename to source/document-formats/extended-json.txt diff --git a/source/index.txt b/source/index.txt index 50626999..6b0a5b6b 100644 --- a/source/index.txt +++ b/source/index.txt @@ -23,8 +23,11 @@ MongoDB C# Driver Run a Database Command Atlas Search Atlas Vector Search + Time Series Logging and Monitoring Security + Serialization + Document Formats Integrations Reference API Documentation <{+api-root+}> @@ -96,6 +99,11 @@ rather than keyword matches in the `Atlas Vector Search `__ documentation. +Time Series +----------- + +Learn how to work with time series collections in the :ref:`csharp-time-series` section. + Logging and Monitoring ---------------------- @@ -108,6 +116,16 @@ Secure Your Data Learn about ways you can authenticate your application and encrypt your data in the :ref:`csharp-security` section. +Serialization +------------- + +Learn how to serialize and deserialize data in the :ref:`csharp-serialization` section. + +Document Formats +---------------- + +Learn about different notations you can use to read and write data in the :ref:`csharp-document-formats` section. + Reference --------- diff --git a/source/data-formats/custom-types/serialization.txt b/source/serialization.txt similarity index 96% rename from source/data-formats/custom-types/serialization.txt rename to source/serialization.txt index af352a0b..f652628c 100644 --- a/source/data-formats/custom-types/serialization.txt +++ b/source/serialization.txt @@ -16,7 +16,15 @@ Serialization :backlinks: none :depth: 2 :class: singlecol - + +.. toctree:: + :caption: Custom Types + + Class Mapping + POCOs + Polymorphic Objects + GUIDs + Overview -------- diff --git a/source/data-formats/custom-types/class-mapping.txt b/source/serialization/class-mapping.txt similarity index 100% rename from source/data-formats/custom-types/class-mapping.txt rename to source/serialization/class-mapping.txt diff --git a/source/data-formats/custom-types.txt b/source/serialization/custom-types.txt similarity index 100% rename from source/data-formats/custom-types.txt rename to source/serialization/custom-types.txt diff --git a/source/data-formats/guids.txt b/source/serialization/guids.txt similarity index 100% rename from source/data-formats/guids.txt rename to source/serialization/guids.txt diff --git a/source/data-formats/custom-types/poco.txt b/source/serialization/poco.txt similarity index 100% rename from source/data-formats/custom-types/poco.txt rename to source/serialization/poco.txt diff --git a/source/data-formats/custom-types/polymorphic-objects.txt b/source/serialization/polymorphic-objects.txt similarity index 100% rename from source/data-formats/custom-types/polymorphic-objects.txt rename to source/serialization/polymorphic-objects.txt diff --git a/source/data-formats/time-series.txt b/source/time-series.txt similarity index 100% rename from source/data-formats/time-series.txt rename to source/time-series.txt From 2336daa40b62641047af291ea377c34b6c7b7531 Mon Sep 17 00:00:00 2001 From: Michael Morisi Date: Mon, 2 Jun 2025 11:35:24 -0400 Subject: [PATCH 2/5] Fix --- snooty.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 00aa0586..a97c0c42 100644 --- a/snooty.toml +++ b/snooty.toml @@ -3,7 +3,8 @@ toc_landing_pages = [ "/connect/connection-options", "/security/authentication", "/aggregation", - "/aggregation/stages" + "/aggregation/stages", + "/serialization" ] name = "csharp" title = "C#/.NET" From a9d6cec618c51265f348cde1387fc456af3d21a7 Mon Sep 17 00:00:00 2001 From: Michael Morisi Date: Mon, 2 Jun 2025 11:51:10 -0400 Subject: [PATCH 3/5] Fix redirects --- config/redirects | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/config/redirects b/config/redirects index 0f70d847..1e61969b 100644 --- a/config/redirects +++ b/config/redirects @@ -61,8 +61,8 @@ raw: ${prefix}/master -> ${base}/upcoming/ [*-master]: ${prefix}/${version}/fundamentals/gridfs/ -> ${base}/${version}/crud/gridfs/ [*-master]: ${prefix}/${version}/fundamentals/specify-query/ -> ${base}/${version}/crud/query/specify-query/ [*-master]: ${prefix}/${version}/fundamentals/transactions/ -> ${base}/${version}/crud/transactions/ -[*-master]: ${prefix}/${version}/fundamentals/bson/ -> ${base}/${version}/data-formats/bson/ -[*-master]: ${prefix}/${version}/fundamentals/time-series/ -> ${base}/${version}/data-formats/time-series/ +[*-master]: ${prefix}/${version}/fundamentals/bson/ -> ${base}/${version}/document-formats/bson/ +[*-master]: ${prefix}/${version}/fundamentals/time-series/ -> ${base}/${version}/time-series/ [*-master]: ${prefix}/${version}/fundamentals/logging/ -> ${base}/${version}/logging-and-monitoring/logging/ [*-master]: ${prefix}/${version}/fundamentals/monitoring/ -> ${base}/${version}/logging-and-monitoring/monitoring/ [*-master]: ${prefix}/${version}/fundamentals/database-collection/ -> ${base}/${version}/databases-collections/ @@ -82,10 +82,10 @@ raw: ${prefix}/master -> ${base}/upcoming/ [*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-one/ -> ${base}/${version}/crud/update-one/ [*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-one/arrays/ -> ${base}/${version}/crud/update-one/arrays/ [*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-one/fields/ -> ${base}/${version}/crud/update-one/fields/ -[*-master]: ${prefix}/${version}/fundamentals/serialization/class-mapping/ -> ${base}/${version}/data-formats/custom-types/class-mapping/ -[*-master]: ${prefix}/${version}/fundamentals/serialization/poco/ -> ${base}/${version}/data-formats/custom-types/poco/ -[*-master]: ${prefix}/${version}/fundamentals/serialization/polymorphic-objects/ -> ${base}/${version}/data-formats/custom-types/polymorphic-objects/ -[*-master]: ${prefix}/${version}/fundamentals/serialization/ -> ${base}/${version}/data-formats/custom-types/serialization/ +[*-master]: ${prefix}/${version}/fundamentals/serialization/class-mapping/ -> ${base}/${version}/serialization/class-mapping/ +[*-master]: ${prefix}/${version}/fundamentals/serialization/poco/ -> ${base}/${version}/serialization/poco/ +[*-master]: ${prefix}/${version}/fundamentals/serialization/polymorphic-objects/ -> ${base}/${version}/serialization/polymorphic-objects/ +[*-master]: ${prefix}/${version}/fundamentals/serialization/ -> ${base}/${version}/serialization/ [*-master]: ${prefix}/${version}/fundamentals/databases-collections/run-command/ -> ${base}/${version}/run-command/ [*-master]: ${prefix}/${version}/fundamentals/authentication/ -> ${base}/${version}/security/authentication/ [*-master]: ${prefix}/${version}/fundamentals/authentication/aws-iam/ -> ${base}/${version}/security/authentication/aws-iam/ From 32c6a06e6034736a3fdc0e07b309a91b07c2d97e Mon Sep 17 00:00:00 2001 From: Michael Morisi Date: Mon, 2 Jun 2025 12:24:51 -0400 Subject: [PATCH 4/5] NR feedback --- source/data-formats.txt | 41 --------------------------- source/document-formats.txt | 5 ++++ source/serialization/custom-types.txt | 26 ----------------- 3 files changed, 5 insertions(+), 67 deletions(-) delete mode 100644 source/data-formats.txt delete mode 100644 source/serialization/custom-types.txt diff --git a/source/data-formats.txt b/source/data-formats.txt deleted file mode 100644 index 7bd3b913..00000000 --- a/source/data-formats.txt +++ /dev/null @@ -1,41 +0,0 @@ -.. _csharp-data-formats: - -======================== -Specialized Data Formats -======================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. facet:: - :name: genre - :values: reference - -.. meta:: - :keywords: bson, guid, serialization, extended json, custom types, time series - -.. toctree:: - :titlesonly: - :maxdepth: 1 - - BSON - Extended JSON - Custom Types - GUIDs - Time Series Data - -Overview --------- - -You can use several types of specialized data formats in your {+driver-short+} -application. To learn how to work with these data formats, see the following -sections: - -- Learn how to work with BSON documents in the :ref:`csharp-bson` guide. -- Learn how to translate BSON to Extended JSON in the :ref:`csharp-extended-json` guide. -- Learn how to serialize custom types in the :ref:`csharp-custom-types` guide. -- Learn about globally unique identifiers (GUIDs) and how to maintain cross-language - compatibility while working with them in the :ref:`csharp-guids` guide. \ No newline at end of file diff --git a/source/document-formats.txt b/source/document-formats.txt index c7ade3ef..aec17602 100644 --- a/source/document-formats.txt +++ b/source/document-formats.txt @@ -22,3 +22,8 @@ Document Formats BSON Extended JSON + +Learn about using different document formats with the {+driver-short+} in the following guides: + +- :ref:`csharp-bson` +- :ref:`csharp-extended-json` \ No newline at end of file diff --git a/source/serialization/custom-types.txt b/source/serialization/custom-types.txt deleted file mode 100644 index d05e1fc3..00000000 --- a/source/serialization/custom-types.txt +++ /dev/null @@ -1,26 +0,0 @@ -.. _csharp-custom-types: - -============ -Custom Types -============ - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. facet:: - :name: genre - :values: reference - -.. meta:: - :keywords: polymorphism, serialization, deserialization, poco - -.. toctree:: - :caption: Custom Types - - Class Mapping - POCOs - Polymorphic Objects - Serialization \ No newline at end of file From 40810bf81b79e0ba3e8852d849eccd190b48a268 Mon Sep 17 00:00:00 2001 From: Michael Morisi Date: Mon, 2 Jun 2025 14:06:17 -0400 Subject: [PATCH 5/5] NR feedback 2 --- source/index.txt | 7 ------- 1 file changed, 7 deletions(-) diff --git a/source/index.txt b/source/index.txt index 6b0a5b6b..682b8914 100644 --- a/source/index.txt +++ b/source/index.txt @@ -18,7 +18,6 @@ MongoDB C# Driver Databases & Collections CRUD Operations Aggregation - Data Formats Indexes Run a Database Command Atlas Search @@ -68,12 +67,6 @@ Transform Your Data with Aggregation Learn how to use the {+driver-short+} to perform aggregation operations in the :ref:`csharp-aggregation` section. -Data Formats ------------- - -Learn how to work with specialized data formats and custom types in the -:ref:`csharp-data-formats` section. - Optimize Queries with Indexes -----------------------------