Skip to content

DOCSP-47777: Rework get started #619

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 12 commits into from
Mar 3, 2025

Conversation

norareidy
Copy link
Contributor

@norareidy norareidy commented Feb 20, 2025

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

  • get-started
  • get-started/connect-to-mongodb
  • get-started/connection-string
  • get-started/create-deployment
  • get-started/download-and-install
  • get-started/next-steps
  • index
  • usage-examples
  • get-started/databases-collections
  • get-started/integrations
  • 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?

    @norareidy norareidy requested a review from a team as a code owner February 20, 2025 18:50
    @norareidy norareidy requested review from vbabanin and removed request for a team February 20, 2025 18:50
    Copy link

    netlify bot commented Feb 20, 2025

    Deploy Preview for docs-java ready!

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

    @norareidy norareidy removed the request for review from vbabanin February 20, 2025 18:51
    Copy link
    Contributor

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

    Just a few changes (some of this is because I need to share broader context - I'll try to give you guys all the info at the kickoff):

    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Can you move this to the get-started folder? I would include it after the Next Steps page. I realize it's a bit awkward, but during the TOC conversations we decided that this page is introductory material.

    For reference, this is the new TOC structure we're going to follow.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Ah I see, I'll add back

    .. contents:: On this page
    :local:
    :backlinks: none
    :depth: 2
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    We probably don't need the page TOC here.


    .. tip::

    MongoDB Atlas is a fully managed cloud database service that hosts your MongoDB
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Suggested change
    MongoDB Atlas is a fully managed cloud database service that hosts your MongoDB
    :atlas:`MongoDB Atlas </getting-started/>` is a fully managed cloud database service that hosts your MongoDB

    Comment on lines 43 to 45
    Follow this guide to connect a sample Java application to a MongoDB Atlas
    deployment. If you prefer to connect to MongoDB using a different driver or
    programming language, see our :driver:`list of official drivers <>`.
    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 we should add a section TOC here:

    Suggested change
    Follow this guide to connect a sample Java application to a MongoDB Atlas
    deployment. If you prefer to connect to MongoDB using a different driver or
    programming language, see our :driver:`list of official drivers <>`.
    Follow this guide to connect a sample Java application to a MongoDB Atlas
    deployment.
    <Section TOC>
    If you prefer to connect to MongoDB using a different driver or
    programming language, see our :driver:`list of official drivers <>`.

    Comment on lines 15 to 16
    - Learn how to perform read operations in the :ref:`<java-read-operations>` section.
    - Learn how to perform write operations in the :ref:`<java-write-operations>` section.
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    To try to make the Database and Collections page make more sense.

    Suggested change
    - Learn how to perform read operations in the :ref:`<java-read-operations>` section.
    - Learn how to perform write operations in the :ref:`<java-write-operations>` section.
    - Learn how to perform read operations in the :ref:`<java-read-operations>` section.
    - Learn how to perform write operations in the :ref:`<java-write-operations>` section.
    - Learn more about Databases and Collections in the <page reference> section.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    I added to the paragraph before this list, just to separate it from the read/write landing pages

    Copy link
    Contributor

    @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

    @norareidy norareidy requested review from a team and stIncMale and removed request for a team February 21, 2025 14:48
    Copy link
    Member

    @stIncMale stIncMale left a comment

    Choose a reason for hiding this comment

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

    There is one optional suggestion


    Complete the :atlas:`Get Started with Atlas </getting-started?tck=docs_driver_java>`
    guide to set up a new Atlas account and a free tier MongoDB deployment.
    Ensure that you **load sample data** and **add your IP address** to the IP access
    Copy link
    Member

    Choose a reason for hiding this comment

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

    [optional]

    Let's make those bold instructions into links to https://www.mongodb.com/docs/atlas/sample-data/ and https://www.mongodb.com/docs/atlas/security/add-ip-address-to-list/ respectively?

    @norareidy norareidy merged commit 17f01d8 into mongodb:master Mar 3, 2025
    5 of 6 checks passed
    @norareidy norareidy deleted the DOCSP-47777-get-started-reorg branch March 3, 2025 18:22
    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.

    3 participants