Skip to content

DOCS-15883 update left-nav for mongo mongosh #5351

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.

Sign up for GitHub

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 1 commit into from
May 14, 2021
Merged

DOCS-15883 update left-nav for mongo mongosh #5351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions snooty.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ toc_landing_pages = [
"/reference/method/js-role-management",
"/reference/method/js-sharding",
"/reference/method/js-user-management",
"/reference/mongo",
"/reference/operator/aggregation-pipeline",
"/reference/operator/aggregation",
"/reference/operator/query-array",
Expand Down
3 changes: 1 addition & 2 deletions source/contents.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ project, this Manual and additional editions of this text.

- :doc:`/introduction`
- :doc:`/installation`
- :doc:`/mongo`
- :doc:`/crud`
- :doc:`/aggregation`
- :doc:`/data-modeling`
Expand All @@ -35,7 +34,7 @@ project, this Manual and additional editions of this text.

Introduction </introduction>
Installation </installation>
/mongo
MongoDB Shell (mongosh) <https://docs.mongodb.com/mongodb-shell/>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Minor: Can we use a monospaced font for mongosh here to be consistent with how it's displayed in References?

Copy link
Author

Choose a reason for hiding this comment

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

The top level entry is a link to a page in another repo. Unfortunately we can't use markup. The link in the References section picks up its formatting from a page within the docs repo so we can modify it there.

It's a little inconsistent, but rather than remove the formatting from References to match the top-level entry, I'm going to leave refernce/mongosh in monospace since that keeps the copy on the linked page consistent with usage elsewhere in the docs.

Let me know if we should try to find a different resolution

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds good.

/crud
/aggregation
/data-modeling
Expand Down
2 changes: 1 addition & 1 deletion source/includes/driver-examples/driver-example-indexes-2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.. note::

The following examples illustrate indexes and collation in
the :doc:`Mongo Shell </mongo/>`.
:mongosh:`mongosh </>`.

Refer to the
:compass:`MongoDB Compass Documentation
Expand Down
2 changes: 1 addition & 1 deletion source/includes/fact-collation-driver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. note::

The following examples illustrate indexes and collation in
the :doc:`Mongo Shell </mongo/>`.
the :mongosh:`mongosh </>`.

Refer to your :api:`driver documentation <>` for
instructions on creating indexes with collation in your specific
Expand Down
1 change: 1 addition & 0 deletions source/includes/footnote-set-shell-batch-size.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.. [#set-shell-batch-size] You can set the ``DBQuery.shellBatchSize``
attribute to change the number of documents from the default value of
``20``.

2 changes: 1 addition & 1 deletion source/includes/steps-run-mongodb-on-linux-tarball.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ post: |

For more information on connecting using the :binary:`~bin.mongo`
shell, such as to connect to a :binary:`~bin.mongod` instance running
on a different host and/or port, see :doc:`/mongo`.
on a different host and/or port, see :doc:`/reference/mongo`.

To help you start using MongoDB, MongoDB provides :ref:`Getting
Started Guides <getting-started>` in various driver editions. For the
Expand Down
2 changes: 1 addition & 1 deletion source/includes/steps-run-mongodb-on-linux.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ post: |

For more information on connecting using the :binary:`~bin.mongo`
shell, such as to connect to a :binary:`~bin.mongod` instance running
on a different host and/or port, see :doc:`/mongo`.
on a different host and/or port, see :doc:`/reference/mongo`.

To help you start using MongoDB, MongoDB provides :ref:`Getting
Started Guides <getting-started>` in various driver editions. For the
Expand Down
2 changes: 1 addition & 1 deletion source/includes/steps-run-mongodb-on-osx.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ post: |

For more information on connecting using the :binary:`~bin.mongo`
shell, such as to connect to a :binary:`~bin.mongod` instance running
on a different host and/or port, see :doc:`/mongo`.
on a different host and/or port, see :doc:`/reference/mongo`.

To help you start using MongoDB, MongoDB provides :ref:`Getting
Started Guides <getting-started>` in various driver editions. See
Expand Down
2 changes: 1 addition & 1 deletion source/includes/steps-run-mongodb-on-windows.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ content: |

For more information on connecting a :binary:`mongo.exe <bin.mongo>`
shell, such as to connect to a MongoDB instance running on a different
host and/or port, see :doc:`/mongo`. For information on CRUD
host and/or port, see :doc:`/reference/mongo`. For information on CRUD
(Create,Read,Update,Delete) operations, see:

- :doc:`/tutorial/insert-documents`
Expand Down
9 changes: 7 additions & 2 deletions source/reference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@ Reference
command>` operations, syntax, and use.

:doc:`/reference/method`
Documentation of all JavaScript methods and helpers in the
:binary:`~bin.mongo` shell.
Documentation of JavaScript methods and helpers in
:mongosh:`mongosh </>`.

:doc:`/reference/mongo`
Documentation of JavaScript methods and helpers in
the legacy :binary:`~bin.mongo` shell.

:doc:`/reference/program`
Documentation of :binary:`~bin.mongod` and :binary:`~bin.mongos`
Expand Down Expand Up @@ -95,6 +99,7 @@ Reference
/reference/operator
/reference/command
/reference/method
/reference/mongo
/reference/program
/reference/configuration-options
/reference/parameters
Expand Down
23 changes: 18 additions & 5 deletions source/mongo.txt → source/reference/mongo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
===================
The ``mongo`` Shell
===================
======================
Legacy ``mongo`` Shell
======================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

.. note::

The ``mongo`` shell has been deprecated in MongoDB v5.0. The
Expand Down Expand Up @@ -44,8 +50,15 @@ The list of methods supported by ``mongosh`` is here:

.. seealso::

- :doc:`Getting Started Guide for the mongo Shell
</tutorial/getting-started>`
- :binary:`~bin.mongo` Reference Page
- :mongosh:`mongosh Documentation </>`

.. toctree::
:titlesonly:

/tutorial/configure-mongo-shell
/tutorial/access-mongo-shell-help
/tutorial/write-scripts-for-the-mongo-shell
/core/shell-types
/reference/mongo-shell

2 changes: 1 addition & 1 deletion source/reference/program/mongo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1420,7 +1420,7 @@ to enclose the JavaScript, using the following form:

- :doc:`/reference/mongo-shell`
- :doc:`/reference/method`
- :doc:`/mongo`
- :doc:`/reference/mongo`
- :method:`isInteractive()`


2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-enterprise-on-windows.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Interpreter` with Administrative privileges and run:

For more information on connecting a :binary:`mongo.exe <bin.mongo>`
shell, such as to connect to a MongoDB instance running on a different
host and/or port, see :doc:`/mongo`. For information on CRUD
host and/or port, see :doc:`/reference/mongo`. For information on CRUD
(Create,Read,Update,Delete) operations, see:

- :doc:`/tutorial/insert-documents`
Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-on-windows.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Interpreter` with Administrative privileges and run:

For more information on connecting a :binary:`mongo.exe <bin.mongo>`
shell, such as to connect to a MongoDB instance running on a different
host and/or port, see :doc:`/mongo`. For information on CRUD
host and/or port, see :doc:`/reference/mongo`. For information on CRUD
(Create,Read,Update,Delete) operations, see:

- :doc:`/tutorial/insert-documents`
Expand Down