Skip to content

Commit 9ffa844

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

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
@@ -39,47 +33,57 @@ Work with your data in MongoDB
3933

4034
.. procedure::
4135

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

49-
.. step:: Connect to MongoDB
58+
.. step:: Insert, query, update, or delete documents
5059

51-
Import data from CSV or JSON files into your MongoDB
52-
database.
60+
Perform CRUD operations in the {+atlas+} UI or by using the
61+
MongoDB Query API - with or without transactions.
5362

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

56-
.. step:: Insert, query, update, or delete documents
68+
.. step:: Model your data
5769

58-
Use the MongoDB Query API to perform CRUD operations on your
59-
data - with or without transactions.
70+
Design your data schema to support frequent access patterns.
71+
You can update or enforce your schema at any point.
6072

61-
:ref:`To learn more, see MongoDB CRUD Operations <crud>`
73+
To learn more, see :ref:`Data Modeling Introduction
74+
<manual-data-modeling-intro>` in the MongoDB manual.
6275

6376
.. code-block:: javascript
6477

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

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

8488
.. tab:: Transform data with Aggregations
8589
:tabid: transform
@@ -88,15 +92,23 @@ Work with your data in MongoDB
8892

8993
.. step:: Import your data
9094

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

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

95102
.. step:: Aggregate your data
96103

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

99-
To learn more, see :ref:`aggregation`.
109+
To learn more, see :atlas:`Run Aggregation Pipelines
110+
</atlas-ui/agg-pipeline>` in the {+atlas+} documentation
111+
and :ref:`aggregation` in the MongoDB manual.
100112

101113
.. code-block:: javascript
102114

@@ -132,14 +144,20 @@ Work with your data in MongoDB
132144
Verify the identity of a user, replica set member, or
133145
sharded cluster member with authentication.
134146

135-
:ref:`To learn more, see Authentication <authentication>`
147+
To learn more, see :atlas:`Atlas UI Authenication
148+
</atlas-ui-authentication>` in the {+atlas+} documentation
149+
and :ref:`Authentication <authentication>` in the MongoDB
150+
manual.
136151

137152
.. step:: Control access to your database
138153

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

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

144162
.. step:: Encrypt your most sensitive data
145163

@@ -149,7 +167,7 @@ Work with your data in MongoDB
149167
memory and at rest.
150168

151169
To learn more, see :ref:`Client-Side Field Level Encryption
152-
<manual-csfle-feature>`.
170+
<manual-csfle-feature>` in the MongoDB manual.
153171

154172
.. image:: /images/security.png
155173
:alt: MongoDB Security
@@ -159,17 +177,29 @@ Work with your data in MongoDB
159177

160178
.. procedure::
161179

162-
.. step:: Deploy a replica set
180+
.. step:: Create a deployment
163181

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

166-
:ref:`To learn more, see Replication <replication>`
189+
For self-hosted deployments, provide redundancy and
190+
resilience for your database by deploying a replica set. To
191+
learn more, see :ref:`Replication <replication>` in the
192+
MongoDB manual.
167193

168194
.. step:: Scale out your database
169195

170-
Use sharding to horizontally scale your database or to ensure location-based separation of data.
196+
Use sharding to horizontally scale your database or to
197+
ensure location-based separation of data.
171198

172-
:ref:`To learn more, see Sharding <sharding-introduction>`
199+
To learn more, see :atlas:`Shard a Collection
200+
</collections/#shard-a-collection>` in the {+atlas+}
201+
documentation and :ref:`Sharding <sharding-introduction>`
202+
in the MongoDB manual.
173203

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