Skip to content

Commit 1e535f9

Browse files
skerschbkay-kim
authored andcommitted
DOCSP-2579: assorted guides tweaks based on feedback (#74)
1 parent 59e2e1e commit 1e535f9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+761
-431
lines changed

conf.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@
3636
'guides',
3737
'tabs',
3838
'uriwriter',
39-
'fasthtml'
39+
'fasthtml',
40+
'source_constants'
4041
]
4142

4243
templates_path = ['.templates']
@@ -59,6 +60,16 @@
5960
'.. |ent-build| replace:: MongoDB Enterprise',
6061
])
6162

63+
source_constants = {
64+
'package-branch': 'testing',
65+
'package-name-org': 'mongodb-org',
66+
'package-name-enterprise': 'mongodb-enterprise',
67+
'version': '4.0',
68+
'release': 'release',
69+
'pgp-version': '4.0',
70+
'pgp-fingerprint': '9DA31620334BD75D9DCB49F368818C72E52529D4'
71+
}
72+
6273
extlinks = {
6374
'issue': ('https://jira.mongodb.org/browse/%s', '' ),
6475
'manual': ('http://docs.mongodb.com/manual%s', ''),

source/guides/cloud/atlas.txt

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
.. guide::
22
title: Create an Atlas Account and Cluster
3-
author: MongoDB
3+
author: MongoDB Documentation Team
44
type: Getting Started
55
level: beginner
6-
product_version: 3.6
6+
product_version: 4.0
77
result_description:
8-
In this guide, you will create a free account on Atlas, MongoDB's
9-
managed database solution, and a free MongoDB server cluster.
8+
In this guide, you will:
9+
10+
- create a free account on Atlas, MongoDB's managed database solution in the cloud
11+
- create a free MongoDB *cluster*, or group of database instances.
12+
1013
time: 15
1114
prerequisites:
1215
.. include:: /includes/steps/cloud_pr.rst

source/guides/cloud/connectionstring.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. guide::
22
title: Set Up Atlas Connectivity
3-
author: MongoDB
3+
author: MongoDB Documentation Team
44
type: Getting Started
55
level: beginner
66
languages:
@@ -12,7 +12,7 @@
1212
motor
1313
csharp
1414

15-
product_version: 3.6
15+
product_version: 4.0
1616
result_description:
1717

1818
This guide will show you how to set up your Atlas cluster for connections from a client. You will:
@@ -23,7 +23,7 @@
2323
time: 15
2424
prerequisites:
2525

26-
- You will need an Atlas account. See Getting Started: :doc:`/guides/cloud/atlas`
26+
- You will need an Atlas account. See :doc:`/guides/cloud/atlas`
2727

2828
procedure:
2929

source/guides/server/auth.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. guide::
2+
3+
title: Enable Authentication on MongoDB
4+
type: Getting Started
5+
level: beginner
6+
author: MongoDB Documentation Team
7+
product_version: 4.0
8+
result_description:
9+
This guide describes how to enable authentication on your local MongoDB instance.
10+
time: 10
11+
prerequisites:
12+
- A local installation of MongoDB. See :doc:`/guides/server/install`
13+
- The :binary:`~bin.mongo` shell. See the mongo shell section of :doc:`/guides/server/drivers`
14+
check_your_environment:
15+
.. include:: /includes/check_for_auth.rst
16+
procedure:
17+
.. include:: /includes/steps/auth.rst
18+
summary:
19+
If you have successfully completed this guide, you have
20+
enabled basic authentication on your local MongoDB instance.
21+
whats_next:
22+
The next guide walks you through connecting to your new MongoDB instance.
23+
- :doc:`/guides/server/drivers`
24+
seealso:
25+
- :doc:`/guides/server/introduction`
26+
- :doc:`/guides/server/read`
27+
- :doc:`/guides/server/read_operators`
28+
- :doc:`/guides/server/update`
29+
- :doc:`/guides/server/delete`

source/guides/server/delete.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
title: Delete Data from MongoDB
44
type: Getting Started
55
level: beginner
6-
author: MongoDB
7-
product_version: 3.6
6+
author: MongoDB Documentation Team
7+
product_version: 4.0
88
languages:
99
shell
1010
compass

source/guides/server/drivers.txt

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
.. guide::
22
title: Connect to MongoDB
3-
author: MongoDB
3+
author: MongoDB Documentation Team
44
type: Getting Started
55
level: beginner
6+
deployments:
7+
cloud
8+
local
69
languages:
710
shell
811
compass
@@ -12,20 +15,33 @@
1215
motor
1316
csharp
1417

15-
product_version: 3.6
18+
product_version: 4.0
1619
result_description:
17-
There are several ways to connect to your MongoDB instances. The
18-
following guide steps you through installing your MongoDB client.
20+
21+
There are several ways to connect to your MongoDB instance.
22+
23+
- :ref:`MongoDB Compass <compass-index>` for access through a downloadable user interface
24+
- :binary:`~bin.mongo` interactive shell
25+
- `programmatic access <https://docs.mongodb.com/ecosystem/drivers>`_ through a number of programming APIs.
26+
27+
The following guide steps you through installing the MongoDB client of your choice.
1928

2029
time: 15
2130
prerequisites:
22-
.. include:: /includes/prereqs_drivers_install.rst
31+
32+
.. include:: /includes/prereqs_read_CRUD.rst
33+
2334
check_your_environment:
35+
2436
- Ensure that your client platform is compatible with MongoDB.
2537
Refer to the :ref:`Supported Platforms <mongodb-supported-platforms>`
2638
table for more information.
39+
2740
procedure:
2841

42+
.. tip::
43+
Select the client and environment you will use at the top of this page.
44+
2945
.. include:: /includes/steps/drivers_install_gs.rst
3046

3147
summary:
@@ -41,7 +57,7 @@
4157
* :doc:`Insert Data into MongoDB </guides/server/insert>`
4258
seealso:
4359

44-
For CRUD guides:
60+
For CRUD (Create, Read, Update, Delete) guides:
4561

4662
- :doc:`/guides/server/insert`
4763
- :doc:`/guides/server/read`

source/guides/server/import.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. guide::
22
title: Import Data into MongoDB
3-
author: assorted
3+
author: MongoDB Documentation Team
44
type: Getting Started
55
level: beginner
6-
product_version: 3.6
6+
product_version: 4.0
77
result_description:
88
In this guide, you will use the
99
:binary:`~bin.mongoimport` tool distributed with MongoDB
@@ -22,7 +22,9 @@
2222
whats_next:
2323
In this guide, you will retrieve all of the documents in a
2424
collection in your MongoDB database.
25-
* :doc:`Read Data From MongoDB </guides/server/read_queries>`
25+
26+
- :doc:`Read Data From MongoDB </guides/server/read_queries>`
27+
2628
seealso:
2729
For CRUD guides:
2830

source/guides/server/insert.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. guide::
22
title: Insert Data into MongoDB
3-
author: MongoDB
3+
author: MongoDB Documentation Team
44
type: Getting Started
55
level: beginner
6-
product_version: 3.6
6+
product_version: 4.0
77
languages:
88
shell
99
compass

source/guides/server/install.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
type: Getting Started
55
level: beginner
66
author: MongoDB Documentation Team
7-
product_version: 3.6
7+
product_version: 4.0
88
result_description:
99

1010
This guide describes how to install MongoDB locally. If you would

source/guides/server/introduction.txt

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
.. guide::
2-
title: Introduction to MongoDB
3-
author: MongoDB
2+
title: Structure your Data for MongoDB
3+
author: MongoDB Documentation Team
44
type: Getting Started
55
level: beginner
6-
product_version: 3.6
6+
product_version: 4.0
77
result_description:
8-
Welcome to the *Getting Started: Introduction to MongoDB* guide. This guide will show you how to structure your data for MongoDB.
8+
Welcome to the Getting Started guides. This guide will show you how to structure data for MongoDB.
99
time: 15
1010
prerequisites:
1111
- An idea of what data you'd like to store
@@ -16,10 +16,19 @@
1616
summary:
1717
Congratulations. You now have an idea of how to structure your data using a JSON document.
1818
whats_next:
19-
In the next guide, you'll learn how to Connect to MongoDB.
2019

21-
* :doc:`Getting Started: Connect to MongoDB </guides/server/drivers>`
20+
Next you'll set up a MongoDB instance. Choose one of the following options:
21+
22+
- :doc:`Install MongoDB locally </guides/server/install>`
23+
24+
- :doc:`Create an Atlas Account and Cluster </guides/cloud/atlas>`
25+
2226

2327
seealso:
24-
- :manual:`/schema-validation`
28+
- :manual:`The MongoDB manual on Documents </core/document>`
29+
- You can define the structure of your data for MongoDB using a JSON schema. See :manual:`Schema Validation </core/schema-validation>`.
30+
- Read more about what MongoDB can do, see :manual:`Introduction to MongoDB </introduction>`
31+
32+
.. include:: /includes/beginner_note.rst
33+
2534

0 commit comments

Comments
 (0)