Skip to content

Commit c09e7da

Browse files
authored
(DOCSP-32295) Adds Atlas-centric info to manual landing page (#4739) (#4865)
* (DOCSP-32295) Adds Atlas-centric info to manual landing page * Cleans up links and format * Includes tech review changes * Splits out connect step and removes import on first tab * Changes mongosh command line example to atlas setup and adds link * Includes copy and tech review changes * Adds MongoDB manual location for links within these docs
1 parent 0ba2bce commit c09e7da

File tree

4 files changed

+89
-51
lines changed

4 files changed

+89
-51
lines changed

source/aggregation.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _aggregation:
2+
13
======================
24
Aggregation Operations
35
======================

source/core/data-modeling-introduction.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _manual-data-modeling-intro:
2+
13
==========================
24
Data Modeling Introduction
35
==========================

source/index.txt

Lines changed: 83 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,9 @@ What is MongoDB?
1111
MongoDB is a document database designed for ease of application
1212
development and scaling.
1313

14-
Run MongoDB with
14+
You can run MongoDB in the following environments:
1515

16-
- `MongoDB Atlas
17-
<https://www.mongodb.com/cloud?tck=docs_server>`__ fully managed in
18-
the cloud,
19-
- the source available and free-to-use :ref:`MongoDB
20-
Community <install-mdb-community-edition>`, or
21-
- the :ref:`MongoDB Enterprise Advanced
22-
<install-mdb-enterprise>` subscription.
16+
.. include:: /includes/fact-environments.rst
2317

2418
.. button:: Install MongoDB
2519
:uri: /installation
@@ -41,47 +35,57 @@ Work with your data in MongoDB
4135

4236
.. procedure::
4337

44-
.. step:: Model your data
45-
46-
Design your data schema to support frequent access patterns.
47-
You can update or enforce your schema at any point.
48-
49-
:doc:`To learn more, see Data Modeling Introduction </core/data-modeling-introduction>`
38+
.. step:: Deploy MongoDB
39+
40+
Create a cluster in the {+atlas+} UI or the Atlas CLI
41+
quickly and easily. To learn more, see
42+
:atlas:`Create a Cluster </tutorial/create-new-cluster>`
43+
in the {+atlas+} documentation
44+
and :atlascli:`Get Started with Atlas </atlas-cli-getting-started>` in the Atlas CLI documentation.
45+
46+
For self-hosted deployments,
47+
see :ref:`Replication <replication>` in the MongoDB manual
48+
to create a replica
49+
set.
50+
51+
.. step:: Connect to your deployment
52+
53+
Access deployments in the
54+
{+atlas+} UI or connect with :driver:`drivers </>` or the
55+
:mongosh:`MongoDB Shell (mongosh) </>` in the MongoDB
56+
manual.
57+
58+
To learn more, see :ref:`Find Your Connection String <find-connection-string>` in the MongoDB manual.
5059

51-
.. step:: Connect to MongoDB
60+
.. step:: Insert, query, update, or delete documents
5261

53-
Import data from CSV or JSON files into your MongoDB
54-
database.
62+
Perform CRUD operations in the {+atlas+} UI or by using the
63+
MongoDB Query API - with or without transactions.
5564

56-
:mongosh:`To learn more, see MongoDB Shell (mongosh) </>`
65+
To learn more, see
66+
:atlas:`Create, View, Update, and Delete Documents
67+
</atlas-ui/documents/>` in the {+atlas+} documentation and
68+
:ref:`MongoDB CRUD Operations <crud>` in the MongoDB manual.
5769

58-
.. step:: Insert, query, update, or delete documents
70+
.. step:: Model your data
5971

60-
Use the MongoDB Query API to perform CRUD operations on your
61-
data - with or without transactions.
72+
Design your data schema to support frequent access patterns.
73+
You can update or enforce your schema at any point.
6274

63-
:ref:`To learn more, see MongoDB CRUD Operations <crud>`
75+
To learn more, see :ref:`Data Modeling Introduction
76+
<manual-data-modeling-intro>` in the MongoDB manual.
6477

6578
.. code-block:: javascript
6679

67-
➜ mongosh --port 27017
68-
Current Mongosh Log ID: 123a4bc5d67891011ef1213g
69-
Connecting to: mongodb://127.0.0.1:27017/
70-
71-
For mongosh info see: https://www.mongodb.com/docs/mongodb-shell/
72-
73-
test> db.messages.insertMany([
74-
{
75-
message: "Hello World!",
76-
author: "MongoDB",
77-
comments: [],
78-
_id: 1
79-
}
80-
])
81-
{ acknowledged: true, insertedIds: { '0': 1 } }
80+
➜ atlas setup
81+
? Do you want to setup your Atlas database with default settings? (Y/n)
82+
➜ Y
8283

83-
test> db.messages.findOne({ _id: 1 })
84-
{ _id: 1, message: 'Hello World!', author: 'MongoDB', comments: [] }
84+
We are deploying Cluster9876543...
85+
Please store your database authentication access details in a secure location.
86+
Database User Username: Cluster9876543
87+
Database User Password: abcdef12345
88+
Creating your cluster... [Its safe to 'Ctrl + C']
8589

8690
.. tab:: Transform data with Aggregations
8791
:tabid: transform
@@ -90,15 +94,23 @@ Work with your data in MongoDB
9094

9195
.. step:: Import your data
9296

93-
Import data from a CSV or JSON file with mongoimport.
97+
Import data from a CSV or JSON file with database tools.
9498

95-
`To learn more, see mongoimport <https://www.mongodb.com/docs/database-tools/mongoimport/>`__
99+
To learn more, see
100+
:atlas:`Migrate or Import Data </import>` in the {+atlas+}
101+
documentation and `mongoimport
102+
<https://www.mongodb.com/docs/database-tools/mongoimport/>`__ in the database tools documentation.
96103

97104
.. step:: Aggregate your data
98105

99-
Use aggregation pipelines to process your data in multiple stages and return the computed results.
106+
Use aggregation pipelines to process your data in multiple
107+
stages and return the computed results. You can
108+
preview the results at each pipeline stage when you
109+
run aggregation pipelines in {+atlas+}.
100110

101-
:doc:`To learn more, see Aggregation </aggregation>`
111+
To learn more, see :atlas:`Run Aggregation Pipelines
112+
</atlas-ui/agg-pipeline>` in the {+atlas+} documentation
113+
and :ref:`aggregation` in the MongoDB manual.
102114

103115
.. code-block:: javascript
104116

@@ -134,14 +146,20 @@ Work with your data in MongoDB
134146
Verify the identity of a user, replica set member, or
135147
sharded cluster member with authentication.
136148

137-
:ref:`To learn more, see Authentication <authentication>`
149+
To learn more, see :atlas:`Atlas UI Authenication
150+
</atlas-ui-authentication>` in the {+atlas+} documentation
151+
and :ref:`Authentication <authentication>` in the MongoDB
152+
manual.
138153

139154
.. step:: Control access to your database
140155

141156
Enable Role-Based Access Controls to manage user privileges
142157
on your entire database cluster or individual collections.
143158

144-
:ref:`To learn more, see Role-Based Access Controls <authorization>`
159+
To learn more, see :atlas:`Atlas UI Authorization
160+
</atlas-ui-authorization>` in the {+atlas+} documentation
161+
and :ref:`Role-Based Access Controls <authorization>`
162+
in the MongoDB manual.
145163

146164
.. step:: Encrypt your most sensitive data
147165

@@ -150,7 +168,9 @@ Work with your data in MongoDB
150168
leave your application, protecting them over the network, in
151169
memory and at rest.
152170

153-
:doc:`To learn more, see Client-Side Field Level Encryption </core/security-client-side-encryption>`
171+
To learn more, see :doc:`Client-Side Field Level Encryption
172+
</core/security-client-side-encryption>` in the MongoDB
173+
manual.
154174

155175
.. image:: /images/security.png
156176
:alt: MongoDB Security
@@ -160,17 +180,29 @@ Work with your data in MongoDB
160180

161181
.. procedure::
162182

163-
.. step:: Deploy a replica set
183+
.. step:: Create a deployment
164184

165-
Provide redundancy and resilience for your database by deploying a replica set.
185+
Create a free cluster, an auto-scaling cluster, or a
186+
serverless instance in the {+atlas+} UI. To learn
187+
more, see
188+
:atlas:`Choose a Database Deployment Type
189+
</create-database-deployment/#std-label-ref-deployment-types>` in the {+atlas+}
190+
documentation.
166191

167-
:ref:`To learn more, see Replication <replication>`
192+
For self-hosted deployments, provide redundancy and
193+
resilience for your database by deploying a replica set. To
194+
learn more, see :ref:`Replication <replication>` in the
195+
MongoDB manual.
168196

169197
.. step:: Scale out your database
170198

171-
Use sharding to horizontally scale your database or to ensure location-based separation of data.
199+
Use sharding to horizontally scale your database or to
200+
ensure location-based separation of data.
172201

173-
:ref:`To learn more, see Sharding <sharding-introduction>`
202+
To learn more, see :atlas:`Shard a Collection
203+
</collections/#shard-a-collection>` in the {+atlas+}
204+
documentation and :ref:`Sharding <sharding-introduction>`
205+
in the MongoDB manual.
174206

175207
.. image:: /images/scaling.png
176208
:alt: MongoDB Deploy and Scale

source/reference/connection-string.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Compatibility
3939

4040
.. include:: /includes/fact-compatibility-standard-page.rst
4141

42+
.. _find-connection-string:
43+
4244
Find Your Connection String
4345
---------------------------
4446

0 commit comments

Comments
 (0)