DOCSP-45177 - Create a client #88
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-ruby ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mongoKart
commented
Dec 5, 2024
| - Optional. Authentication credentials. If you include these, the client | ||
| authenticates the user against the database specified in ``authSource``. | ||
| For more information about the ``authSource`` connection option, see | ||
| :ref:`ruby-auth`. |
There was a problem hiding this comment.
broken link for now
There was a problem hiding this comment.
Maybe leave these commented out as TODOs for now? It might be a little while before this page gets created
There was a problem hiding this comment.
couldn't get the syntax to play nice with tables. will knock these out soon.
mongoKart
commented
Dec 5, 2024
source/connect/mongoclient.txt
Outdated
|
|
||
| - Optional. A query string that specifies connection-specific | ||
| options as ``<name>=<value>`` pairs. See | ||
| :ref:`ruby-connection-options` for a full description of |
There was a problem hiding this comment.
broken link for now
norareidy
approved these changes
Dec 5, 2024
source/connect/mongoclient.txt
Outdated
Comment on lines
25
to
27
| - A **connection URI**, also known as a *connection string*, which tells the {+driver-short+} | ||
| which MongoDB deployment to connect to. | ||
| - A **Mongo::Client** object, which creates the connection to the MongoDB deployment |
There was a problem hiding this comment.
S: remove the articles, since they're at the start of each list item
Suggested change
| - A **connection URI**, also known as a *connection string*, which tells the {+driver-short+} | |
| which MongoDB deployment to connect to. | |
| - A **Mongo::Client** object, which creates the connection to the MongoDB deployment | |
| - **Connection URI**, also known as a *connection string*, which tells the {+driver-short+} | |
| which MongoDB deployment to connect to | |
| - **Mongo::Client** object, which creates the connection to the MongoDB deployment |
| - Optional. Authentication credentials. If you include these, the client | ||
| authenticates the user against the database specified in ``authSource``. | ||
| For more information about the ``authSource`` connection option, see | ||
| :ref:`ruby-auth`. |
There was a problem hiding this comment.
Maybe leave these commented out as TODOs for now? It might be a little while before this page gets created
source/connect/mongoclient.txt
Outdated
| To create a connection to MongoDB, construct an instance of the ``Mongo::Client`` class, | ||
| passing the connection URI to the constructor. | ||
| The following example constructs a ``Mongo::Client`` object to connect to a MongoDB | ||
| deployment on port ``27017`` of ``localhost``. |
There was a problem hiding this comment.
S: add colon
Suggested change
| deployment on port ``27017`` of ``localhost``. | |
| deployment on port ``27017`` of ``localhost``: |
source/connect/mongoclient.txt
Outdated
Comment on lines
135
to
138
| To learn more about creating a ``Mongo::Client`` object with the {+driver-short+}, | ||
| see the following API documentation: | ||
|
|
||
| - `Mongo::Client <{+api-root+}/Mongo/Client.html>`__ |
There was a problem hiding this comment.
S: you can just make this a single sentence, since there's only one list item
Suggested change
| To learn more about creating a ``Mongo::Client`` object with the {+driver-short+}, | |
| see the following API documentation: | |
| - `Mongo::Client <{+api-root+}/Mongo/Client.html>`__ | |
| To learn more about creating a ``Mongo::Client`` object with the {+driver-short+}, | |
| see the `Mongo::Client <{+api-root+}/Mongo/Client.html>`__ API documentation. |
source/connect.txt
Outdated
| :values: reference | ||
|
|
||
| .. meta:: | ||
| :description: Learn how to use the {+driver-short+} to connect to MongoDB. |
There was a problem hiding this comment.
S: I don't think constants work in meta descriptions
Suggested change
| :description: Learn how to use the {+driver-short+} to connect to MongoDB. | |
| :description: Learn how to use the Ruby driver to connect to MongoDB. |
5 tasks
jamis
approved these changes
Dec 5, 2024
REVIEWING.md
Outdated
| @@ -0,0 +1,42 @@ | |||
| # Pull Request Reviewing Guidelines for C#/.NET Driver Documentation | |||
There was a problem hiding this comment.
Copy/paste artifact? I assume this is supposed to be "Ruby Driver Documentation".
There was a problem hiding this comment.
sure is. good catch
norareidy
added a commit
that referenced
this pull request
Jan 31, 2025
* add actions * Update add-netlify-links.yml (#90) (#91) (cherry picked from commit c2b53c0) Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> * DOCSP-45177 - Create a client (#88) * DOCSP-45170: Landing page and cleanup (#89) * DOCSP-45170: Landing page and cleanup * copy snooty file * fix toc * netlify script * fix * put old files in folder * MW feedback * DOCSP-45171: Download and Install (#92) * DOCSP-45171: Download and Install * snooty * landing page * MW feedback * DR feedback * fix * DOCSP-45173: Deployment & connection string (#94) * DOCSP-45173: Deployment & connection string * edits * edit image * SA feedback * DOCSP-45187: Update * Fixes * Fix * DOCSP-45175: Connect to MongoDB (#95) * DOCSP-45175: Connect to MongoDB * fixes * edits, next steps * JS feedback * DR feedback * Fix * MW feedback * DOCSP-45194: Retrieve data (#96) * DOCSP-45194: Retrieve data * edits * build errors * api links * JB feedback * DOCSP-45186: Insert * Fix * Fix * Fix * DOCSP-45212 Compatibility (#97) * NR feedback * MW feedback + adjusting code to be more idiomatic * DOCSP-45189: Delete * Fixes * Fix * DOCSP-45188: Replace * JS feedback * DOCSP-45203 Single Field Indexes (#100) * add files * Update add-netlify-links.yml (#90) * DOCSP-45076: Document that count supports different filters from countDocuments * Test fix * Fix * Try again * Never mind * NR suggestion * DOCSP-45203 Single Field Indexes * Edits * edits * get rid of old commit work * code spacing * Stephanie's reiview * Tech review code improvements * update api links * add a space at eof * update listing description * add context to ex query code comment * style edit on prev --------- Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Co-authored-by: Michael Morisi <michael.morisi@mongodb.com> * Technical feedback * DOCSP-45188: Replace * Fixes * JS feedback * DOCSP-45210 What's New (#99) * DOCSP-45195: Project fields (#105) * DOCSP-45195: Project fields * edits * SA feedback * DOCSP-45196: Limit, skip, and sort (#109) * DOCSP-45196: Limit, skip, and sort * code output * fixes * DOCSP-45193: Specify queries (#102) * DOCSP-45193: Specify queries * edits * wording * LM feedback * JB feedback * DOCSP-45197: Count documents (#110) * DOCSP-45197: Count documents * edits * code fix * JS feedback * DOCSP-45198: Distinct values (#111) * DOCSP-45198: Distinct values * edits * RR feedback * DOCSP-45185: Write landing page * Fixes * MW feedback * DOCSP-45204 Compound Index (#106) * DOCSP-45204 Compound Index * fix ref * fix code comment spacing * specify create one ref * bold single field * tech review comment * remove comments from snippet and spacing fix * repeated text * DOCSP-45205 Multikey Indexes (#103) * DOCSP-45205 Multikey Indexes * first draft * edits * remove quotes from key name * remove comments from code snippets * DOCSP-45190: Bulk Write * Fixes * link fix * Fix * JS feedback * DOCSP-45182-ruby-databases-collection-2 * added api links * links * better link * style guide and link fixes * api fixes * testing bundler * DOCSP-45191: GridFS * Fix * added separate text file, deleted some pages that were added on from a new pr * DOCSP-45214 Add transactions (#115) * feedback * more feedback * link * final link * DOCSP-45191: MW feedback * small change * small change * revert change * DOCSP-45184-ruby-replica-sets * fix errors and links * fixes * link fix * syntax * last fixes * DOCSP-45183-time-series-collections * DOCSP-45181: Stable API * Fix * half feedback * LM feedback * DOCSP-45199: Cursors (#120) * DOCSP-45199: Cursors * edits * fix link * JS feedback * tech review * other half of feedback * style guide * added more copy * added page * formatting * trying for output * again * formatting * DOCSP-45191: GridFS follow-up * Fix * Jamis technical feedback * add * feedback * ahh * toctree * api links * feedback * toctree and errors * file * errors * DOCSP-45209: Authentication landing + Authentication mechanisms * Fixes * feedback * fix build * update toctree * Reorganize auth mechanisms to separate pages * Fix * redoing feedback that got merged out * toctree * Fix * fix typo * mark troubleshooting todo * feedback * DOCSP-45192-read-data-page * Tweak the Kerberos and IAM pages * Fix * wrote page * fix links * last link fix * feedback * keyword * keyword 2 * feedback * fix link * MW feedback, round 1 * Fix * Fix * Kerberos file tweaks, also fixes * Fix * DOCSP-45176: Run a command * Fix * RM feedback * DOCSP-45202 Index Overview (#112) * DOCSP-45202 Index Overview * edits * fix ref * atlas search updates * small fix * add api section, edit atlas search examples * edits * tech review * DOCSP-45206 Atlas Search Index (#113) * DOCSP-45206 Atlas Search Indexes * first draft * draft code * edits * using native api * edits * emphasize lines * RM typo * var rename * code spacing * DOCSP-45178 Choose a Connection Target (#125) * DOCSP-45178 Choose a Connection Target * edits and add page to TOC * more small edits * last edits * no hyper linked period * coe improvements * stable api single quote * feedback * feedback * fix toctree issue * DOCSP-45192-read-data-page * quotes * label * link * Second round of MW feedback * Fixes * Fix * MW feedback * feedback * fix typo * DOCSP-45200: Change streams (#123) * DOCSP-45200: Change streams * edits * JB feedback * Jamis feedback * DOCSP-45179 Configure TLS (#129) * Configure TLS * insecure tls * edits * monospace * 1/2 MW edits * last of MW revisions and table * table reformat * spacing edit * formatting edits * format * edit * MW last comments * small change * tech review * DOCSP-45207 Transform data with aggregation (#131) * DOCSP-45812 Connection Options (#132) * DOCSP-45812 Connection Options * edits * more edits * more edits * format * format * RM review * another link * add timeout_ms * remove deprecated options * DOCSP-45211 Upgrade major versions (#134) * DOCSP-46860: In-use encryption (#138) * DOCSP-45201 Cluster monitoring (#133) * DOCSP-45201 Cluster monitoring * first draft * remove eevrything not about cluster monitoring: * table changes * review * final few changes * NR review comments * NR comments * look through * tech review comments * DOCSP-45180 Server selection (#135) * DOCSP-45188 Server selection * quick add * remove page * spacing * review comment * same edit * tech review * DOCSP-46862 Issues & Help (#139) * DOCSP-46862 Issues & Help * edits * internal review * weird build fail * build mysteriously good again * DOCSP-42104 CSOT (#136) * first draft * revisions * edit * edits * code edits * Rea comments * edits * last internal comments * tech review + add atlas search api refs * edit to api refs * code comment edit * fix code example option name * DOCSP-46650: Cleanup (#137) * DOCSP-46650: Cleanup * redirects * more cleanup * rename, test api link * api links * fix toc api link * monitoring, edits * check api links * LM feedback * snooty * remove old redirects * LM feedback --------- Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Michael Morisi <michael.morisi@mongodb.com> Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com> Co-authored-by: Grace Miller <grace.miller@mongodb.com> Co-authored-by: rustagir <rea.rustagi@mongodb.com> Co-authored-by: gmiller-mdb <135852653+gmiller-mdb@users.noreply.github.com>
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-45177
Staging Links
Self-Review Checklist