DOCSP-48179 add async c driver page #90

shuangela · 2025-03-07T16:30:36Z

Pull Request Info

Context: Ported over https://docs.google.com/document/d/1uCNyMKr5vBVil0i2WsnwaAGl-Z3qO9C3nVCgzCGpvCw/edit?tab=t.0#heading=h.tfw7my94k51h to our docs.

JIRA - https://jira.mongodb.org/browse/DOCSP-48179
Staging - https://deploy-preview-90--docs-c.netlify.app/async-c-driver/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2025-03-07T16:31:26Z

✅ Deploy Preview for docs-c ready!

Name	Link
🔨 Latest commit	`0ec3be3`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-c/deploys/67d04d8257ecff0008eee65f
😎 Deploy Preview	https://deploy-preview-90--docs-c.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

rachel-mack

I was didn't edit for Vale rules because this is kind of market-y, so I don't think they should apply. I tried to make the call to action a little more concise at the bottom.

rachel-mack · 2025-03-10T17:26:11Z

source/async-c-driver.txt

+  covering the configuration, building, and usage of the library.
+- `Tutorials <https://mongodb-labs.github.io/mongo-c-driver-async/learn/>`__ to walk you through 
+  common use cases and showcase the potential of asynchronous operations.
+- List of `amongoc features <https://mongodb-labs.github.io/mongo-c-driver-async/ref/features/>`__


Suggested change

- List of `amongoc features <https://mongodb-labs.github.io/mongo-c-driver-async/ref/features/>`__

- A list of `amongoc features <https://mongodb-labs.github.io/mongo-c-driver-async/ref/features/>`__

rachel-mack · 2025-03-10T17:26:55Z

source/async-c-driver.txt

+- `Tutorials <https://mongodb-labs.github.io/mongo-c-driver-async/learn/>`__ to walk you through 
+  common use cases and showcase the potential of asynchronous operations.
+- List of `amongoc features <https://mongodb-labs.github.io/mongo-c-driver-async/ref/features/>`__
+- `amongoc’s design considerations <https://mongodb-labs.github.io/mongo-c-driver-async/explain/consider/>`__ 


Suggested change

- `amongoc’s design considerations <https://mongodb-labs.github.io/mongo-c-driver-async/explain/consider/>`__

- Descriptions of `amongoc’s design considerations <https://mongodb-labs.github.io/mongo-c-driver-async/explain/consider/>`__

rachel-mack · 2025-03-10T17:28:33Z

source/async-c-driver.txt

+- `amongoc’s design considerations <https://mongodb-labs.github.io/mongo-c-driver-async/explain/consider/>`__ 
+  and `amongoc’s asynchrony model <https://mongodb-labs.github.io/mongo-c-driver-async/explain/async-model/>`__
+
+Here’s a simple application that initializes an asynchronous event loop and attempts to establish a connection to a local MongoDB server using the ``amongoc`` library.


Suggested change

Here’s a simple application that initializes an asynchronous event loop and attempts to establish a connection to a local MongoDB server using the ``amongoc`` library.

The following example is an application that initializes an asynchronous event loop and attempts to establish a connection to a local MongoDB server using the ``amongoc`` library:

rachel-mack · 2025-03-10T18:13:12Z

source/async-c-driver.txt

+This public preview release is focused on gathering user feedback to inform the architectural 
+decisions for a production-ready version. We invite you to try out ``amongoc`` and share your thoughts,
+suggestions, and issues. Please participate in GitHub `discussions <https://github.com/mongodb-labs/mongo-c-driver-async/discussions>`__ and `issues <https://github.com/mongodb-labs/mongo-c-driver-async/issues>`__ to 
+provide your feedback, especially about the interface and build & runtime requirements. Over the next few months, 
+our goal is to collect as much user input as possible to align with the needs and expectations of
+our user community. Your feedback is invaluable, and we eagerly look forward to hearing from you 
+and seeing what you'll create with ``amongoc``!


Suggested change

This public preview release is focused on gathering user feedback to inform the architectural

decisions for a production-ready version. We invite you to try out ``amongoc`` and share your thoughts,

suggestions, and issues. Please participate in GitHub `discussions <https://github.com/mongodb-labs/mongo-c-driver-async/discussions>`__ and `issues <https://github.com/mongodb-labs/mongo-c-driver-async/issues>`__ to

provide your feedback, especially about the interface and build & runtime requirements. Over the next few months,

our goal is to collect as much user input as possible to align with the needs and expectations of

our user community. Your feedback is invaluable, and we eagerly look forward to hearing from you

and seeing what you'll create with ``amongoc``!

This public preview release is focused on gathering user feedback to inform the architectural

decisions for a production-ready version of ``amongoc``. We invite you to share your thoughts,

suggestions, and issues in GitHub `discussions <https://github.com/mongodb-labs/mongo-c-driver-async/discussions>`__ and `issues <https://github.com/mongodb-labs/mongo-c-driver-async/issues>`__. We are especially interested in your opinions about the interface, and the build and runtime requirements. Our goal is to collect as much user input as possible to align with the needs and expectations of

our user community.

Your feedback is invaluable, and we eagerly look forward to hearing from you

and seeing what you'll create with ``amongoc``!

rachel-mack · 2025-03-10T18:15:23Z

source/index.txt

@@ -14,6 +14,7 @@
   Indexes </indexes>
   Monitor Your Application </monitoring>
   Security </security>
+   amongoc Public Preview </async-c-driver>


I think I would move this to the very top, above Get Started - unless they're told in advance, people aren't going to know to look for this, so it needs to be super visible.

Suggested change

amongoc Public Preview </async-c-driver>

Public Preview: amongoc </async-c-driver>

rachel-mack · 2025-03-10T18:15:42Z

source/async-c-driver.txt

+.. _c-async-driver:
+
+======================
+amongoc Public Preview


Suggested change

amongoc Public Preview

Public Preview: amongoc

bisht2050 · 2025-03-11T11:20:55Z

source/async-c-driver.txt

+.. _c-async-driver:
+
+=======================
+Public Preview: amongoc


Could we reword the title to something more user/SEO friendly:
"Async C Driver: Public Preview"

bisht2050 · 2025-03-11T11:24:20Z

source/async-c-driver.txt

+Asynchronous programming allows applications to remain responsive while waiting for 
+I/O operations to complete, making it ideal for high-performance, network-intensive 
+use cases. ``amongoc`` will also facilitate the integration of MongoDB into asynchronous
+frameworks like Drogon. Notably, it has also been the top requested feature for the 


There's a hyperlink expected here.

https://feedback.mongodb.com/forums/924286-drivers/suggestions/47080057-asynchronous-variant-of-mongodb-c-driver

bisht2050 · 2025-03-11T15:08:08Z

The text in sidebar doesn't match the title (Asynchronous vs Async). Is this intended?

shuangela · 2025-03-11T15:15:24Z

The text in sidebar doesn't match the title (Asynchronous vs Async). Is this intended?

Hi @bisht2050, yes this was intentional: it's ok for our table of contents titles to not match the titles on the page. The reason why I changed it is that asynchronous sounded more formal for me, however if you'd prefer to keep async due to preference from the C driver community or if async will be widely understood, I'm happy to change it back!

* add async c driver page * change title * revert wording * fix bulleted list * fix vale error * move c code to seperate file * fix include * rm edits * fix typo * rb feedback (cherry picked from commit 2b66272)

add async c driver page

cd2ba37

shuangela added 6 commits March 7, 2025 11:37

change title

3efd692

revert wording

c1e3458

fix bulleted list

a467fd7

fix vale error

cabb5c2

move c code to seperate file

513f48f

fix include

d742d56

rachel-mack approved these changes Mar 10, 2025

View reviewed changes

shuangela added 2 commits March 10, 2025 14:24

rm edits

857d94d

fix typo

5e6aa0d

shuangela requested a review from bisht2050 March 10, 2025 18:36

bisht2050 reviewed Mar 11, 2025

View reviewed changes

rb feedback

0ec3be3

shuangela requested a review from bisht2050 March 11, 2025 15:05

bisht2050 approved these changes Mar 11, 2025

View reviewed changes

shuangela merged commit 2b66272 into mongodb:master Mar 11, 2025
4 of 5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-48179 add async c driver page #90

DOCSP-48179 add async c driver page #90

shuangela commented Mar 7, 2025 •

edited

Loading

netlify bot commented Mar 7, 2025 •

edited

Loading

rachel-mack left a comment

rachel-mack Mar 10, 2025

rachel-mack Mar 10, 2025

rachel-mack Mar 10, 2025

rachel-mack Mar 10, 2025

rachel-mack Mar 10, 2025

rachel-mack Mar 10, 2025

bisht2050 Mar 11, 2025

bisht2050 Mar 11, 2025

bisht2050 commented Mar 11, 2025

shuangela commented Mar 11, 2025

	- List of `amongoc features <https://mongodb-labs.github.io/mongo-c-driver-async/ref/features/>`__
	- A list of `amongoc features <https://mongodb-labs.github.io/mongo-c-driver-async/ref/features/>`__

	- `amongoc’s design considerations <https://mongodb-labs.github.io/mongo-c-driver-async/explain/consider/>`__
	- Descriptions of `amongoc’s design considerations <https://mongodb-labs.github.io/mongo-c-driver-async/explain/consider/>`__

	Here’s a simple application that initializes an asynchronous event loop and attempts to establish a connection to a local MongoDB server using the ``amongoc`` library.
	The following example is an application that initializes an asynchronous event loop and attempts to establish a connection to a local MongoDB server using the ``amongoc`` library:

	amongoc Public Preview </async-c-driver>
	Public Preview: amongoc </async-c-driver>

DOCSP-48179 add async c driver page #90

DOCSP-48179 add async c driver page #90

Conversation

shuangela commented Mar 7, 2025 • edited Loading

Pull Request Info

Self-Review Checklist

netlify bot commented Mar 7, 2025 • edited Loading

✅ Deploy Preview for docs-c ready!

rachel-mack left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bisht2050 commented Mar 11, 2025

shuangela commented Mar 11, 2025

shuangela commented Mar 7, 2025 •

edited

Loading

netlify bot commented Mar 7, 2025 •

edited

Loading