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-48812 - Match PyMongo TOC #556

Merged
merged 10 commits into from
Apr 7, 2025

Conversation

mongoKart
Copy link
Collaborator

@mongoKart mongoKart commented Apr 3, 2025

This PR is just for creating the correct TOC structure for CC

  • Not all pages have content / the right content. There are TODOs for existing content that still needs to be integrated (will be done in separate PR)
  • No redirects yet

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-48812

Staging Links

  • connect
  • connect/connection-options/csot
  • connect/connection-targets
  • crud
  • crud/query
  • crud/query/cursors
  • data-formats
  • data-formats/custom-types
  • data-formats/extended-json
  • integrations
  • logging-and-monitoring
  • reference
  • security
  • get-started
  • index
  • aggregation
  • atlas-search
  • atlas-vector-search
  • connect/connection-options
  • connect/connection-options/connection-pools
  • connect/connection-options/network-compression
  • connect/connection-options/server-selection
  • connect/connection-options/stable-api
  • connect/connection-troubleshooting
  • connect/mongoclient
  • crud/bulk-write
  • crud/configure
  • crud/delete
  • crud/geo
  • crud/gridfs
  • crud/insert
  • crud/query/count
  • crud/query/distinct
  • crud/query/find
  • crud/query/project
  • crud/query/specify-documents-to-return
  • crud/query/specify-query
  • crud/replace
  • crud/transactions
  • crud/update-many
  • crud/update-many/arrays
  • crud/update-many/fields
  • crud/update-one
  • crud/update-one/arrays
  • crud/update-one/fields
  • data-formats/bson
  • data-formats/custom-types/class-mapping
  • data-formats/custom-types/poco
  • data-formats/custom-types/polymorphic-objects
  • data-formats/custom-types/serialization
  • data-formats/guids
  • data-formats/time-series
  • databases-collections
  • indexes
  • integrations/odata
  • logging-and-monitoring/change-streams
  • logging-and-monitoring/logging
  • logging-and-monitoring/monitoring
  • reference/compatibility
  • reference/previous-versions
  • reference/quick-reference
  • reference/release-notes
  • reference/upgrade
  • reference/upgrade/v2
  • reference/upgrade/v3
  • run-command
  • security/authentication
  • security/authentication/aws-iam
  • security/authentication/kerberos
  • security/authentication/ldap
  • security/authentication/oidc
  • security/authentication/scram
  • security/authentication/x509
  • security/in-use-encryption
  • security/tls-ssl
  • 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 Apr 3, 2025

    Deploy Preview for docs-csharp ready!

    Name Link
    🔨 Latest commit 862f417
    🔍 Latest deploy log https://app.netlify.com/sites/docs-csharp/deploys/67f3f5d9796fae0008d9a9a9
    😎 Deploy Preview https://deploy-preview-556--docs-csharp.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.

    Copy link
    Collaborator

    @mcmorisi mcmorisi left a comment

    Choose a reason for hiding this comment

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

    Just a couple of questions!

    Comment on lines -2 to -12
    "/fundamentals/connection",
    "/fundamentals/crud",
    "/usage-examples",
    "/fundamentals",
    "/fundamentals/serialization",
    "/fundamentals/crud/write-operations/update-one",
    "/fundamentals/crud/write-operations/update-many",
    "/fundamentals/authentication",
    "/upgrade",
    "/fundamentals/database-collection",
    "/get-started"
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    I noticed that some pages here that are landing pages in Pymongo (like Databases and Collections) have been removed as landing pages here. The Databases and Collections page still exists and can be accessed through the URL but not the sidebar. Is that intended and would be fixed when working on the Databases and Collections ticket?

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    good catch. databases and collections definitely should be viewable; it wasn't because it still had Run a Database Command under it. that page should be (and is now) its own L1.

    In PyMongo, many of the L1/landing pages are there only to show usage examples. We're going to be moving the examples to the content pages as part of Comp Coverage, so my thinking was that we could make L1s viewable only if needed (i.e., if they have content other than usage examples to show). Does that work?

    @@ -18,7 +19,7 @@ Databases and Collections
    :class: singlecol

    .. toctree::
    /fundamentals/databases-collections/run-command
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Run a Database command now appears in the sidebar as well as under the Databases and Collections L1. Is that intended?

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    Nope! Fixed.

    @mongoKart mongoKart requested a review from mcmorisi April 7, 2025 15:57
    Copy link
    Collaborator

    @mcmorisi mcmorisi left a comment

    Choose a reason for hiding this comment

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

    LGTM!

    @mongoKart mongoKart merged commit d982c05 into mongodb:toc-reorg Apr 7, 2025
    5 of 6 checks passed
    @mongoKart mongoKart deleted the docsp-48812-match-pymongo branch April 7, 2025 16:10
    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.

    2 participants