-
Notifications
You must be signed in to change notification settings - Fork 43
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
DOCSP-47777: Rework get started #619
Conversation
✅ Deploy Preview for docs-java ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this 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):
source/databases-collections.txt
Outdated
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
source/get-started.txt
Outdated
.. contents:: On this page | ||
:local: | ||
:backlinks: none | ||
:depth: 2 |
There was a problem hiding this comment.
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.
source/get-started.txt
Outdated
|
||
.. tip:: | ||
|
||
MongoDB Atlas is a fully managed cloud database service that hosts your MongoDB |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
source/get-started.txt
Outdated
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 <>`. |
There was a problem hiding this comment.
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:
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 <>`. |
source/get-started/next-steps.txt
Outdated
- 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. |
There was a problem hiding this comment.
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.
- 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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this 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 |
There was a problem hiding this comment.
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?
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47777
Staging Links
Self-Review Checklist