DOCSP-37027: Fix build errors #1289

norareidy · 2024-05-07T15:33:52Z

JIRA - https://jira.mongodb.org/browse/DOCSP-37027
Staging - https://preview-mongodbnorareidy.gatsbyjs.io/php-library/DOCSP-37027-build-errors/
Build log - https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=663a527fb67dbf804ac387bb

This reverts commit 2bdc4f9.

jordan-smith721

LGTM!

jordan-smith721 · 2024-05-07T16:57:01Z

docs/reference/method/MongoDBCollection-dropIndexes.txt

@@ -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.


Suggested change

the collection using the :phpmethod:`MongoDB\Collection::listIndexes()` method.

the collection by using the :phpmethod:`MongoDB\Collection::listIndexes()` method.

jmikola

No big concerns, although I have a question about extracts-options-requires.yaml.

I noticed this was opened against the master branch. Should it apply further back, or do you plan to manually backport to earlier, deployed branches?

jmikola · 2024-05-07T17:00:30Z

docs/includes/extracts-option-requires.yaml

@@ -1,48 +1,43 @@
 ---
 ref: option-requires-4.2
-source:
-  ref: option-requires-version
-  file: extracts-option-requires.yaml


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.

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.

Never mind, seems like the issue was the missing _ before "option-requires-version"

jmikola · 2024-05-07T17:04:04Z

docs/reference/method/MongoDBCollection-explain.txt

@@ -29,7 +29,7 @@ Definition
 Parameters
 ----------

-``$explainable`` : :phpclass:`MongoDB\Operation\Explainable`
+``$explainable`` : ``MongoDB\Operation\Explainable``


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.

jmikola · 2024-05-07T17:07:10Z

docs/reference/method/MongoDBDatabase-createCollection.txt

@@ -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`,


I assume this dates back to some earlier version of the docs (e.g. 3.2), but I confirmed $geoNear is no longer mentioned in the create docs.

jmikola · 2024-05-07T17:10:52Z

docs/tutorial/encryption.txt

@@ -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


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.

Looks like the Server manual formats them in monospace (like on this page), so I monospaced all instances of crypt_shared and mongocryptd

jmikola · 2024-05-07T17:11:07Z

docs/tutorial/gridfs.txt

@@ -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.


Good catch.

docs/includes/extracts-option-requires.yaml

norareidy · 2024-05-07T18:31:25Z

No big concerns, although I have a question about extracts-options-requires.yaml.

I noticed this was opened against the master branch. Should it apply further back, or do you plan to manually backport to earlier, deployed branches?

My mistake, I meant to target this against the v1.16 branch. I'll open another PR on that branch.

jmikola

The corresponding v1.16 PR (#1290) is blocked on CI, so let's wait a bit. If we can merge that first (and up to v1.17 and master), it'd be preferable to rebase this down to a smaller diff.

…uild-issues

* v1.19: DOCSP-37027: Fix build errors (#1289) PHPLIB-1415 Add tests for PHP 8.4 (#1287) PHPLIB-1163 Create tutorial for using MongoDB with Bref (#1273) Relax branch-alias on dev-master to avoid update on each release (#1277) PHPLIB-1424: Fix potentially racy w:0 unified tests (#1276) Leverage PHP 8.0 string functions (#1274) Master is now 1.19-dev

DOCSP-37027: Fix build errors

24c99d2

norareidy requested a review from a team as a code owner May 7, 2024 15:33

norareidy requested a review from GromNaN May 7, 2024 15:33

norareidy added 5 commits May 7, 2024 11:55

more fixes

0b0f6cd

.yaml fixes

dda2a5b

delete file

2bdc4f9

Revert "delete file"

d1627cd

This reverts commit 2bdc4f9.

test yaml fixes

e255080

jordan-smith721 approved these changes May 7, 2024

View reviewed changes

jmikola reviewed May 7, 2024

View reviewed changes

JS feedback

d3c951e

norareidy changed the base branch from master to v1.16 May 7, 2024 17:40

norareidy changed the base branch from v1.16 to master May 7, 2024 17:41

norareidy added 2 commits May 7, 2024 13:46

reorder yaml file

029d07f

file and ref order

52fd388

jmikola reviewed May 7, 2024

View reviewed changes

docs/includes/extracts-option-requires.yaml Outdated Show resolved Hide resolved

norareidy added 2 commits May 7, 2024 14:12

source -> inherit

d21a930

most tech review, test source:

a85c90c

newline

ea4e652

norareidy requested a review from jmikola May 7, 2024 18:34

jmikola approved these changes May 7, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/master' into DOCSP-37027-fix-b…

0dd88f9

…uild-issues

jmikola merged commit 783dba8 into mongodb:master May 10, 2024
14 checks passed

norareidy deleted the DOCSP-37027-fix-build-issues branch May 10, 2024 14:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOCSP-37027: Fix build errors #1289

DOCSP-37027: Fix build errors #1289

Uh oh!

norareidy commented May 7, 2024 •

edited

Loading

Uh oh!

jordan-smith721 left a comment

Uh oh!

jordan-smith721 May 7, 2024

Uh oh!

jmikola left a comment

Uh oh!

jmikola May 7, 2024

Uh oh!

norareidy May 7, 2024

Uh oh!

norareidy May 7, 2024

Uh oh!

jmikola May 7, 2024

Uh oh!

jmikola May 7, 2024

Uh oh!

jmikola May 7, 2024

Uh oh!

norareidy May 7, 2024

Uh oh!

jmikola May 7, 2024

Uh oh!

Uh oh!

norareidy commented May 7, 2024

Uh oh!

jmikola left a comment

Uh oh!

Uh oh!

Uh oh!

	the collection using the :phpmethod:`MongoDB\Collection::listIndexes()` method.
	the collection by using the :phpmethod:`MongoDB\Collection::listIndexes()` method.

DOCSP-37027: Fix build errors #1289

DOCSP-37027: Fix build errors #1289

Uh oh!

Conversation

norareidy commented May 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jordan-smith721 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmikola left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

norareidy commented May 7, 2024

Uh oh!

jmikola left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

norareidy commented May 7, 2024 •

edited

Loading