Skip to content

DOCSP-47058: Shift TOC #251

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

Merged
merged 8 commits into from
May 21, 2025
Merged

Conversation

norareidy
Copy link
Collaborator

@norareidy norareidy commented May 20, 2025

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

  • crud
  • crud/query
  • issues-and-help
  • monitoring-logging
  • references
  • aggregation
  • connect
  • connect/connection-options
  • data-formats
  • data-formats/custom-types
  • databases-collections
  • get-started
  • index
  • reference/method/MongoDBClient-getCollection
  • reference/method/MongoDBClient-selectCollection
  • reference/method/MongoDBCollection-bulkWrite
  • reference/method/MongoDBCollection__construct
  • reference/method/MongoDBDatabase-getCollection
  • reference/method/MongoDBDatabase-selectCollection
  • reference/method/MongoDBDatabase-selectGridFSBucket
  • reference/method/MongoDBGridFSBucket__construct
  • security
  • atlas-search
  • connect/aws-lambda
  • connect/connection-options/stable-api
  • crud/builders
  • crud/bulk-write
  • crud/delete
  • crud/gridfs
  • crud/insert
  • crud/query/count
  • crud/query/cursor
  • crud/query/distinct
  • crud/query/project
  • crud/query/retrieve
  • crud/query/specify-a-query
  • crud/query/specify-documents-to-return
  • crud/read-write-pref
  • crud/replace
  • crud/transaction
  • crud/update
  • data-formats/custom-types/codecs
  • data-formats/time-series
  • monitoring-logging/change-streams
  • monitoring-logging/cluster-monitoring
  • references/compatibility
  • references/release-notes
  • references/upgrade
  • security/tls
  • vector-search
  • 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?
    • Are the page titles greater than 20 characters long and SEO relevant?
    • Did you add redirects?

    Copy link

    netlify bot commented May 20, 2025

    Deploy Preview for docs-php-library ready!

    Name Link
    🔨 Latest commit 6b0af60
    🔍 Latest deploy log https://app.netlify.com/projects/docs-php-library/deploys/682e072a4c85850008250557
    😎 Deploy Preview https://deploy-preview-251--docs-php-library.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 project configuration.

    Copy link
    Collaborator

    @rustagir rustagir left a comment

    Choose a reason for hiding this comment

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

    looks super clean but requesting changes just to be able to have another look before you merge!

    config/redirects Outdated

    # comprehensive coverage redirects
    [v2.x-*]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Q: are we going to backport the TOC changes as we've done with the other languages? in that case, should you redirect all versions?

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    If that's what we've done for the others then yes I'll backport to all for PHP too, fixed!

    config/redirects Outdated
    Comment on lines 94 to 95
    [v2.x-*]: ${prefix}/${version}/write/ -> ${base}/${version}/
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: consider redirecting these to the CRUD landing page instead

    config/redirects Outdated
    [v2.x-*]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/
    [v2.x-*]: ${prefix}/${version}/aggregation/vector-search/ -> ${base}/${version}/vector-search/
    [v2.x-*]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: consider redirecting to the monitoring-logging.txt landing page

    source/crud.txt Outdated
    Operations with Builders </crud/builders>

    CRUD (Create, Read, Update, Delete) operations enable you to work with
    data stored in MongoDB.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: add a sentence introducing the list

    • "Visit the following guides to learn more about performing CRUD operations on the data in your MongoDB collections... etc"

    @@ -68,7 +68,7 @@ specify the write operations:
    .. tip::

    For more information about delete, insert, replace, and update
    operations, see the :ref:`Write operation guides <php-write>`.
    operations, see the :ref:`CRUD <php-crud-operations>` section.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    operations, see the :ref:`CRUD <php-crud-operations>` section.
    operations, see the :ref:`php-crud-operations` guides.

    Comment on lines 347 to 348
    - Learn how to perform read and write operations in the :ref:`<php-crud-operations>` section.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: nit - dont need <> brackets when importing the ref title directly

    Suggested change
    - Learn how to configure your MongoDB connection in the :ref:`<php-connect>` section.
    - Learn how to perform read and write operations in the :ref:`<php-crud-operations>` section.
    - Learn how to configure your MongoDB connection in the :ref:`php-connect` section.
    - Learn how to perform read and write operations in the :ref:`php-crud-operations` section.


    .. meta::
    :keywords: php, troubleshooting, feedback
    :description: Find support for the {+library-short+, report bugs or feature requests, and learn how to contribute.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    :description: Find support for the {+library-short+, report bugs or feature requests, and learn how to contribute.
    :description: Find support for the PHP library, report bugs or feature requests, and learn how to contribute.


    .. note::

    Bug reports in the PHP Jira project are publicly viewable.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    Bug reports in the PHP Jira project are publicly viewable.
    Bug reports in the PHPLIB Jira project are publicly viewable.

    @norareidy norareidy requested a review from rustagir May 21, 2025 14:59
    Copy link
    Collaborator

    @rustagir rustagir left a comment

    Choose a reason for hiding this comment

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

    lgtm!

    @@ -21,14 +21,12 @@ toc_landing_pages = [
    "/reference/class/MongoDBModelDatabaseInfo",
    "/reference/class/MongoDBModelIndexInfo",
    "/connect",
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: add /connect/connection-options/

    source/index.txt Outdated
    Atlas Vector Search
    -------------------

    Learn how to run Atlas Vector Search queries in the :ref:`<php-vector-search>` section.

    Optimize Queries with Indexes
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: this item is out of order

    Release Notes </references/release-notes>
    Compatibility </references/compatibility>
    Upgrade Guides </references/upgrade>

    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: add short sentence introducing sub pages

    @norareidy norareidy merged commit c5f7fd8 into mongodb:comp-cov May 21, 2025
    7 checks passed
    @norareidy norareidy deleted the DOCSP-47058-toc branch May 21, 2025 17:33
    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