Skip to content

Commit

Permalink
DOCSP-12456: fix build warnings errors (#678)
Browse files Browse the repository at this point in the history
* DOCSP-12456: fix nextgen build warnings and errors
  • Loading branch information
Chris Cho authored Oct 12, 2020
1 parent 9752175 commit 8ef04ef
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 33 deletions.
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
'atlas': ('https://docs.atlas.mongodb.com%s', ''),
'mms-home': ('https://www.mongodb.com/cloud/cloud-manager%s', ''),
'guides': ('https://docs.mongodb.com/guides%s', ''),
'java-docs': ('http://mongodb.github.io/mongo-java-driver/3.12/%s', ''),
'java-docs': ('http://mongodb.github.io/mongo-java-driver/4.1/%s', ''),
'kafka-21-javadoc': ('https://kafka.apache.org/21/javadoc/org/apache/kafka%s', ''),
'csharp-docs': ('http://mongodb.github.io/mongo-csharp-driver/2.10%s', ''),
'scala-docs': ('http://mongodb.github.io/mongo-scala-driver/2.9%s', ''),
Expand Down
9 changes: 4 additions & 5 deletions source/driver-compatibility-reference.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@ Driver Compatibility
:depth: 1
:class: twocols

.. admonition:: Check the driver documentation pages for compatibility information
:class: note

Please check our `driver documentation page home <https://docs.mongodb.com/drivers>`__
for the latest information on driver compatibility with MongoDB and driver
.. note:: Check the driver documentation pages for compatibility information

Please check our `driver documentation page home <https://docs.mongodb.com/drivers>`__
for the latest information on driver compatibility with MongoDB and driver
languages.
2 changes: 1 addition & 1 deletion source/includes/driver-table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
- :issue:`JIRA <JAVA>`
- `Course <https://university.mongodb.com/courses/M220J/about>`__

* - :doc:`Node.js <https://docs.mongodb.com/drivers/node>`
* - `Node.js <https://docs.mongodb.com/drivers/node>`__
- `Releases <https://github.com/mongodb/node-mongodb-native/releases>`__
- `Source <https://github.com/mongodb/node-mongodb-native>`__
- `API <https://mongodb.github.io/node-mongodb-native/>`__
Expand Down
6 changes: 0 additions & 6 deletions source/includes/hadoop-eol-spark.rst

This file was deleted.

3 changes: 3 additions & 0 deletions source/includes/mongodb-compatibility-table-motor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@
- |checkmark|

* - 0.2
-
-
-
-
-
-
Expand Down
9 changes: 3 additions & 6 deletions source/includes/steps-fle-configure-the-mongodb-client.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,7 @@ content: |
Map<String, Object> extraOptions = new HashMap<String, Object>();
extraOptions.put("mongocryptdSpawnPath", "/usr/local/bin/mongocryptd");
.. admonition:: Encryption Binary Daemon
:class: note
.. note:: Encryption Binary Daemon
If the ``mongocryptd`` daemon is already running, you can
configure the client to skip starting it by passing the
Expand All @@ -155,8 +154,7 @@ content: |
mongocryptdSpawnPath: '/usr/local/bin/mongocryptd',
}
.. admonition:: Encryption Binary Daemon
:class: note
.. note:: Encryption Binary Daemon
If the ``mongocryptd`` daemon is already running, you can
configure the client to skip starting it by passing the
Expand All @@ -176,8 +174,7 @@ content: |
'mongocryptd_spawn_path': '/usr/local/bin/mongocryptd'
}
.. admonition:: Encryption Binary Daemon
:class: note
.. note:: Encryption Binary Daemon
If the ``mongocryptd`` daemon is already running, you can
configure the client to skip starting it by passing the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ content: |
encrypt and decrypt the remote master key. The IAM user must be granted
full ``List`` and ``Read`` permissions for the KMS service.
.. admonition:: Client IAM User Credentials
:class: note
.. note:: Client IAM User Credentials
The CSFLE-enabled client uses the IAM User's :guilabel:`Access Key
ID` and :guilabel:`Secret Access Key` as configuration values. Take
Expand Down
3 changes: 1 addition & 2 deletions source/includes/steps-fle-create-data-encryption-key.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,7 @@ content: |
masterKey=Document{{provider=local}}
}}
.. admonition:: View the Extended JSON Representation of the Data Key
:class: note
.. note:: View the Extended JSON Representation of the Data Key
While the ``Document`` class is the
:java-docs:`Document type </bson/documents>`
Expand Down
4 changes: 2 additions & 2 deletions source/php-libraries.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ Stand-alone Libraries
- `Mongolid <https://github.com/leroy-merlin-br/mongolid>`_: A fast ODM for PHP and
MongoDB, which implements both ActiveRecord and DataMapper design patterns and
supports embedded and referenced documents. An integration with
`Laravel <https://github.com/leroy-merlin-br/mongolid-laravel>`_ is also available.
`Laravel <https://github.com/leroy-merlin-br/mongolid-laravel>`__ is also available.

- `Yadm <https://github.com/makasim/yadm>`_ is a MongoDB ODM written for the
**mongodb** extension. It is schema-less and supports fast object hydration
and persistence, which makes it well-suited for modeling aggregation results.

- `Xenus <https://github.com/abellion/xenus>`_ is an elegant MongoDB ODM
that supports events, relationships, embedded documents, and more. An
integration with `Laravel <https://github.com/abellion/xenus-laravel>`_ is
integration with `Laravel <https://github.com/abellion/xenus-laravel>`__ is
also available, which adds support for failed jobs, migrations, and events.

Framework Integrations
Expand Down
10 changes: 4 additions & 6 deletions source/security/client-side-field-level-encryption-guide.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ information in the context of a real-world scenario:
- **How to implement Client-Side Field Level Encryption with the MongoDB
driver** (`Implementation`_)

.. admonition:: Download the Code
.. note:: Download the Code

For a runnable example of all the functionality demonstrated in this guide,
see the :ref:`Download Example Project <download-example-project>` section.
Expand Down Expand Up @@ -277,8 +277,7 @@ encrypt and decrypt document fields, are stored in a key vault collection in
the same MongoDB replica set as the encrypted data.


.. admonition:: Local Key Provider is not suitable for production
:class: important
.. warning:: Local Key Provider is not suitable for production

The Local Key Provider is an insecure method of storage and is therefore
**not recommended** if you plan to use CSFLE in production. Instead,
Expand Down Expand Up @@ -409,8 +408,7 @@ information:
- The BSON Type of each field (only required for deterministically
encrypted fields)

.. admonition:: CSFLE JSON Schema Does Not Support Document Validation
:class: important
.. warning:: CSFLE JSON Schema Does Not Support Document Validation

MongoDB drivers use JSON Schema syntax to specify encrypted fields
and *only* support field-level encryption-specific keywords documented
Expand All @@ -419,7 +417,7 @@ information:
Any other document validation instances will cause the client to throw
an error.

.. admonition:: Server-side JSON Schema
.. warning:: Server-side JSON Schema

You can prevent clients that are not configured with the appropriate
client-side JSON Schema from writing unencrypted data to a field by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ exposed to the client.
Convert to a Remote Master Key
------------------------------

.. admonition:: Decrypt all encrypted field data first
:class: warning
.. warning:: Decrypt all encrypted field data first

Before you switch from a locally-managed master key to a remote KMS,
you must decrypt all documents containing field-encrypted data if you
Expand Down

0 comments on commit 8ef04ef

Please sign in to comment.