Skip to content
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

DOCSP-43056 Run a command #64

Merged

Conversation

stephmarie17
Copy link
Collaborator

@stephmarie17 stephmarie17 commented Oct 1, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-43056
Staging - https://deploy-preview-64--docs-c.netlify.app/run-command/

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?

Copy link

netlify bot commented Oct 1, 2024

Deploy Preview for docs-c ready!

Name Link
🔨 Latest commit d4797ce
🔍 Latest deploy log https://app.netlify.com/sites/docs-c/deploys/67004f01b52aa30008947e19
😎 Deploy Preview https://deploy-preview-64--docs-c.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@@ -9,6 +9,7 @@
Get Started </get-started>
/connect
/databases-collections
/run-command
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[note to reviewer] This will move to the /databases-collections section once DOCSP-4063 is merged.

source/run-command.txt Outdated Show resolved Hide resolved
@stephmarie17 stephmarie17 changed the title DOCSP 43056 Run a command DOCSP-43056 Run a command Oct 1, 2024
@stephmarie17 stephmarie17 marked this pull request as ready for review October 1, 2024 19:08
.. _c-run-command:

======================
Run a Database Command
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[note to reviewer] Added "Database" to this title as this page will live in the /databases-collections drawer.

Copy link
Collaborator

@jordan-smith721 jordan-smith721 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! A few changes and suggestions

source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@jordan-smith721 jordan-smith721 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple more suggestions, otherwise LGTM with the highlighting adjusted!

source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
source/run-command.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@kevinAlbs kevinAlbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with pending comments addressed.

I highly recommend running compile on code files. I expect that can catch typos early and may ease writing examples. To compile on macOS:

$ brew install mongo-c-driver
$ clang -o run-command run-command.c $(pkg-config --libs --cflags libmongoc-1.0)

source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Outdated Show resolved Hide resolved
source/includes/usage-examples/run-command.c Show resolved Hide resolved
source/includes/usage-examples/run-command.c Show resolved Hide resolved
@stephmarie17 stephmarie17 merged commit 85f3db8 into mongodb:standardization Oct 4, 2024
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants