DOCSP-44951 TOC Relabel #144
Merged
Conversation
This file contains hidden or 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-rust ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ltran-mdb2
reviewed
Nov 12, 2024
There was a problem hiding this comment.
Thanks for picking up this work @lindseymoore ! I left a couple suggestions to increase brevity and reduce duplication. Feel free to reach out if you have any questions!
source/usage-examples.txt
Outdated
Comment on lines
22
to
32
| Find a Document </usage-examples/findOne> | ||
| Find Multiple Documents </usage-examples/find> | ||
| Insert a Document </usage-examples/insertOne> | ||
| Insert Multiple Documents </usage-examples/insertMany> | ||
| Update a Document </usage-examples/updateOne> | ||
| Update Multiple Documents </usage-examples/updateMany> | ||
| Replace a Document </usage-examples/replace> | ||
| Delete a Documents </usage-examples/deleteOne> | ||
| Delete Multiple Documents </usage-examples/deleteMany> | ||
| Count Documents </usage-examples/count> | ||
| List Distinct Field Values </usage-examples/distinct> |
There was a problem hiding this comment.
Suggested change
| Find a Document </usage-examples/findOne> | |
| Find Multiple Documents </usage-examples/find> | |
| Insert a Document </usage-examples/insertOne> | |
| Insert Multiple Documents </usage-examples/insertMany> | |
| Update a Document </usage-examples/updateOne> | |
| Update Multiple Documents </usage-examples/updateMany> | |
| Replace a Document </usage-examples/replace> | |
| Delete a Documents </usage-examples/deleteOne> | |
| Delete Multiple Documents </usage-examples/deleteMany> | |
| Count Documents </usage-examples/count> | |
| List Distinct Field Values </usage-examples/distinct> | |
| Find One </usage-examples/findOne> | |
| Find Multiple </usage-examples/find> | |
| Insert One </usage-examples/insertOne> | |
| Insert Multiple </usage-examples/insertMany> | |
| Update One </usage-examples/updateOne> | |
| Update Multiple </usage-examples/updateMany> | |
| Replace One </usage-examples/replace> | |
| Delete One </usage-examples/deleteOne> | |
| Delete Multiple </usage-examples/deleteMany> | |
| Count </usage-examples/count> | |
| List Distinct Values </usage-examples/distinct> |
There was a problem hiding this comment.
Will rename parent section to 'CRUD Examples' to give more context when 'Document' is deleted.
Comment on lines
+9
to
+10
| Connection Guide </fundamentals/connections/connection-guide> | ||
| Connection Options </fundamentals/connections/connection-options> |
There was a problem hiding this comment.
Suggested change
| Connection Guide </fundamentals/connections/connection-guide> | |
| Connection Options </fundamentals/connections/connection-options> | |
| Guide </fundamentals/connections/connection-guide> | |
| Options </fundamentals/connections/connection-options> |
There was a problem hiding this comment.
Would prefer to leave because it fits on one line. My reasoning is to provide the context in the TOC where possible when it becomes a title as vague as "Options" or "Guide". Think it burdens the user with additional cognitive load when they need to refer to the parent section name for context.
Comment on lines
+10
to
+12
| Cluster Monitoring </fundamentals/monitoring/cluster-monitoring> | ||
| Command Monitoring </fundamentals/monitoring/command-monitoring> | ||
| Connection Monitoring </fundamentals/monitoring/connection-monitoring> |
There was a problem hiding this comment.
Suggested change
| Cluster Monitoring </fundamentals/monitoring/cluster-monitoring> | |
| Command Monitoring </fundamentals/monitoring/command-monitoring> | |
| Connection Monitoring </fundamentals/monitoring/connection-monitoring> | |
| Cluster </fundamentals/monitoring/cluster-monitoring> | |
| Command </fundamentals/monitoring/command-monitoring> | |
| Connection </fundamentals/monitoring/connection-monitoring> |
There was a problem hiding this comment.
^same reasoning as above. Would prefer to leave.
Comment on lines
+16
to
+17
| Connection Troubleshooting </connection-troubleshooting> | ||
| Operation Error Handling </op-error-handling> |
There was a problem hiding this comment.
Suggested change
| Connection Troubleshooting </connection-troubleshooting> | |
| Operation Error Handling </op-error-handling> | |
| Troubleshooting </connection-troubleshooting> | |
| Error Handling </op-error-handling> |
There was a problem hiding this comment.
Would prefer to leave. "Trouble shooting" and "error handling" could be synonymous without the additional context.
ltran-mdb2
approved these changes
Nov 13, 2024
sarahemlin
approved these changes
Nov 13, 2024
github-actions bot
pushed a commit
that referenced
this pull request
Nov 13, 2024
(cherry picked from commit 427afa7)
github-actions bot
pushed a commit
that referenced
this pull request
Nov 13, 2024
(cherry picked from commit 427afa7)
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-v2.8 v2.8
# Navigate to the new working tree
cd .worktrees/backport-v2.8
# Create a new branch
git switch --create backport-144-to-v2.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 427afa7423d9ec861082e6a4d0b0a33f7f997980
# Push it to GitHub
git push --set-upstream origin backport-144-to-v2.8
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v2.8Then, create a pull request where the |
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-v2.7 v2.7
# Navigate to the new working tree
cd .worktrees/backport-v2.7
# Create a new branch
git switch --create backport-144-to-v2.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 427afa7423d9ec861082e6a4d0b0a33f7f997980
# Push it to GitHub
git push --set-upstream origin backport-144-to-v2.7
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v2.7Then, create a pull request where the |
lindseymoore
added a commit
to lindseymoore/docs-rust
that referenced
this pull request
Nov 13, 2024
(cherry picked from commit 427afa7)
lindseymoore
added a commit
to lindseymoore/docs-rust
that referenced
this pull request
Nov 13, 2024
(cherry picked from commit 427afa7)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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-44951
Staging - https://deploy-preview-144--docs-rust.netlify.app/
Self-Review Checklist