Skip to content

012424: add missing list items and update REVIEWING.md #109

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 24, 2024
Merged

012424: add missing list items and update REVIEWING.md #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61d75c5
012424: add missing list items and update REVIEWING.md
Jan 24, 2024
f5c3179
fix geo link
Jan 24, 2024
62f9b8c
PRR fixes
Jan 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions REVIEWING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pull Request Reviewing Guidelines for Rust Driver Documentation
# Pull Request Reviewing Guidelines for the Rust Driver Documentation

Contributions to the set of documents in this repository can receive reviews from one or both of the following types of reviews:

Expand All @@ -22,9 +22,8 @@ Review the structure, wording, and flow of the information in the PR, and correc
### What Not to Review

Nothing is completely off-limits to a copy review of a PR -- if you notice a technical issue, it's best to call it out early.
Copy reviewers should constrain their reviews to content within the
scope of the JIRA ticket, or otherwise create tickets to address
anything unrelated.
Copy reviewers should constrain their reviews to content within the scope of the JIRA ticket, or otherwise create PRs to address anything unrelated.


## Technical Review

Expand All @@ -42,3 +41,4 @@ While we welcome any recommendations on wording and structure, avoid blocking ap
- Wording of sentences, although corrections to technical claims are welcome
- Structure of the page
- Any unchanged lines outside the PR unless relevant to the ticket acceptance criteria.

8 changes: 5 additions & 3 deletions source/includes/fundamentals-sections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ Fundamentals section:
- :ref:`Create a Time Series Collection <rust-time-series>`
- :ref:`Record Driver Events <rust-tracing-logging>`
- :ref:`Run A Database Command <rust-run-command>`
- :ref:`Specify Collations to Order Results <rust-collations>`
- :ref:`Optimize Driver Performance <rust-performance>`
Copy link
Contributor

@rustagir rustagir Jan 24, 2024

Choose a reason for hiding this comment

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

S: nit while you are editing this file, could you move Collations to the correct position to match the way that it appears in the drawer?

- :ref:`Specify Collations to Order Results <rust-collations>`
- :ref:`Configure Asynchronous and Synchronous Runtimes <rust-runtimes>`
- :ref:`Monitor Driver Events <rust-monitoring>`
- :ref:`Query and Write Geospatial Data <rust-geo-guide>`
- :ref:`Store and Retrieve Large Files by Using GridFS <rust-gridfs>`

..
- :atlas:`Connect to MongoDB Atlas from AWS Lambda </manage-connections-aws-lambda/>`
- :ref:`Store and Retrieve Large Files by Using GridFS <rust-gridfs>`

- :ref:`Encrypt Fields <rust-fle>`
- :ref:`Query and Write Geospatial Data <rust-geo>`