Skip to content

[Ruby] TOC Reorg #160

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
31 changes: 31 additions & 0 deletions config/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,34 @@ raw: ${prefix}/stable -> ${base}/current/
(v2.20-*]: ${prefix}/${version}/reference/search-indexes/ -> ${base}/${version}/indexes/atlas-search-index/
(v2.20-*]: ${prefix}/${version}/reference/collations/ -> ${base}/${version}/read/collations/
(v2.20-*]: ${prefix}/${version}/contribute/ -> ${base}/${version}/issues-and-help/

# Comprehensive coverage TOC shift

(*-master) ${prefix}/${version}/get-started/download-and-install/ -> ${base}/${version}/get-started/
(*-master) ${prefix}/${version}/get-started/create-a-deployment/ -> ${base}/${version}/get-started/
(*-master) ${prefix}/${version}/get-started/create-a-connection-string/ -> ${base}/${version}/get-started/
(*-master) ${prefix}/${version}/get-started/connect-to-mongodb/ -> ${base}/${version}/get-started/
(*-master) ${prefix}/${version}/get-started/next-steps/ -> ${base}/${version}/get-started/
(*-master) ${prefix}/${version}/databases-collections/ -> ${base}/${version}/get-started/
(*-master) ${prefix}/${version}/write/insert/ -> ${base}/${version}/crud/insert/
(*-master) ${prefix}/${version}/read/retrieve/ -> ${base}/${version}/crud/query/
(*-master) ${prefix}/${version}/write/update/ -> ${base}/${version}/crud/update/
(*-master) ${prefix}/${version}/write/replace/ -> ${base}/${version}/crud/replace/
(*-master) ${prefix}/${version}/write/delete/ -> ${base}/${version}/crud/delete/
(*-master) ${prefix}/${version}/write/bulk-write/ -> ${base}/${version}/crud/bulk-write/
(*-master) ${prefix}/${version}/write/transactions/ -> ${base}/${version}/crud/transactions/
(*-master) ${prefix}/${version}/read-write-pref/ -> ${base}/${version}/crud/configure-crud/
(*-master) ${prefix}/${version}/read/collations/ -> ${base}/${version}/crud/collations/
(*-master) ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/crud/gridfs/
(*-master) ${prefix}/${version}/read/count/ -> ${base}/${version}/crud/query/count
(*-master) ${prefix}/${version}/read/retrieve/ -> ${base}/${version}/crud/query/find
(*-master) ${prefix}/${version}/read/project/ -> ${base}/${version}/crud/query/project
(*-master) ${prefix}/${version}/read/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents-to-return
(*-master) ${prefix}/${version}/read/distinct/ -> ${base}/${version}/crud/query/distinct
(*-master) ${prefix}/${version}/read/cursors/ -> ${base}/${version}/crud/query/cursors
(*-master) ${prefix}/${version}/read/specify-a-query/ -> ${base}/${version}/crud/query/specify-a-query
(*-master) ${prefix}/${version}/databases-collections/run-command -> ${base}/${version}/run-command
(*-master) ${prefix}/${version}/monitoring/cluster-monitoring -> ${base}/${version}/logging-and-monitoring/cluster-monitoring
(*-master) ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/logging-and-monitoring/change-streams
(*-master) ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls
(*-master) ${prefix}/${version}/common-errors/ -> ${base}/${version}/
7 changes: 2 additions & 5 deletions snooty.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
name = "ruby-driver"
title = "Ruby Driver"
toc_landing_pages = [
"/get-started",
"/read",
"/write",
"/crud/query",
"/indexes",
"/databases-collection",
"/security/authentication",
"/security/authentication"
]

intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"]
Expand Down
5 changes: 5 additions & 0 deletions source/atlas-search.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. _ruby-atlas-search

============
Atlas Search
============
20 changes: 20 additions & 0 deletions source/crud.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
===============
CRUD Operations
===============

.. toctree::
:titlesonly:
:maxdepth: 1

Insert Documents </crud/insert>
Query Documents </crud/query>
Update Documents </crud/update>
Replace Documents </crud/replace>
Delete Documents </crud/delete>
Bulk Write Operations </crud/bulk-write>
Transactions </crud/transactions>
Configure CRUD Operations </crud/configure-crud>
Retryable Reads </crud/retryable-reads>
Retryable Writes </crud/retryable-writes>
Collation </crud/collations>
Store Large Files </crud/gridfs>
File renamed without changes.
2 changes: 1 addition & 1 deletion source/read/collations.txt → source/crud/collations.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _ruby-collations:

==========
Collations
Collation
==========

.. default-domain:: mongodb
Expand Down
6 changes: 3 additions & 3 deletions source/read-write-pref.txt → source/crud/configure-crud.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _ruby-crud-write-read-pref:

===============================
CRUD Operations on Replica Sets
===============================
=========================
Configure CRUD Operations
=========================

.. facet::
:name: genre
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
20 changes: 16 additions & 4 deletions source/read.txt → source/crud/query.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _ruby-read:

======================
Read Data from MongoDB
======================
===============
Query Documents
===============

.. contents:: On this page
:local:
Expand All @@ -23,7 +23,6 @@ Read Data from MongoDB
:maxdepth: 1

Retrieve Data </read/retrieve>
Specify a Query </read/specify-a-query>
Specify Documents to Return </read/specify-documents-to-return>
Specify Fields to Return </read/project>
Distinct Field Values </read/distinct>
Expand All @@ -32,6 +31,19 @@ Read Data from MongoDB
Monitor Changes </read/change-streams>
Collations </read/collations>


.. toctree::
:titlesonly:
:maxdepth: 1

Find Documents </crud/query/find>
Specify a Query </read/specify-a-query>
Specify Documents to Return </crud/query/project/specify-documents-to-return>
Specify Fields to Return </crud/query/project>
Count Documents </crud/query/count>
Distinct Field Values </crud/query/distinct>
Access Data from a Cursor </crud/query/cursors>

Overview
--------

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions source/read/retrieve.txt → source/crud/query/find.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _ruby-retrieve:

=============
Retrieve Data
=============
==============
Find Documents
==============

.. contents:: On this page
:local:
Expand All @@ -15,7 +15,7 @@ Retrieve Data
:values: reference

.. meta::
:keywords: code examples, read, query, cursor
:keywords: code examples, read, query, cursor, find

Overview
--------
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
18 changes: 18 additions & 0 deletions source/crud/retryable-reads.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. _ruby-crud-retryable-reads:

===============
Retryable Reads
===============

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: timeout

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol
18 changes: 18 additions & 0 deletions source/crud/retryable-writes.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. _ruby-crud-retryable-writes:

================
Retryable Writes
================

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: timeout

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol
File renamed without changes.
File renamed without changes.
Loading
Loading