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-48687 - Standardize API Source Constants #666

Merged
merged 3 commits into from
Mar 27, 2025

Conversation

mongoKart
Copy link
Contributor

@mongoKart mongoKart commented Mar 26, 2025

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

  • aggregation
  • aggregation/aggregation-examples
  • aggregation/aggregation-expression-operations
  • api-documentation
  • atlas-search
  • atlas-vector-search
  • builders/aggregates
  • builders/filters
  • builders/indexes
  • builders/projections
  • builders/sort
  • builders/updates
  • command
  • connection/mongoclient
  • connection/specify-connection-options/cluster-settings
  • connection/specify-connection-options/configure-crud
  • connection/specify-connection-options/connection-pools
  • connection/specify-connection-options/jndi
  • connection/specify-connection-options/network-compression
  • connection/specify-connection-options/server-settings
  • connection/specify-connection-options/socket-settings
  • connection/specify-connection-options/stable-api
  • crud/bulk
  • crud/collations
  • crud/compound-operations
  • crud/crud-settings
  • crud/delete
  • crud/gridfs
  • crud/insert
  • crud/query-documents/count
  • crud/query-documents/cursor
  • crud/query-documents/distinct
  • crud/query-documents/find
  • crud/query-documents/geo
  • crud/query-documents/limit
  • crud/query-documents/skip
  • crud/query-documents/sort
  • crud/query-documents/text
  • crud/replace-documents
  • crud/transactions
  • crud/update-documents
  • crud/update-documents/embedded-arrays
  • crud/update-documents/upsert
  • data-formats/codecs
  • data-formats/document-data-format-bson
  • data-formats/document-data-format-extended-json
  • data-formats/document-data-format-pojo
  • data-formats/document-data-format-record
  • data-formats/documents
  • data-formats/pojo-customization
  • data-formats/time-series
  • databases-collections
  • index
  • indexes
  • logging-monitoring/change-streams
  • logging-monitoring/logging
  • logging-monitoring/monitoring
  • references/legacy
  • references/upgrade
  • references/whats-new
  • security/auth/aws-iam
  • security/auth/kerberos
  • security/auth/ldap
  • security/auth/oidc
  • security/auth/scram
  • security/auth/x509
  • security/encrypt-fields
  • security/socks
  • security/tls
  • 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?
    • [I think so] Are all the links working?
    • Are the facets and meta keywords accurate?

    Copy link

    netlify bot commented Mar 26, 2025

    Deploy Preview for docs-java ready!

    Name Link
    🔨 Latest commit 2f7c29f
    🔍 Latest deploy log https://app.netlify.com/sites/docs-java/deploys/67e55b255ab992000879a126
    😎 Deploy Preview https://deploy-preview-666--docs-java.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.

    snooty.toml Outdated
    Comment on lines 33 to 35
    api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
    client-api = "{+api-root+}/mongodb-driver-sync/com/mongodb/client"
    core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    I think condensing these into just the following is sufficient.

    Suggested change
    api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
    client-api = "{+api-root+}/mongodb-driver-sync/com/mongodb/client"
    core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
    driver-api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-sync/com/mongodb"
    core-api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-core/com/mongodb"

    Copy link
    Contributor Author

    @mongoKart mongoKart Mar 27, 2025

    Choose a reason for hiding this comment

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

    renamed to driver-api. kept other pieces after discussion

    Copy link
    Contributor

    @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.

    The organization of the source constants lgtm thanks for the collaboration! Mainly checked to see if the API docs drawer was working as expected and selected a few random pages to test links.

    @mongoKart mongoKart merged commit 6f002e7 into mongodb:master Mar 27, 2025
    6 checks passed
    @mongoKart mongoKart deleted the docsp-48687-standardize-endpoints branch March 27, 2025 17:33
    github-actions bot pushed a commit that referenced this pull request Mar 27, 2025
    mongoKart added a commit that referenced this pull request Mar 27, 2025
    (cherry picked from commit 6f002e7)
    
    Co-authored-by: Mike Woofter <[email protected]>
    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.

    2 participants