-
Notifications
You must be signed in to change notification settings - Fork 14
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-44895 - Shorten TOC labels #68
Conversation
✅ Deploy Preview for docs-cpp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
source/index.txt
Outdated
Security </security> | ||
Specialized Data Formats </data-formats> | ||
C++17 Polyfill </polyfill-selection> | ||
Advanced Configuration and Installation </advanced-installation> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mongoKart, for the TOC-only, the ampersand is approved per the Style Guide.
source/get-started.txt
Outdated
/get-started/create-a-connection-string/ | ||
/get-started/connect-to-mongodb/ | ||
/get-started/next-steps/ | ||
Download and Install </get-started/download-and-install/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ampersand over here, too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions. Would like TOC to be as consistent as possible across drivers for similar pages. We can discuss on Monday!
Single Field Indexes </indexes/single-field-index> | ||
Compound Indexes </indexes/compound-index> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Single Field Indexes </indexes/single-field-index> | |
Compound Indexes </indexes/compound-index> | |
Single Field </indexes/single-field-index> | |
Compound </indexes/compound-index> |
S: Since Indexes is already in title, and it is a bit repetitive. But also understand keeping it since Single Field Indexes is more of a MongoDB specific term. We'll discuss
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that Indexes is probably needed here since it is not implied
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on @ltran-mdb2's replies, LGTM!
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-v3.10 v3.10
# Navigate to the new working tree
cd .worktrees/backport-v3.10
# Create a new branch
git switch --create backport-68-to-v3.10
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6ae0203a61719478fe49a6ad7d52a5f981da68fc
# Push it to GitHub
git push --set-upstream origin backport-68-to-v3.10
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v3.10 Then, create a pull request where the |
(cherry picked from commit 6ae0203)
(cherry picked from commit 6ae0203) Co-authored-by: Mike Woofter <[email protected]>
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-44895
Self-Review Checklist