Various documentation updates #281
Conversation
|
If you added an example to |
jmikola
force-pushed
the
docs
branch
2 times, most recently
from
caedb40 to
3cc5732
Compare
jmikola
force-pushed
the
docs
branch
2 times, most recently
from
aef4c8f to
8e9a89b
Compare
jmikola
force-pushed
the
docs
branch
2 times, most recently
from
2daf862 to
b8a80af
Compare
|
|
||
| .. .. figure:: img/save-flowchart.png | ||
| .. .. figure:: /images/save-flowchart.png |
There was a problem hiding this comment.
@schmalliso: When I uncommented this, I received a build warning for image file not readable: images/save-flowchart.png. Any ideas?
On a side note, I also get another build warning for logo file '.static/logo-mongodb.png' does not exist. Is this related to the empty /docs/.static/.mongodb file? Should we leave that in place for the upstream build process?
There was a problem hiding this comment.
I need to put the flowchart image into our docs-assets folder and hook that up, for the moment it's commented out so that the error doesn't happen.
The logo-mongodb.png error doesn't happen when one actually publishes, but is does happen when building locally (for reasons that I can't recall). I'd recommend leaving it in place for the moment, and I'll poke Andrew/Kay about why we've not killed it off yet.
There was a problem hiding this comment.
I assume you mean leave the comment in place? Is /images/ the correct path here?
|
|
||
| The index of each ID in the map corresponds to each document's position in the | ||
| bulk operation. If a document had an ID prior to inserting (i.e. the driver did | ||
| not generate an ID), this will contain its ``_id`` field value. Any |
There was a problem hiding this comment.
[nit] s/this/the index/
|
|
||
| The index of each ID in the map corresponds to each document's position in the | ||
| bulk operation. If a document had an ID prior to upserting (i.e. the server did | ||
| not generate an ID), this will contain its ``_id`` field value. Any |
There was a problem hiding this comment.
[nit] s/this/the index/
There was a problem hiding this comment.
Done for all occurrences.
| Return Values | ||
| ------------- | ||
|
|
||
| Return whether the write was acknowledged. |
There was a problem hiding this comment.
Would it be clearer to say "Boolean indicating if the write was acknowledged"?
There was a problem hiding this comment.
Done for all methods returning a boolean.
| Connecting with SSL and Authentication | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example demonstrates how to connect to a MongoDB replica set with |
There was a problem hiding this comment.
Might be good to mention here that the URI is a standard MongoDB connection string and link to those docs.
There was a problem hiding this comment.
A link to Connection String URI Format was already in the parameter documentation, but I've also added it do the general "See Also" list at the bottom of the page.
|
|
||
| .. .. figure:: img/save-flowchart.png | ||
| .. .. figure:: /images/save-flowchart.png |
There was a problem hiding this comment.
I need to put the flowchart image into our docs-assets folder and hook that up, for the moment it's commented out so that the error doesn't happen.
The logo-mongodb.png error doesn't happen when one actually publishes, but is does happen when building locally (for reasons that I can't recall). I'd recommend leaving it in place for the moment, and I'll poke Andrew/Kay about why we've not killed it off yet.
| /reference/method/MongoDBModelCollectionInfo-getOptions | ||
| /reference/method/MongoDBModelCollectionInfo-isCapped | ||
|
|
||
| ---- |
There was a problem hiding this comment.
We've never included horizontal lines in the docs, so I'm not sure how this might go crazy when we overhaul the CSS.
If you're not married to them, it would be more consistent with the rest of the docs to not include the horizontal lines.
There was a problem hiding this comment.
In the interest of keeping the left-hand TOC column concise, I wanted to bundle these insignificant classes into a single page. Without the horizontal lines, each class seemed to run right into the next, since we don't have large paragraphs to break things up like a tutorial page.
I'd love to discuss how we can improve the TOC for this later on. One oddity I noticed is that when you open one of these methods, the left-hand column will show methods for all classes that were on this page (which is likely because they all have the same TOC parent).
For now, I'd prefer to keep the horizontal lines in and clean it up if the CSS overhaul breaks something. HR tags are usually ignored, so it's low risk.
https://jira.mongodb.org/browse/PHPLIB-174
https://jira.mongodb.org/browse/PHPLIB-187
https://jira.mongodb.org/browse/PHPLIB-195
https://jira.mongodb.org/browse/PHPLIB-234
https://jira.mongodb.org/browse/PHPLIB-235
https://jira.mongodb.org/browse/DOCS-8719