Skip to content

Commit 0dfb109

Browse files
Adding upgrade instructions and learning resources to compass docs
1 parent 2e1beb9 commit 0dfb109

File tree

5 files changed

+202
-16
lines changed

5 files changed

+202
-16
lines changed

source/index.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,41 +87,41 @@ suit your needs.
8787
- |checkmark|
8888
- |checkmark|
8989
- |checkmark|
90-
90+
9191
* - Create and delete :ref:`indexes <compass-indexes>`
9292
- |checkmark|
9393
- |checkmark|
9494
-
9595
- |checkmark|
9696

97-
* - View and optimize query performance with visual
97+
* - View and optimize query performance with visual
9898
:ref:`explain plans <explain-plans>`
9999
- |checkmark|
100100
- |checkmark|
101101
-
102102
- |checkmark|
103103

104104
* - Kerberos, LDAP, and x.509 authentication
105-
-
105+
-
106106
- |checkmark|
107107
- |checkmark|
108108
- |checkmark|
109109

110110
* - :doc:`Schema Analysis </schema>`
111-
-
111+
-
112112
- |checkmark|
113113
- |checkmark|
114114
- |checkmark|
115115

116116
* - :doc:`Real Time Server Stats </performance>`
117-
-
117+
-
118118
- |checkmark|
119119
- |checkmark|
120120
- |checkmark|
121121

122122
* - Create, delete and edit :ref:`document validation <validation>`
123123
rules
124-
-
124+
-
125125
- |checkmark|
126126
-
127127
- |checkmark|
@@ -153,5 +153,6 @@ https://github.com/mongodb-js/compass/.
153153
/import-export
154154
/troubleshooting
155155
/faq
156+
/learn-more
156157
/release-notes
157158
/submit-feedback

source/install.txt

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Select your operating system:
1212

1313
.. tabs-pillstrip:: platforms
1414

15+
.. _software-reqs:
16+
1517
Software Requirements
1618
---------------------
1719

@@ -34,7 +36,7 @@ Software Requirements
3436
- 64-bit version of Microsoft Windows 7 or later.
3537
- MongoDB 3.6 or later.
3638
- `Microsoft .NET Framework version 4.5 or later <https://www.microsoft.com/en-us/download/details.aspx?id=30653>`__.
37-
39+
3840
The |compass-short| installer prompts you to install the
3941
minimum required version of the .NET framework if it is not
4042
already installed on your system.
@@ -43,7 +45,7 @@ Software Requirements
4345
content: |
4446

4547
.. tabs::
46-
48+
4749
.. tab:: Debian
4850
:tabid: debian
4951

@@ -91,10 +93,10 @@ To download |compass-short|, you can use your preferred web browser.
9193

9294
- id: linux
9395
content: |
94-
96+
9597
.. tabs::
9698
:hidden:
97-
99+
98100
.. tab:: Debian
99101
:tabid: debian
100102

@@ -157,7 +159,7 @@ Install Compass
157159
content: |
158160

159161
1. Double-click the installer file.
160-
162+
161163
#. Follow the prompts to install |compass-short|. You can
162164
select the destination of the |compass-short| installation.
163165

@@ -169,7 +171,7 @@ Install Compass
169171

170172
.. tabs::
171173
:hidden:
172-
174+
173175
.. tab:: Debian
174176
:tabid: debian
175177

@@ -205,8 +207,19 @@ Install Compass
205207

206208
mongodb-compass
207209

210+
.. seealso::
211+
212+
:ref:`upgrade-compass`
213+
208214
.. _macOS Terminal: https://support.apple.com/guide/terminal/welcome/mac
209215
.. _Windows Powershell: https://docs.microsoft.com/en-us/powershell/scripting/overview?view=powershell-6
210216
.. _zsh: https://www.zsh.org/
211217
.. _bash: https://www.gnu.org/software/bash/
212-
.. _ksh: http://www.kornshell.com/
218+
.. _ksh: http://www.kornshell.com/
219+
220+
.. class:: hidden
221+
222+
.. toctree::
223+
:titlesonly:
224+
225+
/upgrade

source/learn-more.txt

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
======================================
2+
Resources to Learn and Explore MongoDB
3+
======================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
The following sections outline methods to learn MongoDB basics and
14+
best practices.
15+
16+
Free MongoDB Courses Online
17+
---------------------------
18+
19+
To help you get started with MongoDB Compass and the MongoDB database,
20+
see the MongoDB University course `M001
21+
<https://university.mongodb.com/courses/M001/about>`__. This course
22+
provides access to a student cluster for learning about MongoDB.
23+
24+
If you are looking to learn more about MongoDB technologies, there are
25+
other available courses to help you along the way. All courses are
26+
available at no charge. In the course catalog, you will find courses
27+
on:
28+
29+
- Development in `Java
30+
<https://university.mongodb.com/courses/M220J/about>`__, `Node.js
31+
<https://university.mongodb.com/courses/M220JS/about>`__, `Python
32+
<https://university.mongodb.com/courses/M220P/about>`__,
33+
34+
- `New features and tools available
35+
<https://university.mongodb.com/courses/M042/about>`__ in the latest
36+
version of MongoDB,
37+
38+
- `Cluster administration
39+
<https://university.mongodb.com/courses/M103/about>`__,
40+
41+
- `Aggregation <https://university.mongodb.com/courses/M121/about>`__,
42+
43+
- `Performance <https://university.mongodb.com/courses/M201/about>`__,
44+
and more.
45+
46+
Free MongoDB Cluster for Learning and Testing
47+
---------------------------------------------
48+
49+
If you would like to use a hosted instance of MongoDB rather than set up
50+
a local server, you can set up a free ``M0`` cluster on `Atlas
51+
<https://www.mongodb.com/cloud/atlas>`__, MongoDB's hosted database as a
52+
service. The ``M0`` tier cluster is ideal for learning and testing.
53+
54+
Once the cluster is set up, you can use the :guilabel:`Connect` button
55+
in the Atlas interface to obtain the correct Compass connection
56+
settings for your cluster. Fill in the Compass connection form with your
57+
settings to :ref:`connect to your cluster <connect-run-compass>`.
58+
59+
MongoDB Server Installation
60+
---------------------------
61+
62+
To install and run MongoDB using your own network services, you can use
63+
the following tutorials to get a MongoDB database server up and running:
64+
65+
- :manual:`Install MongoDB Enterprise on Windows
66+
</tutorial/install-mongodb-enterprise-on-windows/>`
67+
- :manual:`Install MongoDB Enterprise on Linux
68+
</administration/install-enterprise-linux/>`
69+
- :manual:`Install MongoDB Enterprise on macOS
70+
</tutorial/install-mongodb-enterprise-on-os-x/>`
71+
72+
Resources and Documentation
73+
---------------------------
74+
75+
.. list-table::
76+
:widths: 20 40
77+
:header-rows: 1
78+
79+
* - Resource
80+
- Description
81+
82+
* - `MongoDB Architecture Guide
83+
<https://www.mongodb.com/collateral/mongodb-architecture-guide>`__
84+
- Starting point to get an overview of the MongoDB database.
85+
86+
* - `MongoDB Blog <https://www.mongodb.com/blog>`__
87+
- Provides timely updates on new products, features and best
88+
practices for getting the most out of the MongoDB platform.
89+
90+
* - `Resource Center <https://www.mongodb.com/resource-center>`__
91+
- Contains presentations, white papers and webinars covering all
92+
aspects of the MongoDB database and associated products.
93+
94+
* - `Database Server Documentation
95+
<https://docs.mongodb.com/manual/>`__
96+
- Contains information about installing, configuring and
97+
maintaining the database, as well as in depth information on the
98+
query language.
99+
100+
MongoDB Community Groups
101+
------------------------
102+
103+
Learn more about the following MongoDB groups to interact with other
104+
MongoDB users in your community.
105+
106+
MongoDB Community Slack
107+
~~~~~~~~~~~~~~~~~~~~~~~
108+
109+
Join the `MongoDB Community Slack <community-slack.mongodb.com>`__
110+
workspace to interact with other MongoDB users and follow the latest
111+
updates to the MongoDB platform.
112+
113+
Forums
114+
~~~~~~
115+
116+
For MongoDB-related support discussion, you can post on the
117+
`mongodb-user Google Group <https://groups.google.com/forum/#!forum/mongodb-user>`__ or `Stack Overflow <https://stackoverflow.com/>`__ with the ``mongodb`` tag.
118+
119+
MongoDB User Groups
120+
~~~~~~~~~~~~~~~~~~~
121+
122+
MongoDB User Groups (MUGs) are local communities of developers who work
123+
together to learn from one another about MongoDB best practices,
124+
network, and have fun. To find a MongoDB User Group in your area, see
125+
`MongoDB User Groups on MeetUp <https://www.meetup.com/pro/mongodb>`__.

source/query-plan.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ on the left hand pane, then click :guilabel:`Explain Plan`.
2424
Limitation
2525
----------
2626

27-
The :guilabel:`Explain Plan` tab is not available if you are connected
27+
The :guilabel:`Explain Plan` tab is not available if you are connected
2828
to :atlas:`Data Lake </data-lake>`.
2929

3030
Query Bar
@@ -58,5 +58,5 @@ You can also view the explain details in raw JSON format:
5858
.. figure:: /images/compass/query-plan3.png
5959
:figwidth: 785px
6060

61-
For more information about execution plans, please see the
62-
:manual:`MongoDB documentation</tutorial/analyze-query-plan/>`.
61+
To learn more about execution plans, see the
62+
:manual:`MongoDB documentation </tutorial/analyze-query-plan/>`.

source/upgrade.txt

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. _upgrade-compass:
2+
3+
=====================================
4+
Upgrade Compass to the Latest Version
5+
=====================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
To ensure that you are using the latest |compass-short| features and
16+
improvements, it is recommended to use the latest version of
17+
|compass|. To upgrade |compass-short|, you can either
18+
manually install the latest version or enable automatic updates.
19+
20+
Manually Install the Latest Version of Compass
21+
----------------------------------------------
22+
23+
You can download and install the latest version of Compass from the
24+
`MongoDB Downloads
25+
<https://www.mongodb.com/download-center/compass?jmp=docs>`__ page at
26+
any time. Check the :ref:`Software Requirements <software-reqs>` for
27+
your operating system and desired version of Compass to ensure Compass
28+
is compatible with your system. You do not need to uninstall previous
29+
versions of Compass to upgrade.
30+
31+
Enable Automatic Updates
32+
------------------------
33+
34+
You can enable automatic updates to the latest version of Compass on the
35+
:guilabel:`Help > Privacy Settings` dialog.
36+
37+
.. figure:: /images/compass/privacy-settings.png
38+
:scale: 80%
39+
:alt: Privacy settings
40+
41+
|compass| does not install any updates without your explicit permission.
42+
Instead, |compass-short| prompts you to upgrade when a new version is
43+
available.
44+
45+
.. seealso::
46+
47+
:ref:`download-install`

0 commit comments

Comments
 (0)