-
Notifications
You must be signed in to change notification settings - Fork 266
DOCSP-37027: Fix build errors #1289
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 6 commits
24c99d2
0b0f6cd
dda2a5b
2bdc4f9
d1627cd
e255080
d3c951e
029d07f
52fd388
d21a930
a85c90c
ea4e652
0dd88f9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,43 @@ | ||
--- | ||
ref: option-requires-4.2 | ||
source: | ||
ref: option-requires-version | ||
file: extracts-option-requires.yaml | ||
content: | | ||
This option is available since MongoDB {{version}} and will result in an | ||
exception at execution time if specified for an older server version. | ||
replacement: | ||
version: "4.2" | ||
--- | ||
ref: option-requires-4.4 | ||
source: | ||
ref: option-requires-version | ||
file: extracts-option-requires.yaml | ||
content: | | ||
This option is available since MongoDB {{version}} and will result in an | ||
exception at execution time if specified for an older server version. | ||
replacement: | ||
version: "4.4" | ||
--- | ||
ref: option-requires-5.0 | ||
source: | ||
ref: option-requires-version | ||
file: extracts-option-requires.yaml | ||
content: | | ||
This option is available since MongoDB {{version}} and will result in an | ||
exception at execution time if specified for an older server version. | ||
replacement: | ||
version: "5.0" | ||
--- | ||
ref: option-requires-5.3 | ||
source: | ||
ref: option-requires-version | ||
file: extracts-option-requires.yaml | ||
content: | | ||
This option is available since MongoDB {{version}} and will result in an | ||
exception at execution time if specified for an older server version. | ||
replacement: | ||
version: "5.3" | ||
--- | ||
ref: option-requires-6.0 | ||
source: | ||
ref: option-requires-version | ||
file: extracts-option-requires.yaml | ||
content: | | ||
This option is available since MongoDB {{version}} and will result in an | ||
exception at execution time if specified for an older server version. | ||
replacement: | ||
version: "6.0" | ||
--- | ||
ref: option-requires-7.0 | ||
source: | ||
ref: option-requires-version | ||
file: extracts-option-requires.yaml | ||
replacement: | ||
version: "7.0" | ||
--- | ||
ref: option-requires-version | ||
content: | | ||
This option is available since MongoDB {{version}} and will result in an | ||
exception at execution time if specified for an older server version. | ||
replacement: | ||
version: "7.0" | ||
... |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -27,8 +27,7 @@ Parameters | |||||
|
||||||
``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo` | ||||||
The name or model object of the index to drop. View the existing indexes on | ||||||
the collection using the :phpmethod:`listIndexes() | ||||||
<MongoDB\Collection::listIndexes>` method. | ||||||
the collection using the :phpmethod:`MongoDB\Collection::listIndexes()` method. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
``$options`` : array | ||||||
An array specifying the desired options. | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,7 +29,7 @@ Definition | |
Parameters | ||
---------- | ||
|
||
``$explainable`` : :phpclass:`MongoDB\Operation\Explainable` | ||
``$explainable`` : ``MongoDB\Operation\Explainable`` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Noted that we don't have a stub for the Explainable interface in the docs (nor do we need one), so code formatting is the right call here. |
||
The command to explain. | ||
|
||
``$options`` : array | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -296,7 +296,7 @@ Parameters | |
rules or expressions. You can specify the expressions using the same | ||
operators as MongoDB's | ||
:manual:`query operators </reference/operator/query>` with the | ||
exception of :query:`$geoNear`, :query:`$near`, :query:`$nearSphere`, | ||
exception of :query:`$near`, :query:`$nearSphere`, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I assume this dates back to some earlier version of the docs (e.g. 3.2), but I confirmed |
||
:query:`$text`, and :query:`$where`. | ||
|
||
.. note:: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,16 +19,15 @@ To get started using in-use encryption in your project, the | |
to be compiled with `libmongocrypt <https://github.com/mongodb/libmongocrypt>`_ | ||
(enabled by default). | ||
|
||
Additionally, either `crypt_shared`_ or `mongocryptd`_ are required in order to | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe these might have been links at some point, which would explain the use of a trailing underscore. In any event, they're no longer defined. I will point out that this docs page inconsistently uses code-formatting for crypt_shared and mongocryptd. I'm not sure what the server manual does, but we could probably stand to make this internally consistent. Feel free to make this consistent with whatever you do in docs beyond PHPLIB. I also have no objections to just removing all of the backticks for these terms. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Looks like the Server manual formats them in monospace (like on this page), so I monospaced all instances of crypt_shared and mongocryptd |
||
Additionally, either ``crypt_shared`` or ``mongocryptd`` are required in order to | ||
use *automatic* client-side encryption. Neither is required for *explicit* | ||
encryption. | ||
|
||
|
||
crypt_shared | ||
~~~~~~~~~~~~ | ||
|
||
The :manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>` | ||
(crypt_shared) provides the same functionality as mongocryptd_, but does not | ||
(crypt_shared) provides the same functionality as ``mongocryptd``, but does not | ||
require you to spawn another process to perform automatic encryption. | ||
|
||
By default, the PHP driver attempts to load crypt_shared from the system path(s) | ||
|
@@ -43,7 +42,6 @@ fail if it cannot be loaded. | |
For detailed installation instructions see the MongoDB documentation for the | ||
:manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`. | ||
|
||
|
||
mongocryptd | ||
~~~~~~~~~~~ | ||
|
||
|
@@ -74,7 +72,6 @@ the spawning behavior via various auto encryption | |
mongocryptd is only responsible for supporting automatic client-side encryption | ||
and does not itself perform any encryption or decryption. | ||
|
||
|
||
Managing Encryption Keys | ||
------------------------ | ||
|
||
|
@@ -105,7 +102,6 @@ encryption key (e.g. user-specific encryption keys) or create them dynamically. | |
.. literalinclude:: /examples/encryption/create_data_key.php | ||
:language: php | ||
|
||
|
||
.. _alt_name: | ||
|
||
Referencing Encryption Keys by an Alternative Name | ||
|
@@ -208,7 +204,7 @@ Explicit Encryption | |
~~~~~~~~~~~~~~~~~~~ | ||
|
||
Explicit encryption is a MongoDB community feature and does not use | ||
crypt_shared_ or mongocryptd_. Explicit encryption is provided by the | ||
``crypt_shared`` or ``mongocryptd``. Explicit encryption is provided by the | ||
:php:`MongoDB\Driver\ClientEncryption <mongodb-driver-clientencryption>` class. | ||
|
||
.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,7 +35,7 @@ The bucket can be constructed with various options: | |
needed. The default size is ``261120`` (i.e. 255 KiB). | ||
- ``readConcern``, ``readPreference`` and ``writeConcern`` options can be used | ||
to specify defaults for read and write operations, much like the | ||
:phpclass:`MongoDB\GridFS\Collection` options. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch. |
||
:phpclass:`MongoDB\Collection` options. | ||
|
||
Uploading Files with Writable Streams | ||
------------------------------------- | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was under the impression that both extracts and replacements were supported in Snooty. See slide 49 of Marking up: Tech Writer Training on rST and YAML. Is this not the case, or is there some other limitation here (e.g. a file referencing itself)?
If you're going to remove the inheritance here, I see no reason to preserve the
replacement
block. The version number might as well just be hard-coded into the content. But before doing that, I would like to address my first question.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok I switched it back to using inheritance - I changed "source:" to "inherit:" and that fixed the build issues. I think that rST / YAML powerpoint might need to be updated, I can investigate why "inherit" fixes the problem.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Never mind, seems like the issue was the missing _ before "option-requires-version"