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-46362 - TOC reorganization #191

Merged
merged 36 commits into from
Mar 19, 2025

Conversation

mongoKart
Copy link
Collaborator

@mongoKart mongoKart commented Feb 28, 2025

Copy link

netlify bot commented Feb 28, 2025

Deploy Preview for docs-pymongo ready!

Name Link
🔨 Latest commit 13ccbf6
🔍 Latest deploy log https://app.netlify.com/sites/docs-pymongo/deploys/67db0eb8bf60e6000889b926
😎 Deploy Preview https://deploy-preview-191--docs-pymongo.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.

@mongoKart mongoKart changed the title Docsp 46362 toc reorg DOCSP-46362 - TOC reorganization Feb 28, 2025
Copy link
Collaborator Author

@mongoKart mongoKart Mar 4, 2025

Choose a reason for hiding this comment

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

Get Started on one page now

Copy link
Collaborator

@rachel-mack rachel-mack left a comment

Choose a reason for hiding this comment

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

LGTM

I added 'Aggregation` as an L1 with a comment in the TOC spreadsheet, and updated the title of 'Versioning' to 'Reference'

@sarahemlin
Copy link
Collaborator

Hey @mongoKart & @rachel-mack! One of my general TOC principles is that a category has to have more than one subcategory. Here, we have Aggregation, with the only thing under it as Tutorials, and then Tutorials has a bunch of stuff. Is there a way we can take out a level, either by calling the L1 'Aggregation Tutorials' or adding in some other content at the L2 besides Tutorials, so it's not lonely?

@mongoKart
Copy link
Collaborator Author

mongoKart commented Mar 14, 2025

Hey @mongoKart & @rachel-mack! One of my general TOC principles is that a category has to have more than one subcategory. Here, we have Aggregation, with the only thing under it as Tutorials, and then Tutorials has a bunch of stuff. Is there a way we can take out a level, either by calling the L1 'Aggregation Tutorials' or adding in some other content at the L2 besides Tutorials, so it's not lonely?

Sure--I moved the tutorials to be L2 subpages of Aggregation.

FYI @stephmarie17

@mongoKart mongoKart requested a review from sarahemlin March 14, 2025 20:33
@sarahemlin
Copy link
Collaborator

@mongoKart , the aggregation section looks great. Thank you!

The other thing I wanted to mention was that you've got one section that goes five deep, and I wondered if there was a way to reduce it by one level. Guidance from the TOC working group is that they want writers to go no more than four levels deep, and since we're re-doing the Drivers TOCs, they thought it would be good to fix it at the start, if possible.

This one is Connect > Specify Connection Options > Enable Authentication > Authentication > [authentication options]

Could the 'Authentication' heading disappear so the authentication choices are under 'Enable Authentication'? Just an idea; I don't know all the differences on these.

@mongoKart
Copy link
Collaborator Author

@mongoKart , the aggregation section looks great. Thank you!

The other thing I wanted to mention was that you've got one section that goes five deep, and I wondered if there was a way to reduce it by one level. Guidance from the TOC working group is that they want writers to go no more than four levels deep, and since we're re-doing the Drivers TOCs, they thought it would be good to fix it at the start, if possible.

This one is Connect > Specify Connection Options > Enable Authentication > Authentication > [authentication options]

Could the 'Authentication' heading disappear so the authentication choices are under 'Enable Authentication'? Just an idea; I don't know all the differences on these.

Hey @sarahemlin, sorry about that; I intended only to put TLS in that menu, but accidentally added the entire Auth section. Now fixed, but it raises a new question: is it okay to have the same page linked in different sections of the TOC, like we're doing with TLS here?

@sarahemlin
Copy link
Collaborator

Hey @mongoKart, alas! We can't link the same page in two places on the same TOC.

@mongoKart mongoKart removed the request for review from sarahemlin March 17, 2025 21:21
@mongoKart mongoKart merged commit 9192e14 into mongodb:master Mar 19, 2025
5 of 6 checks passed
@mongoKart mongoKart deleted the docsp-46362-toc-reorg branch March 19, 2025 19:43
Copy link

The backport to v4.10 failed:

The process '/usr/bin/git' failed with exit code 1

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-v4.10 v4.10
# Navigate to the new working tree
cd .worktrees/backport-v4.10
# Create a new branch
git switch --create backport-191-to-v4.10
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9192e1475756a87154432746be0f619514e5e4fa
# Push it to GitHub
git push --set-upstream origin backport-191-to-v4.10
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v4.10

Then, create a pull request where the base branch is v4.10 and the compare/head branch is backport-191-to-v4.10.

Copy link

The backport to v4.9 failed:

The process '/usr/bin/git' failed with exit code 1

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-v4.9 v4.9
# Navigate to the new working tree
cd .worktrees/backport-v4.9
# Create a new branch
git switch --create backport-191-to-v4.9
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9192e1475756a87154432746be0f619514e5e4fa
# Push it to GitHub
git push --set-upstream origin backport-191-to-v4.9
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v4.9

Then, create a pull request where the base branch is v4.9 and the compare/head branch is backport-191-to-v4.9.

Copy link

The backport to v4.8 failed:

The process '/usr/bin/git' failed with exit code 1

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-v4.8 v4.8
# Navigate to the new working tree
cd .worktrees/backport-v4.8
# Create a new branch
git switch --create backport-191-to-v4.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9192e1475756a87154432746be0f619514e5e4fa
# Push it to GitHub
git push --set-upstream origin backport-191-to-v4.8
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v4.8

Then, create a pull request where the base branch is v4.8 and the compare/head branch is backport-191-to-v4.8.

Copy link

The backport to v4.7 failed:

The process '/usr/bin/git' failed with exit code 1

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-v4.7 v4.7
# Navigate to the new working tree
cd .worktrees/backport-v4.7
# Create a new branch
git switch --create backport-191-to-v4.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9192e1475756a87154432746be0f619514e5e4fa
# Push it to GitHub
git push --set-upstream origin backport-191-to-v4.7
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v4.7

Then, create a pull request where the base branch is v4.7 and the compare/head branch is backport-191-to-v4.7.

Copy link

The backport to v4.11 failed:

The process '/usr/bin/git' failed with exit code 1

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-v4.11 v4.11
# Navigate to the new working tree
cd .worktrees/backport-v4.11
# Create a new branch
git switch --create backport-191-to-v4.11
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9192e1475756a87154432746be0f619514e5e4fa
# Push it to GitHub
git push --set-upstream origin backport-191-to-v4.11
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-v4.11

Then, create a pull request where the base branch is v4.11 and the compare/head branch is backport-191-to-v4.11.

mongoKart added a commit that referenced this pull request Mar 19, 2025
mongoKart added a commit that referenced this pull request Mar 19, 2025
(cherry picked from commit 9192e14)
(cherry picked from commit 4a57ec1)
mongoKart added a commit that referenced this pull request Mar 19, 2025
(cherry picked from commit 9192e14)
(cherry picked from commit 4a57ec1)
mongoKart added a commit that referenced this pull request Mar 19, 2025
(cherry picked from commit 9192e14)
(cherry picked from commit 4a57ec1)
mongoKart added a commit that referenced this pull request Mar 19, 2025
(cherry picked from commit 9192e14)
(cherry picked from commit 4a57ec1)
(cherry picked from commit 2c50bc2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants