Skip to content

Commit 1e07c5c

Browse files
authored
(DOCSP-26570): Fixed build errors. (#130)
* (DOCSP-26570): Fixed build errors. * (DOCSP-26570): Incorporated Chris's feedback.
1 parent 0fe321e commit 1e07c5c

File tree

106 files changed

+401
-508
lines changed

Some content is hidden

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

106 files changed

+401
-508
lines changed

snooty.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ markdown = "Markdown"
1717
docutils = "Docutils"
1818
sphinx = "Sphinx"
1919
docs-platform = "Docs Platform Team"
20+
db-example = "+db+"
2021

2122
[substitutions]
2223
mdbsg = "MongoDB Style Guide"
24+
service = "Atlas"

source/images-guide.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Whenever possible, you should publish diagrams in SVG form. This
1717
provides a crisp image at any screen resolution with a small file
1818
size.
1919

20-
First install `mut <https://github.com/mongodb/mut>`_,
21-
`Inkscape <http://inkscape.org/>`_, and
22-
`svgo <https://github.com/svg/svgo>`_.
20+
First install `mut <https://github.com/mongodb/mut>`__,
21+
`Inkscape <http://inkscape.org/>`__, and
22+
`svgo <https://github.com/svg/svgo>`__.
2323

2424
Place your SVG in ``source/images/``. If you named your SVG
2525
``foo.svg``, then run the following from within that directory:
@@ -61,13 +61,13 @@ itself should not be wider than 1000px.
6161
content.
6262

6363
It may make sense to use
64-
`mozjpeg <https://github.com/mozilla/mozjpeg>`_ if you need lossy
65-
compression; `imagemagick <http://imagemagick.org/>`_ to resize images;
66-
and a `Ninja <http://ninja-build.org/>`_ file to put the pieces
64+
`mozjpeg <https://github.com/mozilla/mozjpeg>`__ if you need lossy
65+
compression; `imagemagick <http://imagemagick.org/>`__ to resize images;
66+
and a `Ninja <http://ninja-build.org/>`__ file to put the pieces
6767
together.
6868

6969
The default ``libpng`` encoder does not create optimal PNG files, so
70-
install `zopflipng <https://github.com/google/zopfli>`_. To compress a
70+
install `zopflipng <https://github.com/google/zopfli>`__. To compress a
7171
PNG, use the following template:
7272

7373
.. code-block:: sh

source/includes/steps-configure-git.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
title: "Fork these repositories into your own GitHub account."
22
ref: fork-repos
33
content: |
4-
`This guide from GitHub <https://guides.github.com/activities/forking/>`_ covers the specifics.
4+
`This guide from GitHub <https://guides.github.com/activities/forking/>`__ covers the specifics.
55
66
- https://github.com/mongodb/docs
77
- https://github.com/mongodb/docs-ecosystem

source/includes/steps-create-ssh-key.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,5 @@ title: "Add this certificate to your GitHub account."
4242
ref: add-cert-to-github
4343
content: |
4444
For specific instructions, see
45-
`GitHub <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>`_.
45+
`GitHub <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>`__.
4646
...

source/includes/steps-get-aws-keys.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
title: "Login to your AWS Account."
22
ref: login-aws
33
content: |
4-
Login to `AWS for the Education department <https://idp.mongodb.com/simplesaml/saml2/idp/SSOService.php?spentityid=urn:amazon:webservices:univ-training-991734710418>`_.
4+
Login to `AWS for the Education department <https://idp.mongodb.com/simplesaml/saml2/idp/SSOService.php?spentityid=urn:amazon:webservices:univ-training-991734710418>`__.
55
66
---
77
title: "Connect to your AWS Instance."
88
ref: connect-aws-instance
99
content: |
1010
1111
a. After you have `created an instance
12-
<https://gist.github.com/atsansone/52e63e3f22811adcc8b6#create-an-aws-instance>`_,
12+
<https://gist.github.com/atsansone/52e63e3f22811adcc8b6#create-an-aws-instance>`__,
1313
click on radio button for your instance.
1414
1515
b. Click :guilabel:`Connect`.

source/includes/steps-install-aws-keys.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ content: |
77
88
a. Create a new Group.
99
10-
b. Click `Settings`.
10+
b. Click :guilabel:`Settings`.
1111
12-
c. Click `Billing/Subscriptions`.
12+
c. Click :guilabel:`Billing/Subscriptions`.
1313
1414
d. Click :guilabel:`Pencil Icon` to the right of :guilabel:`Payment Method`
1515
to activate your account.
1616
17-
e. Use `Stripe's Test Cards <https://stripe.com/docs/testing>`_ to
17+
e. Use `Stripe's Test Cards <https://stripe.com/docs/testing>`__ to
1818
complete your payment setup.
1919
2020
---
@@ -38,7 +38,7 @@ content: |
3838
- Action
3939
4040
* - Authentication Method
41-
- Choose `Access Key/Secret`.
41+
- Choose :guilabel:`Access Key/Secret`.
4242
4343
* - Access Key ID
4444
- Enter the Access Key that |automationperson| gave you.

source/includes/steps-install-ssh-key.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ ref: login-cloud-manager-2
44
title: "Add the SSH Public Key."
55
ref: add-ssh-key
66
content: |
7-
a. Click `Settings`.
7+
a. Click :guilabel:`Settings`.
88
9-
b. Click `Provisioning Settings`.
9+
b. Click :guilabel:`Provisioning Settings`.
1010
1111
c. Click :guilabel:`Add SSH Public Key`.
1212

source/includes/steps-repo.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ title: Fork the repo
118118
ref: fork-repo
119119
content: |
120120
121-
Go ahead and fork the repo on github if you wish to follow the docs model of github usage. `Fork a repo <https://help.github.com/en/articles/fork-a-repo>`_.
121+
Go ahead and fork the repo on github if you wish to follow the docs model of github usage. `Fork a repo <https://help.github.com/en/articles/fork-a-repo>`__.
122122
123123
This is not a requirement if your team follows a different workflow. If you wish to branch off the root repository, skip this step entirely.
124124

source/includes/styles/corrections.rst

Lines changed: 0 additions & 72 deletions
This file was deleted.

source/organization.txt

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ integrate it into the existing resource.
1212

1313
If you have questions, don't hesitate to open a ticket in the
1414
`Documentation Jira Project <https://jira.mongodb.org/browse/DOCS>`_
15-
or contact the `documentation team <mailto:[email protected]>`_.
15+
or contact the `documentation team <mailto:[email protected]>`__.
1616

1717
Global Organization
1818
-------------------
@@ -56,25 +56,24 @@ Tools
5656
-----
5757

5858
The organization of the site, like all Sphinx sites derives from the
59-
:rst:dir:`toctree <sphinx:toctree>` structure. However, in order to annotate
59+
``toctree`` structure. However, in order to annotate
6060
the table of contents and provide additional flexibility, the MongoDB
61-
documentation generates :rst:dir:`toctree` structures using
61+
documentation generates ``toctree`` structures using
6262
data from YAML files stored in the ``source/includes/``
6363
directory. These files start with ``ref-toc`` or ``toc`` and generate
6464
output in the ``source/includes/toc/`` directory. Briefly this system
6565
has the following behavior:
6666

6767
- files that start with ``ref-toc`` refer to the documentation of API
6868
objects (i.e. commands, operators and methods), and the build
69-
system generates files that hold :rst:dir:`toctree <sphinx:toctree>`
69+
system generates files that hold ``toctree``
7070
directives as well as files that hold *tables* that list objects and
7171
a brief description.
7272

7373
- files that start with ``toc`` refer to all other documentation and
74-
the build system generates files that hold :rst:dir:`toctree
75-
<sphinx:toctree>` directives as well as files that hold
76-
*definition lists* that contain links to the documents and short
77-
descriptions the content.
74+
the build system generates files that hold ``toctree`` directives as
75+
well as files that hold *definition lists* that contain links to the
76+
documents and short descriptions the content.
7877

7978
- file names that have ``spec`` following ``toc`` or ``ref-toc`` will
8079
generate aggregated tables or definition lists and allow ad-hoc

0 commit comments

Comments
 (0)