Skip to content

Commit 62a34b6

Browse files
zach-carrzach-carr
authored
(DOCSP-12620) Initial structure (#3)
* Init
1 parent 8ea52fd commit 62a34b6

22 files changed

+413
-29
lines changed

‎snooty.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_landing_pages = ["/tutorial/getting-started"]
1010
[substitutions]
1111

1212
govcloud = "MongoDB Cloud for Government"
13-
govcloud-short = "MongoDB GovCloud"
13+
govcloud-short = "MongoDB CloudGov"
1414
2fa = ":abbr:`2FA (Two Factor Authentication)`"
1515
aki = ":abbr:`AKI (Azure Key Identifier)`"
1616
akv = ":abbr:`AKV (Azure Key Vault)`"

‎source/getting-started.txt‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
:noprevnext:
2+
3+
.. _govcloud-getting-started:
4+
5+
===============
6+
Getting Started
7+
===============
8+
9+
.. default-domain:: mongodb
10+
11+
.. contents:: On this page
12+
:local:
13+
:backlinks: none
14+
:depth: 1
15+
:class: singlecol
16+
17+
Overview
18+
--------
19+
20+
|govcloud| provides a FedRAMP Moderate-compliant |service| environment
21+
to host and manage your data in the cloud. This tutorial guides you
22+
through creating an |govcloud-short| cluster, connecting to it,
23+
inserting data, and querying data.
24+
25+
Table of Contents
26+
-----------------
27+
28+
- **Part 1:** :doc:`Create a MongoDB GovCloud Account </tutorial/create-account>`.
29+
- **Part 2:** :doc:`Deploy a Cluster </tutorial/deploy-cluster>`.
30+
- **Part 3:** :doc:`Allow Your Connection IP Address
31+
</tutorial/allow-connection-ip-address>`.
32+
- **Part 4:** :doc:`Create a Database User for Your Cluster
33+
</tutorial/create-mongodb-user-for-cluster>`.
34+
- **Part 5:** :doc:`Connect to Your Cluster </tutorial/connect-to-your-cluster>`.
35+
- **Part 6:** :doc:`Insert and View Data in Your Cluster
36+
</tutorial/insert-data-into-your-cluster>`.
37+
38+
39+
.. class:: hidden
40+
41+
.. toctree::
42+
:titlesonly:
43+
44+
/tutorial/create-account
45+
/tutorial/deploy-cluster
46+
/tutorial/allow-connection-ip-address
47+
/tutorial/create-mongodb-user-for-cluster
48+
/tutorial/connect-to-your-cluster
49+
/tutorial/insert-data-into-your-cluster
50+

‎source/includes/admonitions/no-commercial-region.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. important::
2+
3+
You cannot deploy clusters across |govcloud-short| and commercial
4+
regions.

‎source/includes/admonitions/no-free-tier.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. important::
2+
3+
You cannot deploy free or shared tier clusters in |govcloud|.

‎source/includes/admonitions/require-scram-sha256.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. important::
2+
3+
|govcloud| database users may only authenticate using
4+
``SCRAM-SHA256``.

‎source/index.txt‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
1+
:noprevnext:
2+
13
==========
24
|govcloud|
35
==========
46

57
.. default-domain:: mongodb
68

7-
.. contents:: On this page
8-
:local:
9-
:backlinks: none
10-
:depth: 1
11-
:class: singlecol
9+
|govcloud| is a FedRAMP Moderate compliant, fully-managed cloud
10+
database developed by the same people that build MongoDB and |service|.
11+
12+
.. class:: hidden
1213

13-
About |govcloud|
14-
----------------
14+
.. toctree::
15+
:titlesonly:
1516

16-
Placeholder content for |govcloud-short| landing page.
17+
/info
18+
/getting-started
19+
/security
20+
/support

‎source/info.txt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:noprevnext:
2+
3+
=========================
4+
What is |govcloud-short|?
5+
=========================
6+
7+
.. default-domain:: mongodb
8+
9+
|govcloud| is a FedRAMP Moderate compliant |service| environment.
10+
11+
.. class:: hidden
12+
13+
.. toctree::
14+
:titlesonly:
15+
16+
/info/atlas-differences
17+
/info/billing
18+
/info/supported-regions
19+
/info/supported-services

‎source/info/atlas-differences.txt‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
======================================
2+
|govcloud-short| Compared to |service|
3+
======================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Overview
14+
--------
15+
16+
|govcloud| is a FedRAMP Moderate-compliant |service| environment. Much
17+
of the information and many of the procedures in the |service|
18+
documentation hold true for |govcloud-short|, but there are key
19+
differences.
20+
21+
Aspects of |govcloud-short| operate differently than |service| in the
22+
following categories:
23+
24+
Billing
25+
-------
26+
27+
For information on how |govcloud-short| billing differs from |service|
28+
billing, see :ref:`Billing <billing>`.
29+
30+
Sign Up and Login
31+
-----------------
32+
33+
For more information on signing up for |govcloud-short|, see
34+
:ref:`Create an Account <create-account>`.
35+
36+
Clusters
37+
--------
38+
39+
For more information on deploying a |govcloud-short| cluster, see
40+
:ref:`Deploy a Cluster <deploy-cluster>`.
41+
42+
Available Regions and Region Restrictions
43+
-----------------------------------------
44+
45+
.. include:: /includes/admonitions/no-commercial-region.rst
46+
47+
For information on |govcloud-short| regions, see
48+
:ref:`Supported Regions <supported-regions>`.
49+
50+
Available Services
51+
------------------
52+
53+
For information on |govcloud-short| services, see
54+
:ref:`Supported Services <supported-services>`.
55+
56+
Database Users
57+
--------------
58+
59+
For information on how |govcloud-short| database user requirements
60+
differ from |service| requirements, see
61+
:ref:`Configure Database Users <configure-dbusers>`.
62+
63+
Private Endpoints
64+
-----------------
65+
66+
For information on |govcloud-short| private endpoints, see
67+
:ref:`Set Up a Private Endpoint <private-endpoint>`.

‎source/info/billing.txt‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _billing:
2+
3+
=======
4+
Billing
5+
=======
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
Overview
16+
--------

‎source/info/supported-regions.txt‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _supported-regions:
2+
3+
=================
4+
Supported Regions
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+
Overview
16+
--------

0 commit comments

Comments
 (0)