Skip to content

Commit 9ced144

Browse files
sarahsimperssarahsimpers
authored
(DOCSP-32295) Adds Atlas-centric info to manual landing page (#4739)
* (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 6885613 commit 9ced144

File tree

2 files changed

+83
-51
lines changed

2 files changed

+83
-51
lines changed

‎source/index.txt

Lines changed: 81 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 :doc:`MongoDB
20-
Community </administration/install-community>`, or
21-
- the :doc:`MongoDB Enterprise Advanced
22-
</administration/install-community>` subscription.
16+
.. include:: /includes/fact-environments.rst
2317

2418
.. button:: Get started with MongoDB Atlas
2519
:uri: https://www.mongodb.com/cloud?tck=docs_server
@@ -43,47 +37,57 @@ Work with your data in MongoDB
4337

4438
.. procedure::
4539

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

53-
.. step:: Connect to MongoDB
62+
.. step:: Insert, query, update, or delete documents
5463

55-
Import data from CSV or JSON files into your MongoDB
56-
database.
64+
Perform CRUD operations in the {+atlas+} UI or by using the
65+
MongoDB Query API - with or without transactions.
5766

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

60-
.. step:: Insert, query, update, or delete documents
72+
.. step:: Model your data
6173

62-
Use the MongoDB Query API to perform CRUD operations on your
63-
data - with or without transactions.
74+
Design your data schema to support frequent access patterns.
75+
You can update or enforce your schema at any point.
6476

65-
:ref:`To learn more, see MongoDB CRUD Operations <crud>`
77+
To learn more, see :ref:`Data Modeling Introduction
78+
<manual-data-modeling-intro>` in the MongoDB manual.
6679

6780
.. code-block:: javascript
6881

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

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

8892
.. tab:: Transform data with Aggregations
8993
:tabid: transform
@@ -92,15 +96,23 @@ Work with your data in MongoDB
9296

9397
.. step:: Import your data
9498

95-
Import data from a CSV or JSON file with mongoimport.
99+
Import data from a CSV or JSON file with database tools.
96100

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

99106
.. step:: Aggregate your data
100107

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

103-
To learn more, see :ref:`aggregation`.
113+
To learn more, see :atlas:`Run Aggregation Pipelines
114+
</atlas-ui/agg-pipeline>` in the {+atlas+} documentation
115+
and :ref:`aggregation` in the MongoDB manual.
104116

105117
.. code-block:: javascript
106118

@@ -136,14 +148,20 @@ Work with your data in MongoDB
136148
Verify the identity of a user, replica set member, or
137149
sharded cluster member with authentication.
138150

139-
:ref:`To learn more, see Authentication <authentication>`
151+
To learn more, see :atlas:`Atlas UI Authenication
152+
</atlas-ui-authentication>` in the {+atlas+} documentation
153+
and :ref:`Authentication <authentication>` in the MongoDB
154+
manual.
140155

141156
.. step:: Control access to your database
142157

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

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

148166
.. step:: Encrypt your most sensitive data
149167

@@ -153,7 +171,7 @@ Work with your data in MongoDB
153171
memory and at rest.
154172

155173
To learn more, see :ref:`Client-Side Field Level Encryption
156-
<manual-csfle-feature>`.
174+
<manual-csfle-feature>` in the MongoDB manual.
157175

158176
.. image:: /images/security.png
159177
:alt: MongoDB Security
@@ -163,17 +181,29 @@ Work with your data in MongoDB
163181

164182
.. procedure::
165183

166-
.. step:: Deploy a replica set
184+
.. step:: Create a deployment
167185

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

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

172198
.. step:: Scale out your database
173199

174-
Use sharding to horizontally scale your database or to ensure location-based separation of data.
200+
Use sharding to horizontally scale your database or to
201+
ensure location-based separation of data.
175202

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

178208
.. image:: /images/scaling.png
179209
: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)