Skip to content

DOCSP-50338: Reorganize Data Formats pages #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions config/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand All @@ -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/
Expand Down
3 changes: 2 additions & 1 deletion snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ toc_landing_pages = [
"/connect/connection-options",
"/security/authentication",
"/aggregation",
"/aggregation/stages"
"/aggregation/stages",
"/serialization"
]
name = "csharp"
title = "C#/.NET"
Expand Down
41 changes: 0 additions & 41 deletions source/data-formats.txt

This file was deleted.

26 changes: 0 additions & 26 deletions source/data-formats/custom-types.txt

This file was deleted.

29 changes: 29 additions & 0 deletions source/document-formats.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _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 </document-formats/bson>
Extended JSON </document-formats/extended-json>

Learn about using different document formats with the {+driver-short+} in the following guides:

- :ref:`csharp-bson`
- :ref:`csharp-extended-json`
File renamed without changes.
25 changes: 18 additions & 7 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ MongoDB C# Driver
Databases & Collections </databases-collections>
CRUD Operations </crud>
Aggregation </aggregation>
Data Formats </data-formats>
Indexes </indexes>
Run a Database Command </run-command>
Atlas Search </atlas-search>
Atlas Vector Search </atlas-vector-search>
Time Series </time-series>
Logging and Monitoring </logging-and-monitoring>
Security </security>
Serialization </serialization>
Document Formats </document-formats>
Comment on lines +28 to +29
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: in this reorg, is the goal to move all the content from "Data Formats" into either "Serialization" or "Document Formats"? In that case should you delete the "Data Formats" page? right now it's just a landing page with no L2 pages

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also the empty "Custom Types" page is linked on "Data Formats"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix!

Integrations </integrations>
Reference </reference>
API Documentation <{+api-root+}>
Expand Down Expand Up @@ -65,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
-----------------------------

Expand All @@ -96,6 +92,11 @@ rather than keyword matches in the
`Atlas Vector Search <https://www.mongodb.com/docs/atlas/atlas-search/tutorial/>`__
documentation.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I: you can remove the Data Formats section from lines 71-75

Time Series
-----------

Learn how to work with time series collections in the :ref:`csharp-time-series` section.

Logging and Monitoring
----------------------

Expand All @@ -108,6 +109,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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I: I can't comment on the page directly, but serialization/custom-types is just a blank page. did you mean to delete it or is there missing content?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's also not accessible in the Serialization drawer, only if you go to the link directly

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will delete that page!


Document Formats
----------------

Learn about different notations you can use to read and write data in the :ref:`csharp-document-formats` section.

Reference
---------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,15 @@ Serialization
:backlinks: none
:depth: 2
:class: singlecol


.. toctree::
:caption: Custom Types

Class Mapping </serialization/class-mapping>
POCOs </serialization/custom-types/poco>
Polymorphic Objects </serialization/polymorphic-objects>
GUIDs </serialization/guids>

Overview
--------

Expand Down
File renamed without changes.
File renamed without changes.
Loading